You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by da...@apache.org on 2017/06/07 23:54:11 UTC
[01/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Repository: incubator-trafficcontrol-website
Updated Branches:
refs/heads/master 9c7fc09d4 -> 0ba7314b1
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/phys_location.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/phys_location.html b/docs/latest/development/traffic_ops_api/v12/phys_location.html
index 5e29b94..d6ea8de 100644
--- a/docs/latest/development/traffic_ops_api/v12/phys_location.html
+++ b/docs/latest/development/traffic_ops_api/v12/phys_location.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Physical Location — Traffic Control 1.8.1 documentation </title>
+ <title>Physical Location — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Profiles" href="profile.html"/>
<link rel="prev" title="Parameter" href="parameter.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Physical Location</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/phys_location.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/phys_location.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -270,39 +267,39 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -337,13 +334,13 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -450,23 +447,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -562,18 +559,18 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"regionId"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -656,29 +653,29 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Physical location update was successful."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Physical location update was successful."</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -771,14 +768,14 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span> <span class="p">:</span> <span class="s2">"my physical location1"</span><span class="p">,</span>
- <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
- <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"my physical location1"</span><span class="p">,</span>
+ <span class="s">"shortName"</span> <span class="p">:</span> <span class="s">"myphylocation1"</span><span class="p">,</span>
+ <span class="s">"address"</span> <span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"city"</span> <span class="p">:</span> <span class="s">"Shanghai"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"SH"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"200000"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"this is physical location1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -857,23 +854,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
- <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
- <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
- <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
- <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
- <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
- <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
- <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
- <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
- <span class="p">}</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre> {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+}
</pre></div>
</div>
</div></blockquote>
@@ -921,7 +918,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[51/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
1.8.0 is latest release
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/0ba7314b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/0ba7314b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/0ba7314b
Branch: refs/heads/master
Commit: 0ba7314b172d8441867e7af1e257e8c3b5ed65dd
Parents: 9c7fc09
Author: Dan Kirkwood <da...@gmail.com>
Authored: Wed Jun 7 17:53:41 2017 -0600
Committer: Dan Kirkwood <da...@gmail.com>
Committed: Wed Jun 7 17:53:41 2017 -0600
----------------------------------------------------------------------
docs/latest/.buildinfo | 4 -
docs/latest/_sources/admin/index.rst.txt | 48 -
docs/latest/_sources/admin/index.txt | 48 +
.../_sources/admin/quick_howto/dnssec.rst.txt | 72 -
.../_sources/admin/quick_howto/dnssec.txt | 72 +
.../admin/quick_howto/federations.rst.txt | 135 -
.../_sources/admin/quick_howto/federations.txt | 135 +
.../_sources/admin/quick_howto/index.rst.txt | 28 -
.../latest/_sources/admin/quick_howto/index.txt | 28 +
.../admin/quick_howto/multi_site.rst.txt | 95 -
.../_sources/admin/quick_howto/multi_site.txt | 95 +
.../admin/quick_howto/regionalgeo.rst.txt | 109 -
.../_sources/admin/quick_howto/regionalgeo.txt | 109 +
.../_sources/admin/quick_howto/steering.rst.txt | 95 -
.../_sources/admin/quick_howto/steering.txt | 95 +
.../_sources/admin/traffic_monitor.rst.txt | 142 -
docs/latest/_sources/admin/traffic_monitor.txt | 142 +
.../_sources/admin/traffic_ops_config.rst.txt | 186 -
.../_sources/admin/traffic_ops_config.txt | 186 +
.../admin/traffic_ops_extensions.rst.txt | 88 -
.../_sources/admin/traffic_ops_extensions.txt | 88 +
.../_sources/admin/traffic_ops_install.rst.txt | 381 -
.../_sources/admin/traffic_ops_install.txt | 381 +
.../_sources/admin/traffic_ops_using.rst.txt | 1060 --
.../latest/_sources/admin/traffic_ops_using.txt | 1060 ++
.../_sources/admin/traffic_portal.rst.txt | 53 -
docs/latest/_sources/admin/traffic_portal.txt | 53 +
.../_sources/admin/traffic_router.rst.txt | 494 -
docs/latest/_sources/admin/traffic_router.txt | 494 +
.../_sources/admin/traffic_server.rst.txt | 71 -
docs/latest/_sources/admin/traffic_server.txt | 71 +
.../latest/_sources/admin/traffic_stats.rst.txt | 187 -
docs/latest/_sources/admin/traffic_stats.txt | 187 +
.../latest/_sources/admin/traffic_vault.rst.txt | 195 -
docs/latest/_sources/admin/traffic_vault.txt | 195 +
.../_sources/basics/cache_revalidation.rst.txt | 71 -
.../_sources/basics/cache_revalidation.txt | 71 +
.../_sources/basics/caching_proxies.rst.txt | 238 -
docs/latest/_sources/basics/caching_proxies.txt | 238 +
.../basics/content_delivery_networks.rst.txt | 40 -
.../basics/content_delivery_networks.txt | 40 +
docs/latest/_sources/basics/http_11.rst.txt | 48 -
docs/latest/_sources/basics/http_11.txt | 48 +
docs/latest/_sources/basics/index.rst.txt | 29 -
docs/latest/_sources/basics/index.txt | 29 +
docs/latest/_sources/development/index.rst.txt | 29 -
docs/latest/_sources/development/index.txt | 29 +
.../development/traffic_monitor.rst.txt | 112 -
.../_sources/development/traffic_monitor.txt | 112 +
.../traffic_monitor/traffic_monitor_api.rst.txt | 178 -
.../traffic_monitor/traffic_monitor_api.txt | 178 +
.../_sources/development/traffic_ops.rst.txt | 630 -
.../latest/_sources/development/traffic_ops.txt | 630 +
.../development/traffic_ops_api/routes.rst.txt | 116 -
.../development/traffic_ops_api/routes.txt | 116 +
.../development/traffic_ops_api/v11/asn.rst.txt | 69 -
.../development/traffic_ops_api/v11/asn.txt | 69 +
.../traffic_ops_api/v11/cachegroup.rst.txt | 317 -
.../traffic_ops_api/v11/cachegroup.txt | 317 +
.../development/traffic_ops_api/v11/cdn.rst.txt | 1086 --
.../development/traffic_ops_api/v11/cdn.txt | 1086 ++
.../traffic_ops_api/v11/changelog.rst.txt | 154 -
.../traffic_ops_api/v11/changelog.txt | 154 +
.../traffic_ops_api/v11/deliveryservice.rst.txt | 1276 --
.../traffic_ops_api/v11/deliveryservice.txt | 1276 ++
.../traffic_ops_api/v11/hwinfo.rst.txt | 67 -
.../development/traffic_ops_api/v11/hwinfo.txt | 67 +
.../traffic_ops_api/v11/parameter.rst.txt | 136 -
.../traffic_ops_api/v11/parameter.txt | 136 +
.../traffic_ops_api/v11/phys_location.rst.txt | 449 -
.../traffic_ops_api/v11/phys_location.txt | 449 +
.../traffic_ops_api/v11/profile.rst.txt | 129 -
.../development/traffic_ops_api/v11/profile.txt | 129 +
.../traffic_ops_api/v11/region.rst.txt | 235 -
.../development/traffic_ops_api/v11/region.txt | 235 +
.../traffic_ops_api/v11/role.rst.txt | 58 -
.../development/traffic_ops_api/v11/role.txt | 58 +
.../traffic_ops_api/v11/server.rst.txt | 630 -
.../development/traffic_ops_api/v11/server.txt | 630 +
.../traffic_ops_api/v11/static_dns.rst.txt | 63 -
.../traffic_ops_api/v11/static_dns.txt | 63 +
.../traffic_ops_api/v11/status.rst.txt | 127 -
.../development/traffic_ops_api/v11/status.txt | 127 +
.../traffic_ops_api/v11/system.rst.txt | 79 -
.../development/traffic_ops_api/v11/system.txt | 79 +
.../traffic_ops_api/v11/to_extension.rst.txt | 210 -
.../traffic_ops_api/v11/to_extension.txt | 210 +
.../traffic_ops_api/v11/type.rst.txt | 151 -
.../development/traffic_ops_api/v11/type.txt | 151 +
.../traffic_ops_api/v11/user.rst.txt | 778 --
.../development/traffic_ops_api/v11/user.txt | 778 ++
.../development/traffic_ops_api/v12/asn.rst.txt | 192 -
.../development/traffic_ops_api/v12/asn.txt | 192 +
.../traffic_ops_api/v12/cache_stats.rst.txt | 134 -
.../traffic_ops_api/v12/cache_stats.txt | 134 +
.../traffic_ops_api/v12/cachegroup.rst.txt | 696 --
.../traffic_ops_api/v12/cachegroup.txt | 696 ++
.../development/traffic_ops_api/v12/cdn.rst.txt | 1334 ---
.../development/traffic_ops_api/v12/cdn.txt | 1334 +++
.../traffic_ops_api/v12/changelog.rst.txt | 154 -
.../traffic_ops_api/v12/changelog.txt | 154 +
.../traffic_ops_api/v12/deliveryservice.rst.txt | 1756 ---
.../traffic_ops_api/v12/deliveryservice.txt | 1756 +++
.../v12/deliveryservice_stats.rst.txt | 155 -
.../v12/deliveryservice_stats.txt | 155 +
.../traffic_ops_api/v12/division.rst.txt | 202 -
.../traffic_ops_api/v12/division.txt | 202 +
.../traffic_ops_api/v12/federation.rst.txt | 151 -
.../traffic_ops_api/v12/federation.txt | 151 +
.../traffic_ops_api/v12/hwinfo.rst.txt | 68 -
.../development/traffic_ops_api/v12/hwinfo.txt | 68 +
.../traffic_ops_api/v12/influxdb.rst.txt | 65 -
.../traffic_ops_api/v12/influxdb.txt | 65 +
.../traffic_ops_api/v12/parameter.rst.txt | 516 -
.../traffic_ops_api/v12/parameter.txt | 516 +
.../traffic_ops_api/v12/phys_location.rst.txt | 448 -
.../traffic_ops_api/v12/phys_location.txt | 448 +
.../traffic_ops_api/v12/profile.rst.txt | 357 -
.../development/traffic_ops_api/v12/profile.txt | 357 +
.../v12/profile_parameter.rst.txt | 457 -
.../traffic_ops_api/v12/profile_parameter.txt | 457 +
.../traffic_ops_api/v12/region.rst.txt | 235 -
.../development/traffic_ops_api/v12/region.txt | 235 +
.../traffic_ops_api/v12/role.rst.txt | 59 -
.../development/traffic_ops_api/v12/role.txt | 59 +
.../traffic_ops_api/v12/server.rst.txt | 1125 --
.../development/traffic_ops_api/v12/server.txt | 1125 ++
.../traffic_ops_api/v12/static_dns.rst.txt | 66 -
.../traffic_ops_api/v12/static_dns.txt | 66 +
.../traffic_ops_api/v12/status.rst.txt | 127 -
.../development/traffic_ops_api/v12/status.txt | 127 +
.../traffic_ops_api/v12/system.rst.txt | 80 -
.../development/traffic_ops_api/v12/system.txt | 80 +
.../traffic_ops_api/v12/to_extension.rst.txt | 206 -
.../traffic_ops_api/v12/to_extension.txt | 206 +
.../traffic_ops_api/v12/topology.rst.txt | 54 -
.../traffic_ops_api/v12/topology.txt | 54 +
.../traffic_ops_api/v12/type.rst.txt | 151 -
.../development/traffic_ops_api/v12/type.txt | 151 +
.../traffic_ops_api/v12/user.rst.txt | 784 --
.../development/traffic_ops_api/v12/user.txt | 784 ++
.../_sources/development/traffic_portal.rst.txt | 54 -
.../_sources/development/traffic_portal.txt | 54 +
.../_sources/development/traffic_router.rst.txt | 143 -
.../_sources/development/traffic_router.txt | 143 +
.../traffic_router/traffic_router_api.rst.txt | 48 -
.../traffic_router/traffic_router_api.txt | 48 +
.../_sources/development/traffic_server.rst.txt | 19 -
.../_sources/development/traffic_server.txt | 19 +
.../_sources/development/traffic_stats.rst.txt | 58 -
.../_sources/development/traffic_stats.txt | 58 +
docs/latest/_sources/faq/administration.rst.txt | 66 -
docs/latest/_sources/faq/administration.txt | 66 +
docs/latest/_sources/faq/development.rst.txt | 21 -
docs/latest/_sources/faq/development.txt | 21 +
docs/latest/_sources/faq/general.rst.txt | 52 -
docs/latest/_sources/faq/general.txt | 52 +
docs/latest/_sources/faq/index.rst.txt | 26 -
docs/latest/_sources/faq/index.txt | 26 +
docs/latest/_sources/glossary.rst.txt | 81 -
docs/latest/_sources/glossary.txt | 66 +
docs/latest/_sources/index.rst.txt | 80 -
docs/latest/_sources/index.txt | 80 +
docs/latest/_sources/overview/index.rst.txt | 30 -
docs/latest/_sources/overview/index.txt | 30 +
.../_sources/overview/introduction.rst.txt | 28 -
docs/latest/_sources/overview/introduction.txt | 28 +
.../_sources/overview/traffic_monitor.rst.txt | 66 -
.../_sources/overview/traffic_monitor.txt | 66 +
.../_sources/overview/traffic_ops.rst.txt | 39 -
docs/latest/_sources/overview/traffic_ops.txt | 39 +
.../_sources/overview/traffic_portal.rst.txt | 43 -
.../latest/_sources/overview/traffic_portal.txt | 43 +
.../_sources/overview/traffic_router.rst.txt | 108 -
.../latest/_sources/overview/traffic_router.txt | 108 +
.../_sources/overview/traffic_server.rst.txt | 49 -
.../latest/_sources/overview/traffic_server.txt | 49 +
.../_sources/overview/traffic_stats.rst.txt | 35 -
docs/latest/_sources/overview/traffic_stats.txt | 35 +
.../_sources/overview/traffic_vault.rst.txt | 36 -
docs/latest/_sources/overview/traffic_vault.txt | 36 +
docs/latest/_static/basic.css | 79 +-
docs/latest/_static/comment-bright.png | Bin 756 -> 3500 bytes
docs/latest/_static/comment-close.png | Bin 829 -> 3578 bytes
docs/latest/_static/comment.png | Bin 641 -> 3445 bytes
docs/latest/_static/doctools.js | 28 +-
docs/latest/_static/down-pressed.png | Bin 222 -> 347 bytes
docs/latest/_static/down.png | Bin 202 -> 347 bytes
docs/latest/_static/file.png | Bin 286 -> 358 bytes
.../_static/fonts/fontawesome-webfont.svg | 414 +
docs/latest/_static/jquery-1.11.1.js | 10308 +++++++++++++++++
docs/latest/_static/jquery-3.1.0.js | 10074 ----------------
docs/latest/_static/jquery.js | 8 +-
docs/latest/_static/minus.png | Bin 90 -> 173 bytes
docs/latest/_static/plus.png | Bin 90 -> 173 bytes
docs/latest/_static/pygments.css | 2 -
docs/latest/_static/searchtools.js | 166 +-
docs/latest/_static/up-pressed.png | Bin 214 -> 345 bytes
docs/latest/_static/up.png | Bin 203 -> 345 bytes
docs/latest/_static/websupport.js | 4 +-
docs/latest/admin/index.html | 15 +-
docs/latest/admin/quick_howto/dnssec.html | 21 +-
docs/latest/admin/quick_howto/federations.html | 27 +-
docs/latest/admin/quick_howto/index.html | 15 +-
docs/latest/admin/quick_howto/multi_site.html | 29 +-
docs/latest/admin/quick_howto/regionalgeo.html | 63 +-
docs/latest/admin/quick_howto/steering.html | 51 +-
docs/latest/admin/traffic_monitor.html | 31 +-
docs/latest/admin/traffic_ops_config.html | 33 +-
docs/latest/admin/traffic_ops_extensions.html | 81 +-
docs/latest/admin/traffic_ops_install.html | 191 +-
docs/latest/admin/traffic_ops_using.html | 139 +-
docs/latest/admin/traffic_portal.html | 15 +-
docs/latest/admin/traffic_router.html | 31 +-
docs/latest/admin/traffic_server.html | 21 +-
docs/latest/admin/traffic_stats.html | 38 +-
docs/latest/admin/traffic_vault.html | 51 +-
docs/latest/basics/cache_revalidation.html | 83 +-
docs/latest/basics/caching_proxies.html | 185 +-
.../basics/content_delivery_networks.html | 32 +-
docs/latest/basics/http_11.html | 27 +-
docs/latest/basics/index.html | 15 +-
docs/latest/development/index.html | 15 +-
docs/latest/development/traffic_monitor.html | 17 +-
.../traffic_monitor/traffic_monitor_api.html | 13 +-
docs/latest/development/traffic_ops.html | 51 +-
.../development/traffic_ops_api/routes.html | 105 +-
.../development/traffic_ops_api/v11/asn.html | 35 +-
.../traffic_ops_api/v11/cachegroup.html | 163 +-
.../development/traffic_ops_api/v11/cdn.html | 323 +-
.../traffic_ops_api/v11/changelog.html | 75 +-
.../traffic_ops_api/v11/deliveryservice.html | 579 +-
.../development/traffic_ops_api/v11/hwinfo.html | 33 +-
.../traffic_ops_api/v11/parameter.html | 81 +-
.../traffic_ops_api/v11/phys_location.html | 225 +-
.../traffic_ops_api/v11/profile.html | 43 +-
.../development/traffic_ops_api/v11/region.html | 87 +-
.../development/traffic_ops_api/v11/role.html | 25 +-
.../development/traffic_ops_api/v11/server.html | 483 +-
.../traffic_ops_api/v11/static_dns.html | 37 +-
.../development/traffic_ops_api/v11/status.html | 101 +-
.../development/traffic_ops_api/v11/system.html | 37 +-
.../traffic_ops_api/v11/to_extension.html | 107 +-
.../development/traffic_ops_api/v11/type.html | 53 +-
.../development/traffic_ops_api/v11/user.html | 293 +-
.../development/traffic_ops_api/v12/asn.html | 77 +-
.../traffic_ops_api/v12/cache_stats.html | 61 +-
.../traffic_ops_api/v12/cachegroup.html | 317 +-
.../development/traffic_ops_api/v12/cdn.html | 427 +-
.../traffic_ops_api/v12/changelog.html | 75 +-
.../traffic_ops_api/v12/deliveryservice.html | 947 +-
.../v12/deliveryservice_stats.html | 73 +-
.../traffic_ops_api/v12/division.html | 91 +-
.../traffic_ops_api/v12/federation.html | 67 +-
.../development/traffic_ops_api/v12/hwinfo.html | 33 +-
.../traffic_ops_api/v12/influxdb.html | 49 +-
.../traffic_ops_api/v12/parameter.html | 225 +-
.../traffic_ops_api/v12/phys_location.html | 225 +-
.../traffic_ops_api/v12/profile.html | 109 +-
.../traffic_ops_api/v12/profile_parameter.html | 263 +-
.../development/traffic_ops_api/v12/region.html | 87 +-
.../development/traffic_ops_api/v12/role.html | 25 +-
.../development/traffic_ops_api/v12/server.html | 687 +-
.../traffic_ops_api/v12/static_dns.html | 37 +-
.../development/traffic_ops_api/v12/status.html | 101 +-
.../development/traffic_ops_api/v12/system.html | 37 +-
.../traffic_ops_api/v12/to_extension.html | 107 +-
.../traffic_ops_api/v12/topology.html | 17 +-
.../development/traffic_ops_api/v12/type.html | 53 +-
.../development/traffic_ops_api/v12/user.html | 293 +-
docs/latest/development/traffic_portal.html | 15 +-
docs/latest/development/traffic_router.html | 17 +-
.../traffic_router/traffic_router_api.html | 13 +-
docs/latest/development/traffic_server.html | 15 +-
docs/latest/development/traffic_stats.html | 15 +-
docs/latest/faq/administration.html | 56 +-
docs/latest/faq/development.html | 15 +-
docs/latest/faq/general.html | 15 +-
docs/latest/faq/index.html | 15 +-
docs/latest/genindex.html | 483 +-
docs/latest/glossary.html | 53 +-
docs/latest/index.html | 13 +-
docs/latest/objects.inv | Bin 3713 -> 2636 bytes
docs/latest/overview/index.html | 15 +-
docs/latest/overview/introduction.html | 15 +-
docs/latest/overview/traffic_monitor.html | 15 +-
docs/latest/overview/traffic_ops.html | 15 +-
docs/latest/overview/traffic_portal.html | 15 +-
docs/latest/overview/traffic_router.html | 29 +-
docs/latest/overview/traffic_server.html | 17 +-
docs/latest/overview/traffic_stats.html | 15 +-
docs/latest/overview/traffic_vault.html | 26 +-
docs/latest/search.html | 11 +-
docs/latest/searchindex.js | 2 +-
294 files changed, 37063 insertions(+), 36763 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/.buildinfo
----------------------------------------------------------------------
diff --git a/docs/latest/.buildinfo b/docs/latest/.buildinfo
deleted file mode 100644
index d80d85a..0000000
--- a/docs/latest/.buildinfo
+++ /dev/null
@@ -1,4 +0,0 @@
-# Sphinx build info version 1
-# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: ca8576454f95ff0477038bbbe38dc7fb
-tags: 645f666f9bcd5a90fca523b33c5a78b7
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/index.rst.txt b/docs/latest/_sources/admin/index.rst.txt
deleted file mode 100644
index e92f5e2..0000000
--- a/docs/latest/_sources/admin/index.rst.txt
+++ /dev/null
@@ -1,48 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Administrator's Guide
-*********************
-
-Traffic Control is distributed in source form for the developer, but also as a binary package. This guide details how to install and configure a Traffic Control CDN using the binary packages, as well as how to perform common operations running a CDN.
-
-When installing a complete CDN from scratch, a sample recommended order is:
-
-1. Traffic Ops
-2. Traffic Vault (Riak)
-3. Apache Traffic Server Mid-Tier Caches
-4. Apache Traffic Server Edge Caches
-5. Traffic Monitor
-6. Traffic Router
-7. Traffic Stats
-8. Traffic Portal
-
-Once everything is installed, you will need to configure the servers to talk to each other. You will also need Origin server(s), which the Mid-Tier Cache(s) get content from. An Origin server is simply an HTTP(S) server which serves the content you wish to cache on the CDN.
-
-.. toctree::
- :maxdepth: 3
-
- traffic_ops_install.rst
- traffic_ops_config.rst
- traffic_ops_using.rst
- traffic_ops_extensions.rst
- traffic_portal.rst
- traffic_monitor.rst
- traffic_router.rst
- traffic_stats.rst
- traffic_server.rst
- traffic_vault.rst
- quick_howto/index.rst
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/index.txt b/docs/latest/_sources/admin/index.txt
new file mode 100644
index 0000000..e92f5e2
--- /dev/null
+++ b/docs/latest/_sources/admin/index.txt
@@ -0,0 +1,48 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Administrator's Guide
+*********************
+
+Traffic Control is distributed in source form for the developer, but also as a binary package. This guide details how to install and configure a Traffic Control CDN using the binary packages, as well as how to perform common operations running a CDN.
+
+When installing a complete CDN from scratch, a sample recommended order is:
+
+1. Traffic Ops
+2. Traffic Vault (Riak)
+3. Apache Traffic Server Mid-Tier Caches
+4. Apache Traffic Server Edge Caches
+5. Traffic Monitor
+6. Traffic Router
+7. Traffic Stats
+8. Traffic Portal
+
+Once everything is installed, you will need to configure the servers to talk to each other. You will also need Origin server(s), which the Mid-Tier Cache(s) get content from. An Origin server is simply an HTTP(S) server which serves the content you wish to cache on the CDN.
+
+.. toctree::
+ :maxdepth: 3
+
+ traffic_ops_install.rst
+ traffic_ops_config.rst
+ traffic_ops_using.rst
+ traffic_ops_extensions.rst
+ traffic_portal.rst
+ traffic_monitor.rst
+ traffic_router.rst
+ traffic_stats.rst
+ traffic_server.rst
+ traffic_vault.rst
+ quick_howto/index.rst
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/dnssec.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/dnssec.rst.txt b/docs/latest/_sources/admin/quick_howto/dnssec.rst.txt
deleted file mode 100644
index d336057..0000000
--- a/docs/latest/_sources/admin/quick_howto/dnssec.rst.txt
+++ /dev/null
@@ -1,72 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _rl-dnssec-qht:
-
-****************
-Configure DNSSEC
-****************
-
-.. Note:: In order for Traffic Ops to successfully store keys in Traffic Vault, at least one Riak Server needs to be configured in Traffic Ops. See the `Traffic Vault admin page <../traffic_vault.html>`_ for more information.
-
-.. Note:: Currently DNSSEC is only supported for DNS delivery services.
-
-1) Go to Tools->Manage DNSSEC Keys choose a CDN and click Manage DNSSEC Keys
-
-.. image:: dnssec01.png
- :scale: 100%
- :align: center
-
-2) Generate keys for a CDN by clicking Generate Keys then entering the following information:
-
- - Expiration in days for the Zone Signing Key (ZSK)
- - Expiration in days for the Key Signing Key (KSK)
- - Effective Date
-
- Once the required information has been entered click on the 'Generate Keys' button.
-
- Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.
-
-.. image:: dnssec02.png
- :scale: 100%
- :align: center
-
-3) In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN's domain (e.g. If the CDN's domain is 'cdn.kabletown.net' the parent zone is 'kabletown.net').
-
- If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.
-
-.. image:: dnssec03.png
- :scale: 70%
- :align: center
-
-4) Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.
-
- Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.
-
- This will add a 'dnssec.enabled = "true"' entry to CRConfig for the chosen CDN.
-
-.. image:: dnssec04.png
- :scale: 70%
- :align: center
-
-5) DNSSEC should now be active on your CDN and Traffic Router should be signing responses.
-
- A dig command with +dnssec added should show you the signed responses.
-
- ``dig edge.cdn.kabletown.net. +dnssec``
-
-6) When KSK expiration is approaching (default 365 days), it is necessary to manually generate a new KSK for the TLD (Top Level Domain) and add the DS Record to the parent zone. In order to avoid signing errors, it is suggested that an effective date is chosen which allows time for the DS Record to be added to the parent zone before the new KSK becomes active.
-
- A new KSK can be generated by clicking the 'Regenerate KSK' button on the Manage DNSSEC Keys screen (see screenshot above).
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/dnssec.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/dnssec.txt b/docs/latest/_sources/admin/quick_howto/dnssec.txt
new file mode 100644
index 0000000..d336057
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/dnssec.txt
@@ -0,0 +1,72 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _rl-dnssec-qht:
+
+****************
+Configure DNSSEC
+****************
+
+.. Note:: In order for Traffic Ops to successfully store keys in Traffic Vault, at least one Riak Server needs to be configured in Traffic Ops. See the `Traffic Vault admin page <../traffic_vault.html>`_ for more information.
+
+.. Note:: Currently DNSSEC is only supported for DNS delivery services.
+
+1) Go to Tools->Manage DNSSEC Keys choose a CDN and click Manage DNSSEC Keys
+
+.. image:: dnssec01.png
+ :scale: 100%
+ :align: center
+
+2) Generate keys for a CDN by clicking Generate Keys then entering the following information:
+
+ - Expiration in days for the Zone Signing Key (ZSK)
+ - Expiration in days for the Key Signing Key (KSK)
+ - Effective Date
+
+ Once the required information has been entered click on the 'Generate Keys' button.
+
+ Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.
+
+.. image:: dnssec02.png
+ :scale: 100%
+ :align: center
+
+3) In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN's domain (e.g. If the CDN's domain is 'cdn.kabletown.net' the parent zone is 'kabletown.net').
+
+ If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.
+
+.. image:: dnssec03.png
+ :scale: 70%
+ :align: center
+
+4) Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.
+
+ Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.
+
+ This will add a 'dnssec.enabled = "true"' entry to CRConfig for the chosen CDN.
+
+.. image:: dnssec04.png
+ :scale: 70%
+ :align: center
+
+5) DNSSEC should now be active on your CDN and Traffic Router should be signing responses.
+
+ A dig command with +dnssec added should show you the signed responses.
+
+ ``dig edge.cdn.kabletown.net. +dnssec``
+
+6) When KSK expiration is approaching (default 365 days), it is necessary to manually generate a new KSK for the TLD (Top Level Domain) and add the DS Record to the parent zone. In order to avoid signing errors, it is suggested that an effective date is chosen which allows time for the DS Record to be added to the parent zone before the new KSK becomes active.
+
+ A new KSK can be generated by clicking the 'Regenerate KSK' button on the Manage DNSSEC Keys screen (see screenshot above).
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/federations.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/federations.rst.txt b/docs/latest/_sources/admin/quick_howto/federations.rst.txt
deleted file mode 100644
index a17122c..0000000
--- a/docs/latest/_sources/admin/quick_howto/federations.rst.txt
+++ /dev/null
@@ -1,135 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _rl-federations-qht:
-
-*********************
-Configure Federations
-*********************
-
-1) Create a user with a federations role (Misc -> Users -> Add User). This user will have the ability to perform the following actions:
-
- - Edit the federation
- - Delete the federation
- - Add IPV4 resolvers
- - Add IPV6 resolvers
-
-.. image:: federation01.png
- :scale: 100%
- :align: center
-
-2) As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking 'Add Federation Mapping'
-
-3) Choose the Delivery Service for the federation to be mapped to and assign it to the Federation User; click Add.
-
-.. image:: federation02.png
- :scale: 100%
- :align: center
-
-4) After the Federation is added, Traffic Ops will display the Federation.
-
- Changes can be made at this time or the Federation can be deleted. Notice that no resolvers have been added to the fedeation yet. This can only be done by the federation user created in step 1.
-
- If no further action is necessary, the Close button will close the window and display the list of all Federations.
-
-.. image:: federation03.png
- :scale: 100%
- :align: center
-
-
-**The Federation user can now add resolvers to the Federation Mapping in Traffic Ops.**
-
-5) The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.
-
- Example::
-
- $ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
-
- HTTP/1.1 200 OK
- Date: Wed, 02 Dec 2015 21:12:06 GMT
- Content-Length: 65
- Access-Control-Allow-Credentials: true
- Content-Type: application/json
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0; expires=Thu, 03 Dec 2015 01:12:06 GMT; path=/; HttpOnly
- Server: Mojolicious (Perl)
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Connection: keep-alive
- Access-Control-Allow-Origin: http://localhost:8080
-
- {"alerts":[{"level":"success","text":"Successfully logged in."}]}
-
-6) The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers
-
-
- Example::
-
- $ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
- {"federations": [
- { "deliveryService": "images-c1",
- "mappings":
- { "resolve4": [ "8.8.8.8/32", "8.8.4.4/32" ],
- "resolve6": ["2001:4860:4860::8888/128", "2001:4860:4860::8844"]
- }
- }
- ]
- }'
-
- HTTP/1.1 200 OK
- Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1OTQyLCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---b42be0749415cefd1d14e1a91bb214845b4de556; expires=Thu, 03 Dec 2015 01:25:42 GMT; path=/; HttpOnly
- Server: Mojolicious (Perl)
- Date: Wed, 02 Dec 2015 21:25:42 GMT
- Content-Length: 74
- Access-Control-Allow-Credentials: true
- Content-Type: application/json
- Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- Access-Control-Allow-Origin: http://localhost:8080
- Connection: keep-alive
- Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
-
- {"response":"federation_user1 successfully created federation resolvers."}
-
-7) The resolvers added by the federation user will now visible in Traffic Ops.
-
-.. image:: federation04.png
- :scale: 100%
- :align: center
-
-8) Any requests made from a client that resolves to one of the federation resolvers will now be given a CNAME from Traffic Router.
-
- Example::
-
- $ dig @tr.kabletown.net edge.images-c1.kabletown.net
-
- ; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net edge.images-c1.kabletown.net
- ; (1 server found)
- ;; global options: +cmd
- ;; Got answer:
- ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 45110
- ;; flags: qr rd; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0
- ;; WARNING: recursion requested but not available
-
- ;; QUESTION SECTION:
- ;edge.images-c1.kabletown.net. IN A
-
- ;; ANSWER SECTION:
- edge.images-c1.kabletown.net. 30 IN CNAME img.mega-cdn.net.
-
- ;; Query time: 9 msec
- ;; SERVER: 10.10.10.10#53(10.10.10.10)
- ;; WHEN: Wed Dec 2 22:05:26 2015
- ;; MSG SIZE rcvd: 84
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/federations.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/federations.txt b/docs/latest/_sources/admin/quick_howto/federations.txt
new file mode 100644
index 0000000..a17122c
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/federations.txt
@@ -0,0 +1,135 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _rl-federations-qht:
+
+*********************
+Configure Federations
+*********************
+
+1) Create a user with a federations role (Misc -> Users -> Add User). This user will have the ability to perform the following actions:
+
+ - Edit the federation
+ - Delete the federation
+ - Add IPV4 resolvers
+ - Add IPV6 resolvers
+
+.. image:: federation01.png
+ :scale: 100%
+ :align: center
+
+2) As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking 'Add Federation Mapping'
+
+3) Choose the Delivery Service for the federation to be mapped to and assign it to the Federation User; click Add.
+
+.. image:: federation02.png
+ :scale: 100%
+ :align: center
+
+4) After the Federation is added, Traffic Ops will display the Federation.
+
+ Changes can be made at this time or the Federation can be deleted. Notice that no resolvers have been added to the fedeation yet. This can only be done by the federation user created in step 1.
+
+ If no further action is necessary, the Close button will close the window and display the list of all Federations.
+
+.. image:: federation03.png
+ :scale: 100%
+ :align: center
+
+
+**The Federation user can now add resolvers to the Federation Mapping in Traffic Ops.**
+
+5) The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.
+
+ Example::
+
+ $ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
+
+ HTTP/1.1 200 OK
+ Date: Wed, 02 Dec 2015 21:12:06 GMT
+ Content-Length: 65
+ Access-Control-Allow-Credentials: true
+ Content-Type: application/json
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0; expires=Thu, 03 Dec 2015 01:12:06 GMT; path=/; HttpOnly
+ Server: Mojolicious (Perl)
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ Connection: keep-alive
+ Access-Control-Allow-Origin: http://localhost:8080
+
+ {"alerts":[{"level":"success","text":"Successfully logged in."}]}
+
+6) The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers
+
+
+ Example::
+
+ $ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
+ {"federations": [
+ { "deliveryService": "images-c1",
+ "mappings":
+ { "resolve4": [ "8.8.8.8/32", "8.8.4.4/32" ],
+ "resolve6": ["2001:4860:4860::8888/128", "2001:4860:4860::8844"]
+ }
+ }
+ ]
+ }'
+
+ HTTP/1.1 200 OK
+ Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1OTQyLCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---b42be0749415cefd1d14e1a91bb214845b4de556; expires=Thu, 03 Dec 2015 01:25:42 GMT; path=/; HttpOnly
+ Server: Mojolicious (Perl)
+ Date: Wed, 02 Dec 2015 21:25:42 GMT
+ Content-Length: 74
+ Access-Control-Allow-Credentials: true
+ Content-Type: application/json
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ Access-Control-Allow-Origin: http://localhost:8080
+ Connection: keep-alive
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+
+ {"response":"federation_user1 successfully created federation resolvers."}
+
+7) The resolvers added by the federation user will now visible in Traffic Ops.
+
+.. image:: federation04.png
+ :scale: 100%
+ :align: center
+
+8) Any requests made from a client that resolves to one of the federation resolvers will now be given a CNAME from Traffic Router.
+
+ Example::
+
+ $ dig @tr.kabletown.net edge.images-c1.kabletown.net
+
+ ; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net edge.images-c1.kabletown.net
+ ; (1 server found)
+ ;; global options: +cmd
+ ;; Got answer:
+ ;; ->>HEADER<<- opcode: QUERY, status: NOERROR, id: 45110
+ ;; flags: qr rd; QUERY: 1, ANSWER: 1, AUTHORITY: 0, ADDITIONAL: 0
+ ;; WARNING: recursion requested but not available
+
+ ;; QUESTION SECTION:
+ ;edge.images-c1.kabletown.net. IN A
+
+ ;; ANSWER SECTION:
+ edge.images-c1.kabletown.net. 30 IN CNAME img.mega-cdn.net.
+
+ ;; Query time: 9 msec
+ ;; SERVER: 10.10.10.10#53(10.10.10.10)
+ ;; WHEN: Wed Dec 2 22:05:26 2015
+ ;; MSG SIZE rcvd: 84
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/index.rst.txt b/docs/latest/_sources/admin/quick_howto/index.rst.txt
deleted file mode 100644
index 96f098f..0000000
--- a/docs/latest/_sources/admin/quick_howto/index.rst.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Quick How To Guides
-*******************
-
-Traffic Control is a complicated system, and documenting it is not trivial. Sometimes a picture says more than a thousand words, so here are some screen shot based tutorials on how to use some of the more involved features.
-
-.. toctree::
- :maxdepth: 3
-
- multi_site.rst
- dnssec.rst
- federations.rst
- regionalgeo.rst
- steering.rst
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/index.txt b/docs/latest/_sources/admin/quick_howto/index.txt
new file mode 100644
index 0000000..96f098f
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/index.txt
@@ -0,0 +1,28 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Quick How To Guides
+*******************
+
+Traffic Control is a complicated system, and documenting it is not trivial. Sometimes a picture says more than a thousand words, so here are some screen shot based tutorials on how to use some of the more involved features.
+
+.. toctree::
+ :maxdepth: 3
+
+ multi_site.rst
+ dnssec.rst
+ federations.rst
+ regionalgeo.rst
+ steering.rst
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/multi_site.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/multi_site.rst.txt b/docs/latest/_sources/admin/quick_howto/multi_site.rst.txt
deleted file mode 100644
index 32b5436..0000000
--- a/docs/latest/_sources/admin/quick_howto/multi_site.rst.txt
+++ /dev/null
@@ -1,95 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _rl-multi-site-origin-qht:
-
-***************************
-Configure Multi Site Origin
-***************************
-
-1) Create "cachegroups" for the origin locations, and assign the appropriate parent-child relationship between the mid cg's and org cgs (click the image to see full size):
-
-.. image:: C5C4CD22-949A-48FD-8976-C673083E2177.png
- :scale: 100%
- :align: center
-
-2) Create a profile to assign to each of the origins:
-
-.. image:: 19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png
- :scale: 100%
- :align: center
-
-3) Create server entries for the origination vips:
-
-.. image:: D28614AA-9758-45ED-9EFD-3A284FC4218E.png
- :scale: 100%
- :align: center
-
-4) Check the multi-site check box in the delivery service screen and make sure that Content Routing Type is set to HTTP_LIVE_NATL:
-
-.. image:: mso-enable.png
- :scale: 100%
- :align: center
-
-5) Assign the org servers to the delivery service that will have the multi site feature:
-
-.. image:: 066CEF4F-C1A3-4A89-8B52-4F72B0531367.png
- :scale: 100%
- :align: center
-
-.. Note:: “Origin Server Base URL” uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that “Origin Server Base URL” (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are:
- 1) If there are multiple CDNs created on the same Traffic Ops, delivery services across different CDNs may have the same OFQDN configured.
- 2) If several delivery services in the same CDN have the same MSO algorithm configured, they may share the same OFQDN.
- 3) If delivery services are assigned with different MID cache groups respectively, they can share the same OFQDN.
-
-6) Select an option from the "Multi Site Origin Algorithm" drop-down list. Four MSO algorithms are supported:
-
-+------------------+--------------------------------------------------------------------------------------------------------------------+
-| Option | Description |
-+==================+====================================================================================================================+
-| Consistent hash | Origin server selection is based on the consistent hash of requested URLs. |
-+------------------+--------------------------------------------------------------------------------------------------------------------+
-| Primary/back | Round robin selection does not occur. The first origin server is selected unless it fails. |
-| | If the first fails, the second and other following origin servers will be tried by order. |
-| | Order is defined by 2 factors - if the origin server's cachegroup is configured as the |
-| | parent cachegroup for the mid, then this server will be used as the primary. The same rules |
-| | apply for secondary parents, in order. Within the cachegroups, the rank parameter will sort |
-| | order further. If no parents are defined at the mid, then only rank is considered. |
-+------------------+--------------------------------------------------------------------------------------------------------------------+
-| Strict | MID caches serve requests strictly in turn. For example: origin server 1 serves the first request, |
-| round-robin | origin server 2 serves the second request, and so on. |
-+------------------+--------------------------------------------------------------------------------------------------------------------+
-| IP based | MID cache goes through the origin server list in a round robin-based on the IP address of EDGE cache. |
-| round-robin | |
-+------------------+--------------------------------------------------------------------------------------------------------------------+
-
-7) Optionally, there are two configuration options that can set the order of the origins used if "Primary/backup" is selected for "Multi Site Origin Algorithm". By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter “rank” should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of "2" precedes OS with the rank of "5". For any OS, if rank value is not defined in its profile, its rank value will default to “1”. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific backup servers for use at specific locations.
-
-.. image:: mso-rank.png
- :scale: 60%
- :align: center
-
-8) Assign the parent.config location parameter to the MID profile:
-
-.. image:: D22DCAA3-18CC-48F4-965B-5312993F9820.png
- :scale: 100%
- :align: center
-
-
-9) Configure the mid hdr_rewrite on the delivery service, example: ::
-
- cond %{REMAP_PSEUDO_HOOK} __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_response_codes "400,404,412" __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_response_codes "502,503" __RETURN__ set-config proxy.config.http.connect_attempts_timeout 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries_dead_server 1 __RETURN__ set-config proxy.config.http.transaction_active_timeout_in 5 [L] __RETURN__
-
-10) Turn on parent_proxy_routing in the MID profile.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/multi_site.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/multi_site.txt b/docs/latest/_sources/admin/quick_howto/multi_site.txt
new file mode 100644
index 0000000..32b5436
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/multi_site.txt
@@ -0,0 +1,95 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _rl-multi-site-origin-qht:
+
+***************************
+Configure Multi Site Origin
+***************************
+
+1) Create "cachegroups" for the origin locations, and assign the appropriate parent-child relationship between the mid cg's and org cgs (click the image to see full size):
+
+.. image:: C5C4CD22-949A-48FD-8976-C673083E2177.png
+ :scale: 100%
+ :align: center
+
+2) Create a profile to assign to each of the origins:
+
+.. image:: 19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png
+ :scale: 100%
+ :align: center
+
+3) Create server entries for the origination vips:
+
+.. image:: D28614AA-9758-45ED-9EFD-3A284FC4218E.png
+ :scale: 100%
+ :align: center
+
+4) Check the multi-site check box in the delivery service screen and make sure that Content Routing Type is set to HTTP_LIVE_NATL:
+
+.. image:: mso-enable.png
+ :scale: 100%
+ :align: center
+
+5) Assign the org servers to the delivery service that will have the multi site feature:
+
+.. image:: 066CEF4F-C1A3-4A89-8B52-4F72B0531367.png
+ :scale: 100%
+ :align: center
+
+.. Note:: “Origin Server Base URL” uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that “Origin Server Base URL” (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are:
+ 1) If there are multiple CDNs created on the same Traffic Ops, delivery services across different CDNs may have the same OFQDN configured.
+ 2) If several delivery services in the same CDN have the same MSO algorithm configured, they may share the same OFQDN.
+ 3) If delivery services are assigned with different MID cache groups respectively, they can share the same OFQDN.
+
+6) Select an option from the "Multi Site Origin Algorithm" drop-down list. Four MSO algorithms are supported:
+
++------------------+--------------------------------------------------------------------------------------------------------------------+
+| Option | Description |
++==================+====================================================================================================================+
+| Consistent hash | Origin server selection is based on the consistent hash of requested URLs. |
++------------------+--------------------------------------------------------------------------------------------------------------------+
+| Primary/back | Round robin selection does not occur. The first origin server is selected unless it fails. |
+| | If the first fails, the second and other following origin servers will be tried by order. |
+| | Order is defined by 2 factors - if the origin server's cachegroup is configured as the |
+| | parent cachegroup for the mid, then this server will be used as the primary. The same rules |
+| | apply for secondary parents, in order. Within the cachegroups, the rank parameter will sort |
+| | order further. If no parents are defined at the mid, then only rank is considered. |
++------------------+--------------------------------------------------------------------------------------------------------------------+
+| Strict | MID caches serve requests strictly in turn. For example: origin server 1 serves the first request, |
+| round-robin | origin server 2 serves the second request, and so on. |
++------------------+--------------------------------------------------------------------------------------------------------------------+
+| IP based | MID cache goes through the origin server list in a round robin-based on the IP address of EDGE cache. |
+| round-robin | |
++------------------+--------------------------------------------------------------------------------------------------------------------+
+
+7) Optionally, there are two configuration options that can set the order of the origins used if "Primary/backup" is selected for "Multi Site Origin Algorithm". By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter “rank” should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of "2" precedes OS with the rank of "5". For any OS, if rank value is not defined in its profile, its rank value will default to “1”. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific backup servers for use at specific locations.
+
+.. image:: mso-rank.png
+ :scale: 60%
+ :align: center
+
+8) Assign the parent.config location parameter to the MID profile:
+
+.. image:: D22DCAA3-18CC-48F4-965B-5312993F9820.png
+ :scale: 100%
+ :align: center
+
+
+9) Configure the mid hdr_rewrite on the delivery service, example: ::
+
+ cond %{REMAP_PSEUDO_HOOK} __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_response_codes "400,404,412" __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_response_codes "502,503" __RETURN__ set-config proxy.config.http.connect_attempts_timeout 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries_dead_server 1 __RETURN__ set-config proxy.config.http.transaction_active_timeout_in 5 [L] __RETURN__
+
+10) Turn on parent_proxy_routing in the MID profile.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/regionalgeo.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/regionalgeo.rst.txt b/docs/latest/_sources/admin/quick_howto/regionalgeo.rst.txt
deleted file mode 100644
index a903c8a..0000000
--- a/docs/latest/_sources/admin/quick_howto/regionalgeo.rst.txt
+++ /dev/null
@@ -1,109 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _rl-regionalgeo-qht:
-
-**************************************
-Configure Regional Geo-blocking (RGB)
-**************************************
-
-.. Note:: RGB is only supported for HTTP delivery services.
-
-1) Prepare RGB configuration file
-
-RGB uses a configuration file in JSON format to define regional geo-blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows::
-
- {
- "deliveryServices":
- [
- {
- "deliveryServiceId": "hls-live",
- "urlRegex": ".*live4\\.m3u8",
- "geoLocation": {"includePostalCode":["N0H", "L9V", "L9W"]},
- "redirectUrl": "http://third-party.com/blacked_out.html"
- },
- {
- "deliveryServiceId": "hls-live",
- "urlRegex": ".*live5\\.m3u8",
- "ipWhiteList": [185.68.71.9/22","142.232.0.79/24"],
- "geoLocation": {"excludePostalCode":["N0H", "L9V"]},
- "redirectUrl": "/live5_low_bitrate.m3u8"
- }
- ]
- }
-
-* The value of "deliveryServiceId" shall be equal to the “XML ID” field of the intended delivery service defined on Traffic Ops.
-
-* “urlRegex” is to match request URLs. The URLs matching the regex are applicable to the rule.
-
-* “geoLocation” currently supports “includePostalCode” and “excludePostalCode” attribute. When “includePostalCode” attribute is used, only the clients whose FSAs are in the “includePostalCode” list are able to view the content represented by “urlRegex”. When “excludePostalCode” is used, any client whose FSA are not in the “excludePostalCode” list are allowed to view the content. “includePostalCode” and “excludePostalCode” are mutually exclusive in one rule. (FSA: Forward Sortation Area, first three postal characters of Canadian postal codes)
-
-* “redirectUrl” is the URL that will be responded to the blocked clients. Without a domain name in the URL, the URL will still be served in the same delivery service. Thus Traffic Router will redirect the client to a chosen cache server assigned to the delivery service. If the URL includes a domain name, Traffic Router simply redirects the client to the defined URL. In the later case, the redirect URL must not match the “urlRegex” part to avoid HTTP 302 loop on Traffic Router.
-
-* “ipWhiteList” is an optional element. It includes a list of CIDR (Classless Inter-Domain Routing) blocks indicating the IPv4 subnets that are allowed by the rule. If this list exists and the value is not empty, client IP will be matched against the CIDR list, and if there is any match, the request will be allowed and no postal code matching logic is needed. If there is no match in the white list, postal code matching logic will be processed further.
-
-
-2) Add RGB parameters on Traffic Ops
-
-The two new parameters in following table are required to be added into CRConfig.json:
-
-* "regional_geoblocking.polling.url": the HTTP URL of RGB configuration file. Traffic Router will fetch the file from this URL.
-* "regional_geoblocking.polling.interval": the interval that Traffic Router polls the RGB configuration file.
-
-.. image:: regionalgeo01.png
- :scale: 100%
- :align: center
-
-3) Enable RGB for a delivery service
-
-.. image:: regionalgeo02.png
- :scale: 100%
- :align: center
-
-4) Make configuration effective
-
-Go to Tools->Snapshot CRConfig, perform “Diff CRConfig” and click "Write CRConfig".
-
-.. image:: regionalgeo03.png
- :scale: 70%
- :align: center
-
-5) Traffic Router access log with RGB
-
-RGB extends the field of "rtype" and adds a new field "rgb" in Traffic Router access.log to help to monitor the working of this feature.
-
-For "rtype", RGALT indicates that a request is redirected to an alternate URL by RGB; RGDENY indicates that a request is denied by RGB because there is no matching rule in JSON for this request.
-
-For "rgb", when RGB is enabled, it will be non-empty with following format::
-
- {FSA}:{allowed/disallowed}:{include/exclude postal}:{fallback config/current config}:{allowed by whitelist/otherwise}
-
-
-* {FSA}: It is the client’s FSA part of its postal code, which is retrieved from geo-location database. If FSA is empty, dash (“-“) is filled in.
-* {allowed/disallowed}: This flag shows if a request is allowed or disallowed by RGB (1 for yes, and 0 for no).
-* {include/exclude postal}: It shows that when a rule in JSON is matched for a request, it is an include or exclude list of postal codes (i.e. FSAs). “I” for include, and “X” for exclude. If no rule matches, dash (“-“) is filled in.
-* {fallback config/current config}: when TR fails to parse an RGB JSON, TR will handle requests with latest valid JSON configuration, but will set {fallback config} flag to 1. If the new JSON is valid, then the flag is set to 0.
-* {allowed by whitelist/otherwise}: If a request is allowed by whitelist, this flag is set to 1; for all other cases, it is 0.
-
-
-Example::
-
- 1446442214.685 qtype=HTTP chi=129.100.254.79 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="-" rdtl=- rerr="-" rgb="N6G:1:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/live5.m3u8 rh="-"
-
- 1446442219.181 qtype=HTTP chi=184.68.71.9 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGALT rloc="-" rdtl=- rerr="-" rgb="-:0:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/low_bitrate.m3u8 rh="-"
-
- 1446445521.677 qtype=HTTP chi=24.114.29.79 url="http://ccr.geo2.cdn.com/live51.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGDENY rloc="-" rdtl=- rerr="-" rgb="L4S:0:-:0:0" pssc=520 ttms=3 rurl="-" rh="-"
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/regionalgeo.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/regionalgeo.txt b/docs/latest/_sources/admin/quick_howto/regionalgeo.txt
new file mode 100644
index 0000000..a903c8a
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/regionalgeo.txt
@@ -0,0 +1,109 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _rl-regionalgeo-qht:
+
+**************************************
+Configure Regional Geo-blocking (RGB)
+**************************************
+
+.. Note:: RGB is only supported for HTTP delivery services.
+
+1) Prepare RGB configuration file
+
+RGB uses a configuration file in JSON format to define regional geo-blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows::
+
+ {
+ "deliveryServices":
+ [
+ {
+ "deliveryServiceId": "hls-live",
+ "urlRegex": ".*live4\\.m3u8",
+ "geoLocation": {"includePostalCode":["N0H", "L9V", "L9W"]},
+ "redirectUrl": "http://third-party.com/blacked_out.html"
+ },
+ {
+ "deliveryServiceId": "hls-live",
+ "urlRegex": ".*live5\\.m3u8",
+ "ipWhiteList": [185.68.71.9/22","142.232.0.79/24"],
+ "geoLocation": {"excludePostalCode":["N0H", "L9V"]},
+ "redirectUrl": "/live5_low_bitrate.m3u8"
+ }
+ ]
+ }
+
+* The value of "deliveryServiceId" shall be equal to the “XML ID” field of the intended delivery service defined on Traffic Ops.
+
+* “urlRegex” is to match request URLs. The URLs matching the regex are applicable to the rule.
+
+* “geoLocation” currently supports “includePostalCode” and “excludePostalCode” attribute. When “includePostalCode” attribute is used, only the clients whose FSAs are in the “includePostalCode” list are able to view the content represented by “urlRegex”. When “excludePostalCode” is used, any client whose FSA are not in the “excludePostalCode” list are allowed to view the content. “includePostalCode” and “excludePostalCode” are mutually exclusive in one rule. (FSA: Forward Sortation Area, first three postal characters of Canadian postal codes)
+
+* “redirectUrl” is the URL that will be responded to the blocked clients. Without a domain name in the URL, the URL will still be served in the same delivery service. Thus Traffic Router will redirect the client to a chosen cache server assigned to the delivery service. If the URL includes a domain name, Traffic Router simply redirects the client to the defined URL. In the later case, the redirect URL must not match the “urlRegex” part to avoid HTTP 302 loop on Traffic Router.
+
+* “ipWhiteList” is an optional element. It includes a list of CIDR (Classless Inter-Domain Routing) blocks indicating the IPv4 subnets that are allowed by the rule. If this list exists and the value is not empty, client IP will be matched against the CIDR list, and if there is any match, the request will be allowed and no postal code matching logic is needed. If there is no match in the white list, postal code matching logic will be processed further.
+
+
+2) Add RGB parameters on Traffic Ops
+
+The two new parameters in following table are required to be added into CRConfig.json:
+
+* "regional_geoblocking.polling.url": the HTTP URL of RGB configuration file. Traffic Router will fetch the file from this URL.
+* "regional_geoblocking.polling.interval": the interval that Traffic Router polls the RGB configuration file.
+
+.. image:: regionalgeo01.png
+ :scale: 100%
+ :align: center
+
+3) Enable RGB for a delivery service
+
+.. image:: regionalgeo02.png
+ :scale: 100%
+ :align: center
+
+4) Make configuration effective
+
+Go to Tools->Snapshot CRConfig, perform “Diff CRConfig” and click "Write CRConfig".
+
+.. image:: regionalgeo03.png
+ :scale: 70%
+ :align: center
+
+5) Traffic Router access log with RGB
+
+RGB extends the field of "rtype" and adds a new field "rgb" in Traffic Router access.log to help to monitor the working of this feature.
+
+For "rtype", RGALT indicates that a request is redirected to an alternate URL by RGB; RGDENY indicates that a request is denied by RGB because there is no matching rule in JSON for this request.
+
+For "rgb", when RGB is enabled, it will be non-empty with following format::
+
+ {FSA}:{allowed/disallowed}:{include/exclude postal}:{fallback config/current config}:{allowed by whitelist/otherwise}
+
+
+* {FSA}: It is the client’s FSA part of its postal code, which is retrieved from geo-location database. If FSA is empty, dash (“-“) is filled in.
+* {allowed/disallowed}: This flag shows if a request is allowed or disallowed by RGB (1 for yes, and 0 for no).
+* {include/exclude postal}: It shows that when a rule in JSON is matched for a request, it is an include or exclude list of postal codes (i.e. FSAs). “I” for include, and “X” for exclude. If no rule matches, dash (“-“) is filled in.
+* {fallback config/current config}: when TR fails to parse an RGB JSON, TR will handle requests with latest valid JSON configuration, but will set {fallback config} flag to 1. If the new JSON is valid, then the flag is set to 0.
+* {allowed by whitelist/otherwise}: If a request is allowed by whitelist, this flag is set to 1; for all other cases, it is 0.
+
+
+Example::
+
+ 1446442214.685 qtype=HTTP chi=129.100.254.79 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="-" rdtl=- rerr="-" rgb="N6G:1:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/live5.m3u8 rh="-"
+
+ 1446442219.181 qtype=HTTP chi=184.68.71.9 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGALT rloc="-" rdtl=- rerr="-" rgb="-:0:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/low_bitrate.m3u8 rh="-"
+
+ 1446445521.677 qtype=HTTP chi=24.114.29.79 url="http://ccr.geo2.cdn.com/live51.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGDENY rloc="-" rdtl=- rerr="-" rgb="L4S:0:-:0:0" pssc=520 ttms=3 rurl="-" rh="-"
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/steering.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/steering.rst.txt b/docs/latest/_sources/admin/quick_howto/steering.rst.txt
deleted file mode 100644
index 1060f29..0000000
--- a/docs/latest/_sources/admin/quick_howto/steering.rst.txt
+++ /dev/null
@@ -1,95 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _rl-steering-qht:
-
-***********************************
-Configure Delivery Service Steering
-***********************************
-
-1) Create two target delivery services in Traffic Ops. They must both be HTTP delivery services that are part of the same CDN.
-
-.. image:: steering01.png
- :scale: 100%
- :align: center
-
-2) Create a delivery service with type STEERING in Traffic Ops.
-
-.. image:: steering02.png
- :scale: 100%
- :align: center
-
-3) Click the 'Manage Steering Assignments' button on the delivery service screen to assign targets.
-
-.. image:: steering03.png
- :scale: 100%
- :align: center
-
-4) Create a user with the role of Steering.
-
-.. image:: steering04.png
- :scale: 100%
- :align: center
-
-5) As the steering user, assign weights to target delivery services. This will require logging in to Traffic Ops first via ``http://to.kabletown.net/api/1.2/user/login`` and storing the mojolicious cookie.
-
- Sample cURL: ``curl -H "Cookie: mojolicious=xxxyyy" -XPUT "https://to.kabletown.net/internal/api/1.2/steering/steering-ds" -d @/tmp/steering.json``
-
- Sample JSON body:
-
-::
-
- {
- "targets": [
- {
- "weight": "1000",
- "deliveryService": "target-deliveryservice-1"
- },
- {
- "weight": "9000",
- "deliveryService": "target-deliveryservice-2"
- }
- ]
- }
-
-6) If desired, the steering user can create filters for the target delivery services.
-
- Sample cURL: ``curl -H "Cookie: mojolicious=xxxyyy" -XPUT "https://to.kabletown.net/internal/api/1.2/steering/steering-ds" -d @/tmp/steering.json``
-
- Sample JSON body:
-
-::
-
- {
- "filters": [
- {
- "pattern": ".*\\gototarget1\\..*",
- "deliveryService": "target-deliveryservice-1"
- }
- ],
- "targets": [
- {
- "weight": "1000",
- "deliveryService": "target-deliveryservice-1"
- },
- {
- "weight": "9000",
- "deliveryService": "target-deliveryservice-2"
- }
- ]
- }
-
-7) Any requests to Traffic Router for the steering delivery service should now be routed to target delivery services based on configured weight. Example: ``curl -Lvs http://tr.steering-ds.cdn.kabletown.net/foo``
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/quick_howto/steering.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/quick_howto/steering.txt b/docs/latest/_sources/admin/quick_howto/steering.txt
new file mode 100644
index 0000000..1060f29
--- /dev/null
+++ b/docs/latest/_sources/admin/quick_howto/steering.txt
@@ -0,0 +1,95 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _rl-steering-qht:
+
+***********************************
+Configure Delivery Service Steering
+***********************************
+
+1) Create two target delivery services in Traffic Ops. They must both be HTTP delivery services that are part of the same CDN.
+
+.. image:: steering01.png
+ :scale: 100%
+ :align: center
+
+2) Create a delivery service with type STEERING in Traffic Ops.
+
+.. image:: steering02.png
+ :scale: 100%
+ :align: center
+
+3) Click the 'Manage Steering Assignments' button on the delivery service screen to assign targets.
+
+.. image:: steering03.png
+ :scale: 100%
+ :align: center
+
+4) Create a user with the role of Steering.
+
+.. image:: steering04.png
+ :scale: 100%
+ :align: center
+
+5) As the steering user, assign weights to target delivery services. This will require logging in to Traffic Ops first via ``http://to.kabletown.net/api/1.2/user/login`` and storing the mojolicious cookie.
+
+ Sample cURL: ``curl -H "Cookie: mojolicious=xxxyyy" -XPUT "https://to.kabletown.net/internal/api/1.2/steering/steering-ds" -d @/tmp/steering.json``
+
+ Sample JSON body:
+
+::
+
+ {
+ "targets": [
+ {
+ "weight": "1000",
+ "deliveryService": "target-deliveryservice-1"
+ },
+ {
+ "weight": "9000",
+ "deliveryService": "target-deliveryservice-2"
+ }
+ ]
+ }
+
+6) If desired, the steering user can create filters for the target delivery services.
+
+ Sample cURL: ``curl -H "Cookie: mojolicious=xxxyyy" -XPUT "https://to.kabletown.net/internal/api/1.2/steering/steering-ds" -d @/tmp/steering.json``
+
+ Sample JSON body:
+
+::
+
+ {
+ "filters": [
+ {
+ "pattern": ".*\\gototarget1\\..*",
+ "deliveryService": "target-deliveryservice-1"
+ }
+ ],
+ "targets": [
+ {
+ "weight": "1000",
+ "deliveryService": "target-deliveryservice-1"
+ },
+ {
+ "weight": "9000",
+ "deliveryService": "target-deliveryservice-2"
+ }
+ ]
+ }
+
+7) Any requests to Traffic Router for the steering delivery service should now be routed to target delivery services based on configured weight. Example: ``curl -Lvs http://tr.steering-ds.cdn.kabletown.net/foo``
+
[16/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/jquery-3.1.0.js
----------------------------------------------------------------------
diff --git a/docs/latest/_static/jquery-3.1.0.js b/docs/latest/_static/jquery-3.1.0.js
deleted file mode 100644
index f2fc274..0000000
--- a/docs/latest/_static/jquery-3.1.0.js
+++ /dev/null
@@ -1,10074 +0,0 @@
-/*eslint-disable no-unused-vars*/
-/*!
- * jQuery JavaScript Library v3.1.0
- * https://jquery.com/
- *
- * Includes Sizzle.js
- * https://sizzlejs.com/
- *
- * Copyright jQuery Foundation and other contributors
- * Released under the MIT license
- * https://jquery.org/license
- *
- * Date: 2016-07-07T21:44Z
- */
-( function( global, factory ) {
-
- "use strict";
-
- if ( typeof module === "object" && typeof module.exports === "object" ) {
-
- // For CommonJS and CommonJS-like environments where a proper `window`
- // is present, execute the factory and get jQuery.
- // For environments that do not have a `window` with a `document`
- // (such as Node.js), expose a factory as module.exports.
- // This accentuates the need for the creation of a real `window`.
- // e.g. var jQuery = require("jquery")(window);
- // See ticket #14549 for more info.
- module.exports = global.document ?
- factory( global, true ) :
- function( w ) {
- if ( !w.document ) {
- throw new Error( "jQuery requires a window with a document" );
- }
- return factory( w );
- };
- } else {
- factory( global );
- }
-
-// Pass this if window is not defined yet
-} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
-
-// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1
-// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode
-// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common
-// enough that all such attempts are guarded in a try block.
-"use strict";
-
-var arr = [];
-
-var document = window.document;
-
-var getProto = Object.getPrototypeOf;
-
-var slice = arr.slice;
-
-var concat = arr.concat;
-
-var push = arr.push;
-
-var indexOf = arr.indexOf;
-
-var class2type = {};
-
-var toString = class2type.toString;
-
-var hasOwn = class2type.hasOwnProperty;
-
-var fnToString = hasOwn.toString;
-
-var ObjectFunctionString = fnToString.call( Object );
-
-var support = {};
-
-
-
- function DOMEval( code, doc ) {
- doc = doc || document;
-
- var script = doc.createElement( "script" );
-
- script.text = code;
- doc.head.appendChild( script ).parentNode.removeChild( script );
- }
-/* global Symbol */
-// Defining this global in .eslintrc would create a danger of using the global
-// unguarded in another place, it seems safer to define global only for this module
-
-
-
-var
- version = "3.1.0",
-
- // Define a local copy of jQuery
- jQuery = function( selector, context ) {
-
- // The jQuery object is actually just the init constructor 'enhanced'
- // Need init if jQuery is called (just allow error to be thrown if not included)
- return new jQuery.fn.init( selector, context );
- },
-
- // Support: Android <=4.0 only
- // Make sure we trim BOM and NBSP
- rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,
-
- // Matches dashed string for camelizing
- rmsPrefix = /^-ms-/,
- rdashAlpha = /-([a-z])/g,
-
- // Used by jQuery.camelCase as callback to replace()
- fcamelCase = function( all, letter ) {
- return letter.toUpperCase();
- };
-
-jQuery.fn = jQuery.prototype = {
-
- // The current version of jQuery being used
- jquery: version,
-
- constructor: jQuery,
-
- // The default length of a jQuery object is 0
- length: 0,
-
- toArray: function() {
- return slice.call( this );
- },
-
- // Get the Nth element in the matched element set OR
- // Get the whole matched element set as a clean array
- get: function( num ) {
- return num != null ?
-
- // Return just the one element from the set
- ( num < 0 ? this[ num + this.length ] : this[ num ] ) :
-
- // Return all the elements in a clean array
- slice.call( this );
- },
-
- // Take an array of elements and push it onto the stack
- // (returning the new matched element set)
- pushStack: function( elems ) {
-
- // Build a new jQuery matched element set
- var ret = jQuery.merge( this.constructor(), elems );
-
- // Add the old object onto the stack (as a reference)
- ret.prevObject = this;
-
- // Return the newly-formed element set
- return ret;
- },
-
- // Execute a callback for every element in the matched set.
- each: function( callback ) {
- return jQuery.each( this, callback );
- },
-
- map: function( callback ) {
- return this.pushStack( jQuery.map( this, function( elem, i ) {
- return callback.call( elem, i, elem );
- } ) );
- },
-
- slice: function() {
- return this.pushStack( slice.apply( this, arguments ) );
- },
-
- first: function() {
- return this.eq( 0 );
- },
-
- last: function() {
- return this.eq( -1 );
- },
-
- eq: function( i ) {
- var len = this.length,
- j = +i + ( i < 0 ? len : 0 );
- return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] );
- },
-
- end: function() {
- return this.prevObject || this.constructor();
- },
-
- // For internal use only.
- // Behaves like an Array's method, not like a jQuery method.
- push: push,
- sort: arr.sort,
- splice: arr.splice
-};
-
-jQuery.extend = jQuery.fn.extend = function() {
- var options, name, src, copy, copyIsArray, clone,
- target = arguments[ 0 ] || {},
- i = 1,
- length = arguments.length,
- deep = false;
-
- // Handle a deep copy situation
- if ( typeof target === "boolean" ) {
- deep = target;
-
- // Skip the boolean and the target
- target = arguments[ i ] || {};
- i++;
- }
-
- // Handle case when target is a string or something (possible in deep copy)
- if ( typeof target !== "object" && !jQuery.isFunction( target ) ) {
- target = {};
- }
-
- // Extend jQuery itself if only one argument is passed
- if ( i === length ) {
- target = this;
- i--;
- }
-
- for ( ; i < length; i++ ) {
-
- // Only deal with non-null/undefined values
- if ( ( options = arguments[ i ] ) != null ) {
-
- // Extend the base object
- for ( name in options ) {
- src = target[ name ];
- copy = options[ name ];
-
- // Prevent never-ending loop
- if ( target === copy ) {
- continue;
- }
-
- // Recurse if we're merging plain objects or arrays
- if ( deep && copy && ( jQuery.isPlainObject( copy ) ||
- ( copyIsArray = jQuery.isArray( copy ) ) ) ) {
-
- if ( copyIsArray ) {
- copyIsArray = false;
- clone = src && jQuery.isArray( src ) ? src : [];
-
- } else {
- clone = src && jQuery.isPlainObject( src ) ? src : {};
- }
-
- // Never move original objects, clone them
- target[ name ] = jQuery.extend( deep, clone, copy );
-
- // Don't bring in undefined values
- } else if ( copy !== undefined ) {
- target[ name ] = copy;
- }
- }
- }
- }
-
- // Return the modified object
- return target;
-};
-
-jQuery.extend( {
-
- // Unique for each copy of jQuery on the page
- expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ),
-
- // Assume jQuery is ready without the ready module
- isReady: true,
-
- error: function( msg ) {
- throw new Error( msg );
- },
-
- noop: function() {},
-
- isFunction: function( obj ) {
- return jQuery.type( obj ) === "function";
- },
-
- isArray: Array.isArray,
-
- isWindow: function( obj ) {
- return obj != null && obj === obj.window;
- },
-
- isNumeric: function( obj ) {
-
- // As of jQuery 3.0, isNumeric is limited to
- // strings and numbers (primitives or objects)
- // that can be coerced to finite numbers (gh-2662)
- var type = jQuery.type( obj );
- return ( type === "number" || type === "string" ) &&
-
- // parseFloat NaNs numeric-cast false positives ("")
- // ...but misinterprets leading-number strings, particularly hex literals ("0x...")
- // subtraction forces infinities to NaN
- !isNaN( obj - parseFloat( obj ) );
- },
-
- isPlainObject: function( obj ) {
- var proto, Ctor;
-
- // Detect obvious negatives
- // Use toString instead of jQuery.type to catch host objects
- if ( !obj || toString.call( obj ) !== "[object Object]" ) {
- return false;
- }
-
- proto = getProto( obj );
-
- // Objects with no prototype (e.g., `Object.create( null )`) are plain
- if ( !proto ) {
- return true;
- }
-
- // Objects with prototype are plain iff they were constructed by a global Object function
- Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor;
- return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString;
- },
-
- isEmptyObject: function( obj ) {
-
- /* eslint-disable no-unused-vars */
- // See https://github.com/eslint/eslint/issues/6125
- var name;
-
- for ( name in obj ) {
- return false;
- }
- return true;
- },
-
- type: function( obj ) {
- if ( obj == null ) {
- return obj + "";
- }
-
- // Support: Android <=2.3 only (functionish RegExp)
- return typeof obj === "object" || typeof obj === "function" ?
- class2type[ toString.call( obj ) ] || "object" :
- typeof obj;
- },
-
- // Evaluates a script in a global context
- globalEval: function( code ) {
- DOMEval( code );
- },
-
- // Convert dashed to camelCase; used by the css and data modules
- // Support: IE <=9 - 11, Edge 12 - 13
- // Microsoft forgot to hump their vendor prefix (#9572)
- camelCase: function( string ) {
- return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase );
- },
-
- nodeName: function( elem, name ) {
- return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();
- },
-
- each: function( obj, callback ) {
- var length, i = 0;
-
- if ( isArrayLike( obj ) ) {
- length = obj.length;
- for ( ; i < length; i++ ) {
- if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
- break;
- }
- }
- } else {
- for ( i in obj ) {
- if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
- break;
- }
- }
- }
-
- return obj;
- },
-
- // Support: Android <=4.0 only
- trim: function( text ) {
- return text == null ?
- "" :
- ( text + "" ).replace( rtrim, "" );
- },
-
- // results is for internal usage only
- makeArray: function( arr, results ) {
- var ret = results || [];
-
- if ( arr != null ) {
- if ( isArrayLike( Object( arr ) ) ) {
- jQuery.merge( ret,
- typeof arr === "string" ?
- [ arr ] : arr
- );
- } else {
- push.call( ret, arr );
- }
- }
-
- return ret;
- },
-
- inArray: function( elem, arr, i ) {
- return arr == null ? -1 : indexOf.call( arr, elem, i );
- },
-
- // Support: Android <=4.0 only, PhantomJS 1 only
- // push.apply(_, arraylike) throws on ancient WebKit
- merge: function( first, second ) {
- var len = +second.length,
- j = 0,
- i = first.length;
-
- for ( ; j < len; j++ ) {
- first[ i++ ] = second[ j ];
- }
-
- first.length = i;
-
- return first;
- },
-
- grep: function( elems, callback, invert ) {
- var callbackInverse,
- matches = [],
- i = 0,
- length = elems.length,
- callbackExpect = !invert;
-
- // Go through the array, only saving the items
- // that pass the validator function
- for ( ; i < length; i++ ) {
- callbackInverse = !callback( elems[ i ], i );
- if ( callbackInverse !== callbackExpect ) {
- matches.push( elems[ i ] );
- }
- }
-
- return matches;
- },
-
- // arg is for internal usage only
- map: function( elems, callback, arg ) {
- var length, value,
- i = 0,
- ret = [];
-
- // Go through the array, translating each of the items to their new values
- if ( isArrayLike( elems ) ) {
- length = elems.length;
- for ( ; i < length; i++ ) {
- value = callback( elems[ i ], i, arg );
-
- if ( value != null ) {
- ret.push( value );
- }
- }
-
- // Go through every key on the object,
- } else {
- for ( i in elems ) {
- value = callback( elems[ i ], i, arg );
-
- if ( value != null ) {
- ret.push( value );
- }
- }
- }
-
- // Flatten any nested arrays
- return concat.apply( [], ret );
- },
-
- // A global GUID counter for objects
- guid: 1,
-
- // Bind a function to a context, optionally partially applying any
- // arguments.
- proxy: function( fn, context ) {
- var tmp, args, proxy;
-
- if ( typeof context === "string" ) {
- tmp = fn[ context ];
- context = fn;
- fn = tmp;
- }
-
- // Quick check to determine if target is callable, in the spec
- // this throws a TypeError, but we will just return undefined.
- if ( !jQuery.isFunction( fn ) ) {
- return undefined;
- }
-
- // Simulated bind
- args = slice.call( arguments, 2 );
- proxy = function() {
- return fn.apply( context || this, args.concat( slice.call( arguments ) ) );
- };
-
- // Set the guid of unique handler to the same of original handler, so it can be removed
- proxy.guid = fn.guid = fn.guid || jQuery.guid++;
-
- return proxy;
- },
-
- now: Date.now,
-
- // jQuery.support is not used in Core but other projects attach their
- // properties to it so it needs to exist.
- support: support
-} );
-
-if ( typeof Symbol === "function" ) {
- jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ];
-}
-
-// Populate the class2type map
-jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ),
-function( i, name ) {
- class2type[ "[object " + name + "]" ] = name.toLowerCase();
-} );
-
-function isArrayLike( obj ) {
-
- // Support: real iOS 8.2 only (not reproducible in simulator)
- // `in` check used to prevent JIT error (gh-2145)
- // hasOwn isn't used here due to false negatives
- // regarding Nodelist length in IE
- var length = !!obj && "length" in obj && obj.length,
- type = jQuery.type( obj );
-
- if ( type === "function" || jQuery.isWindow( obj ) ) {
- return false;
- }
-
- return type === "array" || length === 0 ||
- typeof length === "number" && length > 0 && ( length - 1 ) in obj;
-}
-var Sizzle =
-/*!
- * Sizzle CSS Selector Engine v2.3.0
- * https://sizzlejs.com/
- *
- * Copyright jQuery Foundation and other contributors
- * Released under the MIT license
- * http://jquery.org/license
- *
- * Date: 2016-01-04
- */
-(function( window ) {
-
-var i,
- support,
- Expr,
- getText,
- isXML,
- tokenize,
- compile,
- select,
- outermostContext,
- sortInput,
- hasDuplicate,
-
- // Local document vars
- setDocument,
- document,
- docElem,
- documentIsHTML,
- rbuggyQSA,
- rbuggyMatches,
- matches,
- contains,
-
- // Instance-specific data
- expando = "sizzle" + 1 * new Date(),
- preferredDoc = window.document,
- dirruns = 0,
- done = 0,
- classCache = createCache(),
- tokenCache = createCache(),
- compilerCache = createCache(),
- sortOrder = function( a, b ) {
- if ( a === b ) {
- hasDuplicate = true;
- }
- return 0;
- },
-
- // Instance methods
- hasOwn = ({}).hasOwnProperty,
- arr = [],
- pop = arr.pop,
- push_native = arr.push,
- push = arr.push,
- slice = arr.slice,
- // Use a stripped-down indexOf as it's faster than native
- // https://jsperf.com/thor-indexof-vs-for/5
- indexOf = function( list, elem ) {
- var i = 0,
- len = list.length;
- for ( ; i < len; i++ ) {
- if ( list[i] === elem ) {
- return i;
- }
- }
- return -1;
- },
-
- booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",
-
- // Regular expressions
-
- // http://www.w3.org/TR/css3-selectors/#whitespace
- whitespace = "[\\x20\\t\\r\\n\\f]",
-
- // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier
- identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+",
-
- // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors
- attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace +
- // Operator (capture 2)
- "*([*^$|!~]?=)" + whitespace +
- // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]"
- "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace +
- "*\\]",
-
- pseudos = ":(" + identifier + ")(?:\\((" +
- // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:
- // 1. quoted (capture 3; capture 4 or capture 5)
- "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" +
- // 2. simple (capture 6)
- "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" +
- // 3. anything else (capture 2)
- ".*" +
- ")\\)|)",
-
- // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter
- rwhitespace = new RegExp( whitespace + "+", "g" ),
- rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ),
-
- rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ),
- rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ),
-
- rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ),
-
- rpseudo = new RegExp( pseudos ),
- ridentifier = new RegExp( "^" + identifier + "$" ),
-
- matchExpr = {
- "ID": new RegExp( "^#(" + identifier + ")" ),
- "CLASS": new RegExp( "^\\.(" + identifier + ")" ),
- "TAG": new RegExp( "^(" + identifier + "|[*])" ),
- "ATTR": new RegExp( "^" + attributes ),
- "PSEUDO": new RegExp( "^" + pseudos ),
- "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace +
- "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace +
- "*(\\d+)|))" + whitespace + "*\\)|)", "i" ),
- "bool": new RegExp( "^(?:" + booleans + ")$", "i" ),
- // For use in libraries implementing .is()
- // We use this for POS matching in `select`
- "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" +
- whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" )
- },
-
- rinputs = /^(?:input|select|textarea|button)$/i,
- rheader = /^h\d$/i,
-
- rnative = /^[^{]+\{\s*\[native \w/,
-
- // Easily-parseable/retrievable ID or TAG or CLASS selectors
- rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,
-
- rsibling = /[+~]/,
-
- // CSS escapes
- // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters
- runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ),
- funescape = function( _, escaped, escapedWhitespace ) {
- var high = "0x" + escaped - 0x10000;
- // NaN means non-codepoint
- // Support: Firefox<24
- // Workaround erroneous numeric interpretation of +"0x"
- return high !== high || escapedWhitespace ?
- escaped :
- high < 0 ?
- // BMP codepoint
- String.fromCharCode( high + 0x10000 ) :
- // Supplemental Plane codepoint (surrogate pair)
- String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );
- },
-
- // CSS string/identifier serialization
- // https://drafts.csswg.org/cssom/#common-serializing-idioms
- rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\x80-\uFFFF\w-]/g,
- fcssescape = function( ch, asCodePoint ) {
- if ( asCodePoint ) {
-
- // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER
- if ( ch === "\0" ) {
- return "\uFFFD";
- }
-
- // Control characters and (dependent upon position) numbers get escaped as code points
- return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " ";
- }
-
- // Other potentially-special ASCII characters get backslash-escaped
- return "\\" + ch;
- },
-
- // Used for iframes
- // See setDocument()
- // Removing the function wrapper causes a "Permission Denied"
- // error in IE
- unloadHandler = function() {
- setDocument();
- },
-
- disabledAncestor = addCombinator(
- function( elem ) {
- return elem.disabled === true;
- },
- { dir: "parentNode", next: "legend" }
- );
-
-// Optimize for push.apply( _, NodeList )
-try {
- push.apply(
- (arr = slice.call( preferredDoc.childNodes )),
- preferredDoc.childNodes
- );
- // Support: Android<4.0
- // Detect silently failing push.apply
- arr[ preferredDoc.childNodes.length ].nodeType;
-} catch ( e ) {
- push = { apply: arr.length ?
-
- // Leverage slice if possible
- function( target, els ) {
- push_native.apply( target, slice.call(els) );
- } :
-
- // Support: IE<9
- // Otherwise append directly
- function( target, els ) {
- var j = target.length,
- i = 0;
- // Can't trust NodeList.length
- while ( (target[j++] = els[i++]) ) {}
- target.length = j - 1;
- }
- };
-}
-
-function Sizzle( selector, context, results, seed ) {
- var m, i, elem, nid, match, groups, newSelector,
- newContext = context && context.ownerDocument,
-
- // nodeType defaults to 9, since context defaults to document
- nodeType = context ? context.nodeType : 9;
-
- results = results || [];
-
- // Return early from calls with invalid selector or context
- if ( typeof selector !== "string" || !selector ||
- nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) {
-
- return results;
- }
-
- // Try to shortcut find operations (as opposed to filters) in HTML documents
- if ( !seed ) {
-
- if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) {
- setDocument( context );
- }
- context = context || document;
-
- if ( documentIsHTML ) {
-
- // If the selector is sufficiently simple, try using a "get*By*" DOM method
- // (excepting DocumentFragment context, where the methods don't exist)
- if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) {
-
- // ID selector
- if ( (m = match[1]) ) {
-
- // Document context
- if ( nodeType === 9 ) {
- if ( (elem = context.getElementById( m )) ) {
-
- // Support: IE, Opera, Webkit
- // TODO: identify versions
- // getElementById can match elements by name instead of ID
- if ( elem.id === m ) {
- results.push( elem );
- return results;
- }
- } else {
- return results;
- }
-
- // Element context
- } else {
-
- // Support: IE, Opera, Webkit
- // TODO: identify versions
- // getElementById can match elements by name instead of ID
- if ( newContext && (elem = newContext.getElementById( m )) &&
- contains( context, elem ) &&
- elem.id === m ) {
-
- results.push( elem );
- return results;
- }
- }
-
- // Type selector
- } else if ( match[2] ) {
- push.apply( results, context.getElementsByTagName( selector ) );
- return results;
-
- // Class selector
- } else if ( (m = match[3]) && support.getElementsByClassName &&
- context.getElementsByClassName ) {
-
- push.apply( results, context.getElementsByClassName( m ) );
- return results;
- }
- }
-
- // Take advantage of querySelectorAll
- if ( support.qsa &&
- !compilerCache[ selector + " " ] &&
- (!rbuggyQSA || !rbuggyQSA.test( selector )) ) {
-
- if ( nodeType !== 1 ) {
- newContext = context;
- newSelector = selector;
-
- // qSA looks outside Element context, which is not what we want
- // Thanks to Andrew Dupont for this workaround technique
- // Support: IE <=8
- // Exclude object elements
- } else if ( context.nodeName.toLowerCase() !== "object" ) {
-
- // Capture the context ID, setting it first if necessary
- if ( (nid = context.getAttribute( "id" )) ) {
- nid = nid.replace( rcssescape, fcssescape );
- } else {
- context.setAttribute( "id", (nid = expando) );
- }
-
- // Prefix every selector in the list
- groups = tokenize( selector );
- i = groups.length;
- while ( i-- ) {
- groups[i] = "#" + nid + " " + toSelector( groups[i] );
- }
- newSelector = groups.join( "," );
-
- // Expand context for sibling selectors
- newContext = rsibling.test( selector ) && testContext( context.parentNode ) ||
- context;
- }
-
- if ( newSelector ) {
- try {
- push.apply( results,
- newContext.querySelectorAll( newSelector )
- );
- return results;
- } catch ( qsaError ) {
- } finally {
- if ( nid === expando ) {
- context.removeAttribute( "id" );
- }
- }
- }
- }
- }
- }
-
- // All others
- return select( selector.replace( rtrim, "$1" ), context, results, seed );
-}
-
-/**
- * Create key-value caches of limited size
- * @returns {function(string, object)} Returns the Object data after storing it on itself with
- * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)
- * deleting the oldest entry
- */
-function createCache() {
- var keys = [];
-
- function cache( key, value ) {
- // Use (key + " ") to avoid collision with native prototype properties (see Issue #157)
- if ( keys.push( key + " " ) > Expr.cacheLength ) {
- // Only keep the most recent entries
- delete cache[ keys.shift() ];
- }
- return (cache[ key + " " ] = value);
- }
- return cache;
-}
-
-/**
- * Mark a function for special use by Sizzle
- * @param {Function} fn The function to mark
- */
-function markFunction( fn ) {
- fn[ expando ] = true;
- return fn;
-}
-
-/**
- * Support testing using an element
- * @param {Function} fn Passed the created element and returns a boolean result
- */
-function assert( fn ) {
- var el = document.createElement("fieldset");
-
- try {
- return !!fn( el );
- } catch (e) {
- return false;
- } finally {
- // Remove from its parent by default
- if ( el.parentNode ) {
- el.parentNode.removeChild( el );
- }
- // release memory in IE
- el = null;
- }
-}
-
-/**
- * Adds the same handler for all of the specified attrs
- * @param {String} attrs Pipe-separated list of attributes
- * @param {Function} handler The method that will be applied
- */
-function addHandle( attrs, handler ) {
- var arr = attrs.split("|"),
- i = arr.length;
-
- while ( i-- ) {
- Expr.attrHandle[ arr[i] ] = handler;
- }
-}
-
-/**
- * Checks document order of two siblings
- * @param {Element} a
- * @param {Element} b
- * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b
- */
-function siblingCheck( a, b ) {
- var cur = b && a,
- diff = cur && a.nodeType === 1 && b.nodeType === 1 &&
- a.sourceIndex - b.sourceIndex;
-
- // Use IE sourceIndex if available on both nodes
- if ( diff ) {
- return diff;
- }
-
- // Check if b follows a
- if ( cur ) {
- while ( (cur = cur.nextSibling) ) {
- if ( cur === b ) {
- return -1;
- }
- }
- }
-
- return a ? 1 : -1;
-}
-
-/**
- * Returns a function to use in pseudos for input types
- * @param {String} type
- */
-function createInputPseudo( type ) {
- return function( elem ) {
- var name = elem.nodeName.toLowerCase();
- return name === "input" && elem.type === type;
- };
-}
-
-/**
- * Returns a function to use in pseudos for buttons
- * @param {String} type
- */
-function createButtonPseudo( type ) {
- return function( elem ) {
- var name = elem.nodeName.toLowerCase();
- return (name === "input" || name === "button") && elem.type === type;
- };
-}
-
-/**
- * Returns a function to use in pseudos for :enabled/:disabled
- * @param {Boolean} disabled true for :disabled; false for :enabled
- */
-function createDisabledPseudo( disabled ) {
- // Known :disabled false positives:
- // IE: *[disabled]:not(button, input, select, textarea, optgroup, option, menuitem, fieldset)
- // not IE: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable
- return function( elem ) {
-
- // Check form elements and option elements for explicit disabling
- return "label" in elem && elem.disabled === disabled ||
- "form" in elem && elem.disabled === disabled ||
-
- // Check non-disabled form elements for fieldset[disabled] ancestors
- "form" in elem && elem.disabled === false && (
- // Support: IE6-11+
- // Ancestry is covered for us
- elem.isDisabled === disabled ||
-
- // Otherwise, assume any non-<option> under fieldset[disabled] is disabled
- /* jshint -W018 */
- elem.isDisabled !== !disabled &&
- ("label" in elem || !disabledAncestor( elem )) !== disabled
- );
- };
-}
-
-/**
- * Returns a function to use in pseudos for positionals
- * @param {Function} fn
- */
-function createPositionalPseudo( fn ) {
- return markFunction(function( argument ) {
- argument = +argument;
- return markFunction(function( seed, matches ) {
- var j,
- matchIndexes = fn( [], seed.length, argument ),
- i = matchIndexes.length;
-
- // Match elements found at the specified indexes
- while ( i-- ) {
- if ( seed[ (j = matchIndexes[i]) ] ) {
- seed[j] = !(matches[j] = seed[j]);
- }
- }
- });
- });
-}
-
-/**
- * Checks a node for validity as a Sizzle context
- * @param {Element|Object=} context
- * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value
- */
-function testContext( context ) {
- return context && typeof context.getElementsByTagName !== "undefined" && context;
-}
-
-// Expose support vars for convenience
-support = Sizzle.support = {};
-
-/**
- * Detects XML nodes
- * @param {Element|Object} elem An element or a document
- * @returns {Boolean} True iff elem is a non-HTML XML node
- */
-isXML = Sizzle.isXML = function( elem ) {
- // documentElement is verified for cases where it doesn't yet exist
- // (such as loading iframes in IE - #4833)
- var documentElement = elem && (elem.ownerDocument || elem).documentElement;
- return documentElement ? documentElement.nodeName !== "HTML" : false;
-};
-
-/**
- * Sets document-related variables once based on the current document
- * @param {Element|Object} [doc] An element or document object to use to set the document
- * @returns {Object} Returns the current document
- */
-setDocument = Sizzle.setDocument = function( node ) {
- var hasCompare, subWindow,
- doc = node ? node.ownerDocument || node : preferredDoc;
-
- // Return early if doc is invalid or already selected
- if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) {
- return document;
- }
-
- // Update global variables
- document = doc;
- docElem = document.documentElement;
- documentIsHTML = !isXML( document );
-
- // Support: IE 9-11, Edge
- // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936)
- if ( preferredDoc !== document &&
- (subWindow = document.defaultView) && subWindow.top !== subWindow ) {
-
- // Support: IE 11, Edge
- if ( subWindow.addEventListener ) {
- subWindow.addEventListener( "unload", unloadHandler, false );
-
- // Support: IE 9 - 10 only
- } else if ( subWindow.attachEvent ) {
- subWindow.attachEvent( "onunload", unloadHandler );
- }
- }
-
- /* Attributes
- ---------------------------------------------------------------------- */
-
- // Support: IE<8
- // Verify that getAttribute really returns attributes and not properties
- // (excepting IE8 booleans)
- support.attributes = assert(function( el ) {
- el.className = "i";
- return !el.getAttribute("className");
- });
-
- /* getElement(s)By*
- ---------------------------------------------------------------------- */
-
- // Check if getElementsByTagName("*") returns only elements
- support.getElementsByTagName = assert(function( el ) {
- el.appendChild( document.createComment("") );
- return !el.getElementsByTagName("*").length;
- });
-
- // Support: IE<9
- support.getElementsByClassName = rnative.test( document.getElementsByClassName );
-
- // Support: IE<10
- // Check if getElementById returns elements by name
- // The broken getElementById methods don't pick up programmatically-set names,
- // so use a roundabout getElementsByName test
- support.getById = assert(function( el ) {
- docElem.appendChild( el ).id = expando;
- return !document.getElementsByName || !document.getElementsByName( expando ).length;
- });
-
- // ID find and filter
- if ( support.getById ) {
- Expr.find["ID"] = function( id, context ) {
- if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
- var m = context.getElementById( id );
- return m ? [ m ] : [];
- }
- };
- Expr.filter["ID"] = function( id ) {
- var attrId = id.replace( runescape, funescape );
- return function( elem ) {
- return elem.getAttribute("id") === attrId;
- };
- };
- } else {
- // Support: IE6/7
- // getElementById is not reliable as a find shortcut
- delete Expr.find["ID"];
-
- Expr.filter["ID"] = function( id ) {
- var attrId = id.replace( runescape, funescape );
- return function( elem ) {
- var node = typeof elem.getAttributeNode !== "undefined" &&
- elem.getAttributeNode("id");
- return node && node.value === attrId;
- };
- };
- }
-
- // Tag
- Expr.find["TAG"] = support.getElementsByTagName ?
- function( tag, context ) {
- if ( typeof context.getElementsByTagName !== "undefined" ) {
- return context.getElementsByTagName( tag );
-
- // DocumentFragment nodes don't have gEBTN
- } else if ( support.qsa ) {
- return context.querySelectorAll( tag );
- }
- } :
-
- function( tag, context ) {
- var elem,
- tmp = [],
- i = 0,
- // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too
- results = context.getElementsByTagName( tag );
-
- // Filter out possible comments
- if ( tag === "*" ) {
- while ( (elem = results[i++]) ) {
- if ( elem.nodeType === 1 ) {
- tmp.push( elem );
- }
- }
-
- return tmp;
- }
- return results;
- };
-
- // Class
- Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) {
- if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) {
- return context.getElementsByClassName( className );
- }
- };
-
- /* QSA/matchesSelector
- ---------------------------------------------------------------------- */
-
- // QSA and matchesSelector support
-
- // matchesSelector(:active) reports false when true (IE9/Opera 11.5)
- rbuggyMatches = [];
-
- // qSa(:focus) reports false when true (Chrome 21)
- // We allow this because of a bug in IE8/9 that throws an error
- // whenever `document.activeElement` is accessed on an iframe
- // So, we allow :focus to pass through QSA all the time to avoid the IE error
- // See https://bugs.jquery.com/ticket/13378
- rbuggyQSA = [];
-
- if ( (support.qsa = rnative.test( document.querySelectorAll )) ) {
- // Build QSA regex
- // Regex strategy adopted from Diego Perini
- assert(function( el ) {
- // Select is set to empty string on purpose
- // This is to test IE's treatment of not explicitly
- // setting a boolean content attribute,
- // since its presence should be enough
- // https://bugs.jquery.com/ticket/12359
- docElem.appendChild( el ).innerHTML = "<a id='" + expando + "'></a>" +
- "<select id='" + expando + "-\r\\' msallowcapture=''>" +
- "<option selected=''></option></select>";
-
- // Support: IE8, Opera 11-12.16
- // Nothing should be selected when empty strings follow ^= or $= or *=
- // The test attribute must be unknown in Opera but "safe" for WinRT
- // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section
- if ( el.querySelectorAll("[msallowcapture^='']").length ) {
- rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" );
- }
-
- // Support: IE8
- // Boolean attributes and "value" are not treated correctly
- if ( !el.querySelectorAll("[selected]").length ) {
- rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" );
- }
-
- // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+
- if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) {
- rbuggyQSA.push("~=");
- }
-
- // Webkit/Opera - :checked should return selected option elements
- // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
- // IE8 throws error here and will not see later tests
- if ( !el.querySelectorAll(":checked").length ) {
- rbuggyQSA.push(":checked");
- }
-
- // Support: Safari 8+, iOS 8+
- // https://bugs.webkit.org/show_bug.cgi?id=136851
- // In-page `selector#id sibling-combinator selector` fails
- if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) {
- rbuggyQSA.push(".#.+[+~]");
- }
- });
-
- assert(function( el ) {
- el.innerHTML = "<a href='' disabled='disabled'></a>" +
- "<select disabled='disabled'><option/></select>";
-
- // Support: Windows 8 Native Apps
- // The type and name attributes are restricted during .innerHTML assignment
- var input = document.createElement("input");
- input.setAttribute( "type", "hidden" );
- el.appendChild( input ).setAttribute( "name", "D" );
-
- // Support: IE8
- // Enforce case-sensitivity of name attribute
- if ( el.querySelectorAll("[name=d]").length ) {
- rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" );
- }
-
- // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled)
- // IE8 throws error here and will not see later tests
- if ( el.querySelectorAll(":enabled").length !== 2 ) {
- rbuggyQSA.push( ":enabled", ":disabled" );
- }
-
- // Support: IE9-11+
- // IE's :disabled selector does not pick up the children of disabled fieldsets
- docElem.appendChild( el ).disabled = true;
- if ( el.querySelectorAll(":disabled").length !== 2 ) {
- rbuggyQSA.push( ":enabled", ":disabled" );
- }
-
- // Opera 10-11 does not throw on post-comma invalid pseudos
- el.querySelectorAll("*,:x");
- rbuggyQSA.push(",.*:");
- });
- }
-
- if ( (support.matchesSelector = rnative.test( (matches = docElem.matches ||
- docElem.webkitMatchesSelector ||
- docElem.mozMatchesSelector ||
- docElem.oMatchesSelector ||
- docElem.msMatchesSelector) )) ) {
-
- assert(function( el ) {
- // Check to see if it's possible to do matchesSelector
- // on a disconnected node (IE 9)
- support.disconnectedMatch = matches.call( el, "*" );
-
- // This should fail with an exception
- // Gecko does not error, returns false instead
- matches.call( el, "[s!='']:x" );
- rbuggyMatches.push( "!=", pseudos );
- });
- }
-
- rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") );
- rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") );
-
- /* Contains
- ---------------------------------------------------------------------- */
- hasCompare = rnative.test( docElem.compareDocumentPosition );
-
- // Element contains another
- // Purposefully self-exclusive
- // As in, an element does not contain itself
- contains = hasCompare || rnative.test( docElem.contains ) ?
- function( a, b ) {
- var adown = a.nodeType === 9 ? a.documentElement : a,
- bup = b && b.parentNode;
- return a === bup || !!( bup && bup.nodeType === 1 && (
- adown.contains ?
- adown.contains( bup ) :
- a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16
- ));
- } :
- function( a, b ) {
- if ( b ) {
- while ( (b = b.parentNode) ) {
- if ( b === a ) {
- return true;
- }
- }
- }
- return false;
- };
-
- /* Sorting
- ---------------------------------------------------------------------- */
-
- // Document order sorting
- sortOrder = hasCompare ?
- function( a, b ) {
-
- // Flag for duplicate removal
- if ( a === b ) {
- hasDuplicate = true;
- return 0;
- }
-
- // Sort on method existence if only one input has compareDocumentPosition
- var compare = !a.compareDocumentPosition - !b.compareDocumentPosition;
- if ( compare ) {
- return compare;
- }
-
- // Calculate position if both inputs belong to the same document
- compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ?
- a.compareDocumentPosition( b ) :
-
- // Otherwise we know they are disconnected
- 1;
-
- // Disconnected nodes
- if ( compare & 1 ||
- (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) {
-
- // Choose the first element that is related to our preferred document
- if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) {
- return -1;
- }
- if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) {
- return 1;
- }
-
- // Maintain original order
- return sortInput ?
- ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
- 0;
- }
-
- return compare & 4 ? -1 : 1;
- } :
- function( a, b ) {
- // Exit early if the nodes are identical
- if ( a === b ) {
- hasDuplicate = true;
- return 0;
- }
-
- var cur,
- i = 0,
- aup = a.parentNode,
- bup = b.parentNode,
- ap = [ a ],
- bp = [ b ];
-
- // Parentless nodes are either documents or disconnected
- if ( !aup || !bup ) {
- return a === document ? -1 :
- b === document ? 1 :
- aup ? -1 :
- bup ? 1 :
- sortInput ?
- ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) :
- 0;
-
- // If the nodes are siblings, we can do a quick check
- } else if ( aup === bup ) {
- return siblingCheck( a, b );
- }
-
- // Otherwise we need full lists of their ancestors for comparison
- cur = a;
- while ( (cur = cur.parentNode) ) {
- ap.unshift( cur );
- }
- cur = b;
- while ( (cur = cur.parentNode) ) {
- bp.unshift( cur );
- }
-
- // Walk down the tree looking for a discrepancy
- while ( ap[i] === bp[i] ) {
- i++;
- }
-
- return i ?
- // Do a sibling check if the nodes have a common ancestor
- siblingCheck( ap[i], bp[i] ) :
-
- // Otherwise nodes in our document sort first
- ap[i] === preferredDoc ? -1 :
- bp[i] === preferredDoc ? 1 :
- 0;
- };
-
- return document;
-};
-
-Sizzle.matches = function( expr, elements ) {
- return Sizzle( expr, null, null, elements );
-};
-
-Sizzle.matchesSelector = function( elem, expr ) {
- // Set document vars if needed
- if ( ( elem.ownerDocument || elem ) !== document ) {
- setDocument( elem );
- }
-
- // Make sure that attribute selectors are quoted
- expr = expr.replace( rattributeQuotes, "='$1']" );
-
- if ( support.matchesSelector && documentIsHTML &&
- !compilerCache[ expr + " " ] &&
- ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) &&
- ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) {
-
- try {
- var ret = matches.call( elem, expr );
-
- // IE 9's matchesSelector returns false on disconnected nodes
- if ( ret || support.disconnectedMatch ||
- // As well, disconnected nodes are said to be in a document
- // fragment in IE 9
- elem.document && elem.document.nodeType !== 11 ) {
- return ret;
- }
- } catch (e) {}
- }
-
- return Sizzle( expr, document, null, [ elem ] ).length > 0;
-};
-
-Sizzle.contains = function( context, elem ) {
- // Set document vars if needed
- if ( ( context.ownerDocument || context ) !== document ) {
- setDocument( context );
- }
- return contains( context, elem );
-};
-
-Sizzle.attr = function( elem, name ) {
- // Set document vars if needed
- if ( ( elem.ownerDocument || elem ) !== document ) {
- setDocument( elem );
- }
-
- var fn = Expr.attrHandle[ name.toLowerCase() ],
- // Don't get fooled by Object.prototype properties (jQuery #13807)
- val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ?
- fn( elem, name, !documentIsHTML ) :
- undefined;
-
- return val !== undefined ?
- val :
- support.attributes || !documentIsHTML ?
- elem.getAttribute( name ) :
- (val = elem.getAttributeNode(name)) && val.specified ?
- val.value :
- null;
-};
-
-Sizzle.escape = function( sel ) {
- return (sel + "").replace( rcssescape, fcssescape );
-};
-
-Sizzle.error = function( msg ) {
- throw new Error( "Syntax error, unrecognized expression: " + msg );
-};
-
-/**
- * Document sorting and removing duplicates
- * @param {ArrayLike} results
- */
-Sizzle.uniqueSort = function( results ) {
- var elem,
- duplicates = [],
- j = 0,
- i = 0;
-
- // Unless we *know* we can detect duplicates, assume their presence
- hasDuplicate = !support.detectDuplicates;
- sortInput = !support.sortStable && results.slice( 0 );
- results.sort( sortOrder );
-
- if ( hasDuplicate ) {
- while ( (elem = results[i++]) ) {
- if ( elem === results[ i ] ) {
- j = duplicates.push( i );
- }
- }
- while ( j-- ) {
- results.splice( duplicates[ j ], 1 );
- }
- }
-
- // Clear input after sorting to release objects
- // See https://github.com/jquery/sizzle/pull/225
- sortInput = null;
-
- return results;
-};
-
-/**
- * Utility function for retrieving the text value of an array of DOM nodes
- * @param {Array|Element} elem
- */
-getText = Sizzle.getText = function( elem ) {
- var node,
- ret = "",
- i = 0,
- nodeType = elem.nodeType;
-
- if ( !nodeType ) {
- // If no nodeType, this is expected to be an array
- while ( (node = elem[i++]) ) {
- // Do not traverse comment nodes
- ret += getText( node );
- }
- } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) {
- // Use textContent for elements
- // innerText usage removed for consistency of new lines (jQuery #11153)
- if ( typeof elem.textContent === "string" ) {
- return elem.textContent;
- } else {
- // Traverse its children
- for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
- ret += getText( elem );
- }
- }
- } else if ( nodeType === 3 || nodeType === 4 ) {
- return elem.nodeValue;
- }
- // Do not include comment or processing instruction nodes
-
- return ret;
-};
-
-Expr = Sizzle.selectors = {
-
- // Can be adjusted by the user
- cacheLength: 50,
-
- createPseudo: markFunction,
-
- match: matchExpr,
-
- attrHandle: {},
-
- find: {},
-
- relative: {
- ">": { dir: "parentNode", first: true },
- " ": { dir: "parentNode" },
- "+": { dir: "previousSibling", first: true },
- "~": { dir: "previousSibling" }
- },
-
- preFilter: {
- "ATTR": function( match ) {
- match[1] = match[1].replace( runescape, funescape );
-
- // Move the given value to match[3] whether quoted or unquoted
- match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape );
-
- if ( match[2] === "~=" ) {
- match[3] = " " + match[3] + " ";
- }
-
- return match.slice( 0, 4 );
- },
-
- "CHILD": function( match ) {
- /* matches from matchExpr["CHILD"]
- 1 type (only|nth|...)
- 2 what (child|of-type)
- 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...)
- 4 xn-component of xn+y argument ([+-]?\d*n|)
- 5 sign of xn-component
- 6 x of xn-component
- 7 sign of y-component
- 8 y of y-component
- */
- match[1] = match[1].toLowerCase();
-
- if ( match[1].slice( 0, 3 ) === "nth" ) {
- // nth-* requires argument
- if ( !match[3] ) {
- Sizzle.error( match[0] );
- }
-
- // numeric x and y parameters for Expr.filter.CHILD
- // remember that false/true cast respectively to 0/1
- match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) );
- match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" );
-
- // other types prohibit arguments
- } else if ( match[3] ) {
- Sizzle.error( match[0] );
- }
-
- return match;
- },
-
- "PSEUDO": function( match ) {
- var excess,
- unquoted = !match[6] && match[2];
-
- if ( matchExpr["CHILD"].test( match[0] ) ) {
- return null;
- }
-
- // Accept quoted arguments as-is
- if ( match[3] ) {
- match[2] = match[4] || match[5] || "";
-
- // Strip excess characters from unquoted arguments
- } else if ( unquoted && rpseudo.test( unquoted ) &&
- // Get excess from tokenize (recursively)
- (excess = tokenize( unquoted, true )) &&
- // advance to the next closing parenthesis
- (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) {
-
- // excess is a negative index
- match[0] = match[0].slice( 0, excess );
- match[2] = unquoted.slice( 0, excess );
- }
-
- // Return only captures needed by the pseudo filter method (type and argument)
- return match.slice( 0, 3 );
- }
- },
-
- filter: {
-
- "TAG": function( nodeNameSelector ) {
- var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase();
- return nodeNameSelector === "*" ?
- function() { return true; } :
- function( elem ) {
- return elem.nodeName && elem.nodeName.toLowerCase() === nodeName;
- };
- },
-
- "CLASS": function( className ) {
- var pattern = classCache[ className + " " ];
-
- return pattern ||
- (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) &&
- classCache( className, function( elem ) {
- return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" );
- });
- },
-
- "ATTR": function( name, operator, check ) {
- return function( elem ) {
- var result = Sizzle.attr( elem, name );
-
- if ( result == null ) {
- return operator === "!=";
- }
- if ( !operator ) {
- return true;
- }
-
- result += "";
-
- return operator === "=" ? result === check :
- operator === "!=" ? result !== check :
- operator === "^=" ? check && result.indexOf( check ) === 0 :
- operator === "*=" ? check && result.indexOf( check ) > -1 :
- operator === "$=" ? check && result.slice( -check.length ) === check :
- operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 :
- operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" :
- false;
- };
- },
-
- "CHILD": function( type, what, argument, first, last ) {
- var simple = type.slice( 0, 3 ) !== "nth",
- forward = type.slice( -4 ) !== "last",
- ofType = what === "of-type";
-
- return first === 1 && last === 0 ?
-
- // Shortcut for :nth-*(n)
- function( elem ) {
- return !!elem.parentNode;
- } :
-
- function( elem, context, xml ) {
- var cache, uniqueCache, outerCache, node, nodeIndex, start,
- dir = simple !== forward ? "nextSibling" : "previousSibling",
- parent = elem.parentNode,
- name = ofType && elem.nodeName.toLowerCase(),
- useCache = !xml && !ofType,
- diff = false;
-
- if ( parent ) {
-
- // :(first|last|only)-(child|of-type)
- if ( simple ) {
- while ( dir ) {
- node = elem;
- while ( (node = node[ dir ]) ) {
- if ( ofType ?
- node.nodeName.toLowerCase() === name :
- node.nodeType === 1 ) {
-
- return false;
- }
- }
- // Reverse direction for :only-* (if we haven't yet done so)
- start = dir = type === "only" && !start && "nextSibling";
- }
- return true;
- }
-
- start = [ forward ? parent.firstChild : parent.lastChild ];
-
- // non-xml :nth-child(...) stores cache data on `parent`
- if ( forward && useCache ) {
-
- // Seek `elem` from a previously-cached index
-
- // ...in a gzip-friendly way
- node = parent;
- outerCache = node[ expando ] || (node[ expando ] = {});
-
- // Support: IE <9 only
- // Defend against cloned attroperties (jQuery gh-1709)
- uniqueCache = outerCache[ node.uniqueID ] ||
- (outerCache[ node.uniqueID ] = {});
-
- cache = uniqueCache[ type ] || [];
- nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
- diff = nodeIndex && cache[ 2 ];
- node = nodeIndex && parent.childNodes[ nodeIndex ];
-
- while ( (node = ++nodeIndex && node && node[ dir ] ||
-
- // Fallback to seeking `elem` from the start
- (diff = nodeIndex = 0) || start.pop()) ) {
-
- // When found, cache indexes on `parent` and break
- if ( node.nodeType === 1 && ++diff && node === elem ) {
- uniqueCache[ type ] = [ dirruns, nodeIndex, diff ];
- break;
- }
- }
-
- } else {
- // Use previously-cached element index if available
- if ( useCache ) {
- // ...in a gzip-friendly way
- node = elem;
- outerCache = node[ expando ] || (node[ expando ] = {});
-
- // Support: IE <9 only
- // Defend against cloned attroperties (jQuery gh-1709)
- uniqueCache = outerCache[ node.uniqueID ] ||
- (outerCache[ node.uniqueID ] = {});
-
- cache = uniqueCache[ type ] || [];
- nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ];
- diff = nodeIndex;
- }
-
- // xml :nth-child(...)
- // or :nth-last-child(...) or :nth(-last)?-of-type(...)
- if ( diff === false ) {
- // Use the same loop as above to seek `elem` from the start
- while ( (node = ++nodeIndex && node && node[ dir ] ||
- (diff = nodeIndex = 0) || start.pop()) ) {
-
- if ( ( ofType ?
- node.nodeName.toLowerCase() === name :
- node.nodeType === 1 ) &&
- ++diff ) {
-
- // Cache the index of each encountered element
- if ( useCache ) {
- outerCache = node[ expando ] || (node[ expando ] = {});
-
- // Support: IE <9 only
- // Defend against cloned attroperties (jQuery gh-1709)
- uniqueCache = outerCache[ node.uniqueID ] ||
- (outerCache[ node.uniqueID ] = {});
-
- uniqueCache[ type ] = [ dirruns, diff ];
- }
-
- if ( node === elem ) {
- break;
- }
- }
- }
- }
- }
-
- // Incorporate the offset, then check against cycle size
- diff -= last;
- return diff === first || ( diff % first === 0 && diff / first >= 0 );
- }
- };
- },
-
- "PSEUDO": function( pseudo, argument ) {
- // pseudo-class names are case-insensitive
- // http://www.w3.org/TR/selectors/#pseudo-classes
- // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters
- // Remember that setFilters inherits from pseudos
- var args,
- fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] ||
- Sizzle.error( "unsupported pseudo: " + pseudo );
-
- // The user may use createPseudo to indicate that
- // arguments are needed to create the filter function
- // just as Sizzle does
- if ( fn[ expando ] ) {
- return fn( argument );
- }
-
- // But maintain support for old signatures
- if ( fn.length > 1 ) {
- args = [ pseudo, pseudo, "", argument ];
- return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ?
- markFunction(function( seed, matches ) {
- var idx,
- matched = fn( seed, argument ),
- i = matched.length;
- while ( i-- ) {
- idx = indexOf( seed, matched[i] );
- seed[ idx ] = !( matches[ idx ] = matched[i] );
- }
- }) :
- function( elem ) {
- return fn( elem, 0, args );
- };
- }
-
- return fn;
- }
- },
-
- pseudos: {
- // Potentially complex pseudos
- "not": markFunction(function( selector ) {
- // Trim the selector passed to compile
- // to avoid treating leading and trailing
- // spaces as combinators
- var input = [],
- results = [],
- matcher = compile( selector.replace( rtrim, "$1" ) );
-
- return matcher[ expando ] ?
- markFunction(function( seed, matches, context, xml ) {
- var elem,
- unmatched = matcher( seed, null, xml, [] ),
- i = seed.length;
-
- // Match elements unmatched by `matcher`
- while ( i-- ) {
- if ( (elem = unmatched[i]) ) {
- seed[i] = !(matches[i] = elem);
- }
- }
- }) :
- function( elem, context, xml ) {
- input[0] = elem;
- matcher( input, null, xml, results );
- // Don't keep the element (issue #299)
- input[0] = null;
- return !results.pop();
- };
- }),
-
- "has": markFunction(function( selector ) {
- return function( elem ) {
- return Sizzle( selector, elem ).length > 0;
- };
- }),
-
- "contains": markFunction(function( text ) {
- text = text.replace( runescape, funescape );
- return function( elem ) {
- return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1;
- };
- }),
-
- // "Whether an element is represented by a :lang() selector
- // is based solely on the element's language value
- // being equal to the identifier C,
- // or beginning with the identifier C immediately followed by "-".
- // The matching of C against the element's language value is performed case-insensitively.
- // The identifier C does not have to be a valid language name."
- // http://www.w3.org/TR/selectors/#lang-pseudo
- "lang": markFunction( function( lang ) {
- // lang value must be a valid identifier
- if ( !ridentifier.test(lang || "") ) {
- Sizzle.error( "unsupported lang: " + lang );
- }
- lang = lang.replace( runescape, funescape ).toLowerCase();
- return function( elem ) {
- var elemLang;
- do {
- if ( (elemLang = documentIsHTML ?
- elem.lang :
- elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) {
-
- elemLang = elemLang.toLowerCase();
- return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0;
- }
- } while ( (elem = elem.parentNode) && elem.nodeType === 1 );
- return false;
- };
- }),
-
- // Miscellaneous
- "target": function( elem ) {
- var hash = window.location && window.location.hash;
- return hash && hash.slice( 1 ) === elem.id;
- },
-
- "root": function( elem ) {
- return elem === docElem;
- },
-
- "focus": function( elem ) {
- return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex);
- },
-
- // Boolean properties
- "enabled": createDisabledPseudo( false ),
- "disabled": createDisabledPseudo( true ),
-
- "checked": function( elem ) {
- // In CSS3, :checked should return both checked and selected elements
- // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
- var nodeName = elem.nodeName.toLowerCase();
- return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected);
- },
-
- "selected": function( elem ) {
- // Accessing this property makes selected-by-default
- // options in Safari work properly
- if ( elem.parentNode ) {
- elem.parentNode.selectedIndex;
- }
-
- return elem.selected === true;
- },
-
- // Contents
- "empty": function( elem ) {
- // http://www.w3.org/TR/selectors/#empty-pseudo
- // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5),
- // but not by others (comment: 8; processing instruction: 7; etc.)
- // nodeType < 6 works because attributes (2) do not appear as children
- for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
- if ( elem.nodeType < 6 ) {
- return false;
- }
- }
- return true;
- },
-
- "parent": function( elem ) {
- return !Expr.pseudos["empty"]( elem );
- },
-
- // Element/input types
- "header": function( elem ) {
- return rheader.test( elem.nodeName );
- },
-
- "input": function( elem ) {
- return rinputs.test( elem.nodeName );
- },
-
- "button": function( elem ) {
- var name = elem.nodeName.toLowerCase();
- return name === "input" && elem.type === "button" || name === "button";
- },
-
- "text": function( elem ) {
- var attr;
- return elem.nodeName.toLowerCase() === "input" &&
- elem.type === "text" &&
-
- // Support: IE<8
- // New HTML5 attribute values (e.g., "search") appear with elem.type === "text"
- ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" );
- },
-
- // Position-in-collection
- "first": createPositionalPseudo(function() {
- return [ 0 ];
- }),
-
- "last": createPositionalPseudo(function( matchIndexes, length ) {
- return [ length - 1 ];
- }),
-
- "eq": createPositionalPseudo(function( matchIndexes, length, argument ) {
- return [ argument < 0 ? argument + length : argument ];
- }),
-
- "even": createPositionalPseudo(function( matchIndexes, length ) {
- var i = 0;
- for ( ; i < length; i += 2 ) {
- matchIndexes.push( i );
- }
- return matchIndexes;
- }),
-
- "odd": createPositionalPseudo(function( matchIndexes, length ) {
- var i = 1;
- for ( ; i < length; i += 2 ) {
- matchIndexes.push( i );
- }
- return matchIndexes;
- }),
-
- "lt": createPositionalPseudo(function( matchIndexes, length, argument ) {
- var i = argument < 0 ? argument + length : argument;
- for ( ; --i >= 0; ) {
- matchIndexes.push( i );
- }
- return matchIndexes;
- }),
-
- "gt": createPositionalPseudo(function( matchIndexes, length, argument ) {
- var i = argument < 0 ? argument + length : argument;
- for ( ; ++i < length; ) {
- matchIndexes.push( i );
- }
- return matchIndexes;
- })
- }
-};
-
-Expr.pseudos["nth"] = Expr.pseudos["eq"];
-
-// Add button/input type pseudos
-for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) {
- Expr.pseudos[ i ] = createInputPseudo( i );
-}
-for ( i in { submit: true, reset: true } ) {
- Expr.pseudos[ i ] = createButtonPseudo( i );
-}
-
-// Easy API for creating new setFilters
-function setFilters() {}
-setFilters.prototype = Expr.filters = Expr.pseudos;
-Expr.setFilters = new setFilters();
-
-tokenize = Sizzle.tokenize = function( selector, parseOnly ) {
- var matched, match, tokens, type,
- soFar, groups, preFilters,
- cached = tokenCache[ selector + " " ];
-
- if ( cached ) {
- return parseOnly ? 0 : cached.slice( 0 );
- }
-
- soFar = selector;
- groups = [];
- preFilters = Expr.preFilter;
-
- while ( soFar ) {
-
- // Comma and first run
- if ( !matched || (match = rcomma.exec( soFar )) ) {
- if ( match ) {
- // Don't consume trailing commas as valid
- soFar = soFar.slice( match[0].length ) || soFar;
- }
- groups.push( (tokens = []) );
- }
-
- matched = false;
-
- // Combinators
- if ( (match = rcombinators.exec( soFar )) ) {
- matched = match.shift();
- tokens.push({
- value: matched,
- // Cast descendant combinators to space
- type: match[0].replace( rtrim, " " )
- });
- soFar = soFar.slice( matched.length );
- }
-
- // Filters
- for ( type in Expr.filter ) {
- if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] ||
- (match = preFilters[ type ]( match ))) ) {
- matched = match.shift();
- tokens.push({
- value: matched,
- type: type,
- matches: match
- });
- soFar = soFar.slice( matched.length );
- }
- }
-
- if ( !matched ) {
- break;
- }
- }
-
- // Return the length of the invalid excess
- // if we're just parsing
- // Otherwise, throw an error or return tokens
- return parseOnly ?
- soFar.length :
- soFar ?
- Sizzle.error( selector ) :
- // Cache the tokens
- tokenCache( selector, groups ).slice( 0 );
-};
-
-function toSelector( tokens ) {
- var i = 0,
- len = tokens.length,
- selector = "";
- for ( ; i < len; i++ ) {
- selector += tokens[i].value;
- }
- return selector;
-}
-
-function addCombinator( matcher, combinator, base ) {
- var dir = combinator.dir,
- skip = combinator.next,
- key = skip || dir,
- checkNonElements = base && key === "parentNode",
- doneName = done++;
-
- return combinator.first ?
- // Check against closest ancestor/preceding element
- function( elem, context, xml ) {
- while ( (elem = elem[ dir ]) ) {
- if ( elem.nodeType === 1 || checkNonElements ) {
- return matcher( elem, context, xml );
- }
- }
- } :
-
- // Check against all ancestor/preceding elements
- function( elem, context, xml ) {
- var oldCache, uniqueCache, outerCache,
- newCache = [ dirruns, doneName ];
-
- // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching
- if ( xml ) {
- while ( (elem = elem[ dir ]) ) {
- if ( elem.nodeType === 1 || checkNonElements ) {
- if ( matcher( elem, context, xml ) ) {
- return true;
- }
- }
- }
- } else {
- while ( (elem = elem[ dir ]) ) {
- if ( elem.nodeType === 1 || checkNonElements ) {
- outerCache = elem[ expando ] || (elem[ expando ] = {});
-
- // Support: IE <9 only
- // Defend against cloned attroperties (jQuery gh-1709)
- uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {});
-
- if ( skip && skip === elem.nodeName.toLowerCase() ) {
- elem = elem[ dir ] || elem;
- } else if ( (oldCache = uniqueCache[ key ]) &&
- oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) {
-
- // Assign to newCache so results back-propagate to previous elements
- return (newCache[ 2 ] = oldCache[ 2 ]);
- } else {
- // Reuse newcache so results back-propagate to previous elements
- uniqueCache[ key ] = newCache;
-
- // A match means we're done; a fail means we have to keep checking
- if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) {
- return true;
- }
- }
- }
- }
- }
- };
-}
-
-function elementMatcher( matchers ) {
- return matchers.length > 1 ?
- function( elem, context, xml ) {
- var i = matchers.length;
- while ( i-- ) {
- if ( !matchers[i]( elem, context, xml ) ) {
- return false;
- }
- }
- return true;
- } :
- matchers[0];
-}
-
-function multipleContexts( selector, contexts, results ) {
- var i = 0,
- len = contexts.length;
- for ( ; i < len; i++ ) {
- Sizzle( selector, contexts[i], results );
- }
- return results;
-}
-
-function condense( unmatched, map, filter, context, xml ) {
- var elem,
- newUnmatched = [],
- i = 0,
- len = unmatched.length,
- mapped = map != null;
-
- for ( ; i < len; i++ ) {
- if ( (elem = unmatched[i]) ) {
- if ( !filter || filter( elem, context, xml ) ) {
- newUnmatched.push( elem );
- if ( mapped ) {
- map.push( i );
- }
- }
- }
- }
-
- return newUnmatched;
-}
-
-function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) {
- if ( postFilter && !postFilter[ expando ] ) {
- postFilter = setMatcher( postFilter );
- }
- if ( postFinder && !postFinder[ expando ] ) {
- postFinder = setMatcher( postFinder, postSelector );
- }
- return markFunction(function( seed, results, context, xml ) {
- var temp, i, elem,
- preMap = [],
- postMap = [],
- preexisting = results.length,
-
- // Get initial elements from seed or context
- elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ),
-
- // Prefilter to get matcher input, preserving a map for seed-results synchronization
- matcherIn = preFilter && ( seed || !selector ) ?
- condense( elems, preMap, preFilter, context, xml ) :
- elems,
-
- matcherOut = matcher ?
- // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results,
- postFinder || ( seed ? preFilter : preexisting || postFilter ) ?
-
- // ...intermediate processing is necessary
- [] :
-
- // ...otherwise use results directly
- results :
- matcherIn;
-
- // Find primary matches
- if ( matcher ) {
- matcher( matcherIn, matcherOut, context, xml );
- }
-
- // Apply postFilter
- if ( postFilter ) {
- temp = condense( matcherOut, postMap );
- postFilter( temp, [], context, xml );
-
- // Un-match failing elements by moving them back to matcherIn
- i = temp.length;
- while ( i-- ) {
- if ( (elem = temp[i]) ) {
- matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem);
- }
- }
- }
-
- if ( seed ) {
- if ( postFinder || preFilter ) {
- if ( postFinder ) {
- // Get the final matcherOut by condensing this intermediate into postFinder contexts
- temp = [];
- i = matcherOut.length;
- while ( i-- ) {
- if ( (elem = matcherOut[i]) ) {
- // Restore matcherIn since elem is not yet a final match
- temp.push( (matcherIn[i] = elem) );
- }
- }
- postFinder( null, (matcherOut = []), temp, xml );
- }
-
- // Move matched elements from seed to results to keep them synchronized
- i = matcherOut.length;
- while ( i-- ) {
- if ( (elem = matcherOut[i]) &&
- (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) {
-
- seed[temp] = !(results[temp] = elem);
- }
- }
- }
-
- // Add elements to results, through postFinder if defined
- } else {
- matcherOut = condense(
- matcherOut === results ?
- matcherOut.splice( preexisting, matcherOut.length ) :
- matcherOut
- );
- if ( postFinder ) {
- postFinder( null, results, matcherOut, xml );
- } else {
- push.apply( results, matcherOut );
- }
- }
- });
-}
-
-function matcherFromTokens( tokens ) {
- var checkContext, matcher, j,
- len = tokens.length,
- leadingRelative = Expr.relative[ tokens[0].type ],
- implicitRelative = leadingRelative || Expr.relative[" "],
- i = leadingRelative ? 1 : 0,
-
- // The foundational matcher ensures that elements are reachable from top-level context(s)
- matchContext = addCombinator( function( elem ) {
- return elem === checkContext;
- }, implicitRelative, true ),
- matchAnyContext = addCombinator( function( elem ) {
- return indexOf( checkContext, elem ) > -1;
- }, implicitRelative, true ),
- matchers = [ function( elem, context, xml ) {
- var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || (
- (checkContext = context).nodeType ?
- matchContext( elem, context, xml ) :
- matchAnyContext( elem, context, xml ) );
- // Avoid hanging onto element (issue #299)
- checkContext = null;
- return ret;
- } ];
-
- for ( ; i < len; i++ ) {
- if ( (matcher = Expr.relative[ tokens[i].type ]) ) {
- matchers = [ addCombinator(elementMatcher( matchers ), matcher) ];
- } else {
- matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches );
-
- // Return special upon seeing a positional matcher
- if ( matcher[ expando ] ) {
- // Find the next relative operator (if any) for proper handling
- j = ++i;
- for ( ; j < len; j++ ) {
- if ( Expr.relative[ tokens[j].type ] ) {
- break;
- }
- }
- return setMatcher(
- i > 1 && elementMatcher( matchers ),
- i > 1 && toSelector(
- // If the preceding token was a descendant combinator, insert an implicit any-element `*`
- tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" })
- ).replace( rtrim, "$1" ),
- matcher,
- i < j && matcherFromTokens( tokens.slice( i, j ) ),
- j < len && matcherFromTokens( (tokens = tokens.slice( j )) ),
- j < len && toSelector( tokens )
- );
- }
- matchers.push( matcher );
- }
- }
-
- return elementMatcher( matchers );
-}
-
-function matcherFromGroupMatchers( elementMatchers, setMatchers ) {
- var bySet = setMatchers.length > 0,
- byElement = elementMatchers.length > 0,
- superMatcher = function( seed, context, xml, results, outermost ) {
- var elem, j, matcher,
- matchedCount = 0,
- i = "0",
- unmatched = seed && [],
- setMatched = [],
- contextBackup = outermostContext,
- // We must always have either seed elements or outermost context
- elems = seed || byElement && Expr.find["TAG"]( "*", outermost ),
- // Use integer dirruns iff this is the outermost matcher
- dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1),
- len = elems.length;
-
- if ( outermost ) {
- outermostContext = context === document || context || outermost;
- }
-
- // Add elements passing elementMatchers directly to results
- // Support: IE<9, Safari
- // Tolerate NodeList properties (IE: "length"; Safari: <number>) matching elements by id
- for ( ; i !== len && (elem = elems[i]) != null; i++ ) {
- if ( byElement && elem ) {
- j = 0;
- if ( !context && elem.ownerDocument !== document ) {
- setDocument( elem );
- xml = !documentIsHTML;
- }
- while ( (matcher = elementMatchers[j++]) ) {
- if ( matcher( elem, context || document, xml) ) {
- results.push( elem );
- break;
- }
- }
- if ( outermost ) {
- dirruns = dirrunsUnique;
- }
- }
-
- // Track unmatched elements for set filters
- if ( bySet ) {
- // They will have gone through all possible matchers
- if ( (elem = !matcher && elem) ) {
- matchedCount--;
- }
-
- // Lengthen the array for every element, matched or not
- if ( seed ) {
- unmatched.push( elem );
- }
- }
- }
-
- // `i` is now the count of elements visited above, and adding it to `matchedCount`
- // makes the latter nonnegative.
- matchedCount += i;
-
- // Apply set filters to unmatched elements
- // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount`
- // equals `i`), unless we didn't visit _any_ elements in the above loop because we have
- // no element matchers and no seed.
- // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that
- // case, which will result in a "00" `matchedCount` that differs from `i` but is also
- // numerically zero.
- if ( bySet && i !== matchedCount ) {
- j = 0;
- while ( (matcher = setMatchers[j++]) ) {
- matcher( unmatched, setMatched, context, xml );
- }
-
- if ( seed ) {
- // Reintegrate element matches to eliminate the need for sorting
- if ( matchedCount > 0 ) {
- while ( i-- ) {
- if ( !(unmatched[i] || setMatched[i]) ) {
- setMatched[i] = pop.call( results );
- }
- }
- }
-
- // Discard index placeholder values to get only actual matches
- setMatched = condense( setMatched );
- }
-
- // Add matches to results
- push.apply( results, setMatched );
-
- // Seedless set matches succeeding multiple successful matchers stipulate sorting
- if ( outermost && !seed && setMatched.length > 0 &&
- ( matchedCount + setMatchers.length ) > 1 ) {
-
- Sizzle.uniqueSort( results );
- }
- }
-
- // Override manipulation of globals by nested matchers
- if ( outermost ) {
- dirruns = dirrunsUnique;
- outermostContext = contextBackup;
- }
-
- return unmatched;
- };
-
- return bySet ?
- markFunction( superMatcher ) :
- superMatcher;
-}
-
-compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) {
- var i,
- setMatchers = [],
- elementMatchers = [],
- cached = compilerCache[ selector + " " ];
-
- if ( !cached ) {
- // Generate a function of recursive functions that can be used to check each element
- if ( !match ) {
- match = tokenize( selector );
- }
- i = match.length;
- while ( i-- ) {
- cached = matcherFromTokens( match[i] );
- if ( cached[ expando ] ) {
- setMatchers.push( cached );
- } else {
- elementMatchers.push( cached );
- }
- }
-
- // Cache the compiled function
- cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) );
-
- // Save selector and tokenization
- cached.selector = selector;
- }
- return cached;
-};
-
-/**
- * A low-level selection function that works with Sizzle's compiled
- * selector functions
- * @param {String|Function} selector A selector or a pre-compiled
- * selector function built with Sizzle.compile
- * @param {Element} context
- * @param {Array} [results]
- * @param {Array} [seed] A set of elements to match against
- */
-select = Sizzle.select = function( selector, context, results, seed ) {
- var i, tokens, token, type, find,
- compiled = typeof selector === "function" && selector,
- match = !seed && tokenize( (selector = compiled.selector || selector) );
-
- results = results || [];
-
- // Try to minimize operations if there is only one selector in the list and no seed
- // (the latter of which guarantees us context)
- if ( match.length === 1 ) {
-
- // Reduce context if the leading compound selector is an ID
- tokens = match[0] = match[0].slice( 0 );
- if ( tokens.length > 2 && (token = tokens[0]).type === "ID" &&
- support.getById && context.nodeType === 9 && documentIsHTML &&
- Expr.relative[ tokens[1].type ] ) {
-
- context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0];
- if ( !context ) {
- return results;
-
- // Precompiled matchers will still verify ancestry, so step up a level
- } else if ( compiled ) {
- context = context.parentNode;
- }
-
- selector = selector.slice( tokens.shift().value.length );
- }
-
- // Fetch a seed set for right-to-left matching
- i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length;
- while ( i-- ) {
- token = tokens[i];
-
- // Abort if we hit a combinator
- if ( Expr.relative[ (type = token.type) ] ) {
- break;
- }
- if ( (find = Expr.find[ type ]) ) {
- // Search, expanding context for leading sibling combinators
- if ( (seed = find(
- token.matches[0].replace( runescape, funescape ),
- rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context
- )) ) {
-
- // If seed is empty or no tokens remain, we can return early
- tokens.splice( i, 1 );
- selector = seed.length && toSelector( tokens );
- if ( !selector ) {
- push.apply( results, seed );
- return results;
- }
-
- break;
- }
- }
- }
- }
-
- // Compile and execute a filtering function if one is not provided
- // Provide `match` to avoid retokenization if we modified the selector above
- ( compiled || compile( selector, match ) )(
- seed,
- context,
- !documentIsHTML,
- results,
- !context || rsibling.test( selector ) && testContext( context.parentNode ) || context
- );
- return results;
-};
-
-// One-time assignments
-
-// Sort stability
-support.sortStable = expando.split("").sort( sortOrder ).join("") === expando;
-
-// Support: Chrome 14-35+
-// Always assume duplicates if they aren't passed to the comparison function
-support.detectDuplicates = !!hasDuplicate;
-
-// Initialize against the default document
-setDocument();
-
-// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27)
-// Detached nodes confoundingly follow *each other*
-support.sortDetached = assert(function( el ) {
- // Should return 1, but returns 4 (following)
- return el.compareDocumentPosition( document.createElement("fieldset") ) & 1;
-});
-
-// Support: IE<8
-// Prevent attribute/property "interpolation"
-// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx
-if ( !assert(function( el ) {
- el.innerHTML = "<a href='#'></a>";
- return el.firstChild.getAttribute("href") === "#" ;
-}) ) {
- addHandle( "type|href|height|width", function( elem, name, isXML ) {
- if ( !isXML ) {
- return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 );
- }
- });
-}
-
-// Support: IE<9
-// Use defaultValue in place of getAttribute("value")
-if ( !support.attributes || !assert(function( el ) {
- el.innerHTML = "<input/>";
- el.firstChild.setAttribute( "value", "" );
- return el.firstChild.getAttribute( "value" ) === "";
-}) ) {
- addHandle( "value", function( elem, name, isXML ) {
- if ( !isXML && elem.nodeName.toLowerCase() === "input" ) {
- return elem.defaultValue;
- }
- });
-}
-
-// Support: IE<9
-// Use getAttributeNode to fetch booleans when getAttribute lies
-if ( !assert(function( el ) {
- return el.getAttribute("disabled") == null;
-}) ) {
- addHandle( booleans, function( elem, name, isXML ) {
- var val;
- if ( !isXML ) {
- return elem[ name ] === true ? name.toLowerCase() :
- (val = elem.getAttributeNode( name )) && val.specified ?
- val.value :
- null;
- }
- });
-}
-
-return Sizzle;
-
-})( window );
-
-
-
-jQuery.find = Sizzle;
-jQuery.expr = Sizzle.selectors;
-
-// Deprecated
-jQuery.expr[ ":" ] = jQuery.expr.pseudos;
-jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort;
-jQuery.text = Sizzle.getText;
-jQuery.isXMLDoc = Sizzle.isXML;
-jQuery.contains = Sizzle.contains;
-jQuery.escapeSelector = Sizzle.escape;
-
-
-
-
-var dir = function( elem, dir, until ) {
- var matched = [],
- truncate = until !== undefined;
-
- while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) {
- if ( elem.nodeType === 1 ) {
- if ( truncate && jQuery( elem ).is( until ) ) {
- break;
- }
- matched.push( elem );
- }
- }
- return matched;
-};
-
-
-var siblings = function( n, elem ) {
- var matched = [];
-
- for ( ; n; n = n.nextSibling ) {
- if ( n.nodeType === 1 && n !== elem ) {
- matched.push( n );
- }
- }
-
- return matched;
-};
-
-
-var rneedsContext = jQuery.expr.match.needsContext;
-
-var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i );
-
-
-
-var risSimple = /^.[^:#\[\.,]*$/;
-
-// Implement the identical functionality for filter and not
-function winnow( elements, qualifier, not ) {
- if ( jQuery.isFunction( qualifier ) ) {
- return jQuery.grep( elements, function( elem, i ) {
- return !!qualifier.call( elem, i, elem ) !== not;
- } );
-
- }
-
- if ( qualifier.nodeType ) {
- return jQuery.grep( elements, function( elem ) {
- return ( elem === qualifier ) !== not;
- } );
-
- }
-
- if ( typeof qualifier === "string" ) {
- if ( risSimple.test( qualifier ) ) {
- return jQuery.filter( qualifier, elements, not );
- }
-
- qualifier = jQuery.filter( qualifier, elements );
- }
-
- return jQuery.grep( elements, function( elem ) {
- return ( indexOf.call( qualifier, elem ) > -1 ) !== not && elem.nodeType === 1;
- } );
-}
-
-jQuery.filter = function( expr, elems, not ) {
- var elem = elems[ 0 ];
-
- if ( not ) {
- expr = ":not(" + expr + ")";
- }
-
- return elems.length === 1 && elem.nodeType === 1 ?
- jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [] :
- jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) {
- return elem.nodeType === 1;
- } ) );
-};
-
-jQuery.fn.extend( {
- find: function( selector ) {
- var i, ret,
- len = this.length,
- self = this;
-
- if ( typeof selector !== "string" ) {
- return this.pushStack( jQuery( selector ).filter( function() {
- for ( i = 0; i < len; i++ ) {
- if ( jQuery.contains( self[ i ], this ) ) {
- return true;
- }
- }
- } ) );
- }
-
- ret = this.pushStack( [] );
-
- for ( i = 0; i < len; i++ ) {
- jQuery.find( selector, self[ i ], ret );
- }
-
- return len > 1 ? jQuery.uniqueSort( ret ) : ret;
- },
- filter: function( selector ) {
- return this.pushStack( winnow( this, selector || [], false ) );
- },
- not: function( selector ) {
- return this.pushStack( winnow( this, selector || [], true ) );
- },
- is: function( selector ) {
- return !!winnow(
- this,
-
- // If this is a positional/relative selector, check membership in the returned set
- // so $("p:first").is("p:last") won't return true for a doc with two "p".
- typeof selector === "string" && rneedsContext.test( selector ) ?
- jQuery( selector ) :
- selector || [],
- false
- ).length;
- }
-} );
-
-
-// Initialize a jQuery object
-
-
-// A central reference to the root jQuery(document)
-var rootjQuery,
-
- // A simple way to check for HTML strings
- // Prioritize #id over <tag> to avoid XSS via location.hash (#9521)
- // Strict HTML recognition (#11290: must start with <)
- // Shortcut simple #id case for speed
- rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,
-
- init = jQuery.fn.init = function( selector, context, root ) {
- var match, elem;
-
- // HANDLE: $(""), $(null), $(undefined), $(false)
- if ( !selector ) {
- return this;
- }
-
- // Method init() accepts an alternate rootjQuery
- // so migrate can support jQuery.sub (gh-2101)
- root = root || rootjQuery;
-
- // Handle HTML strings
- if ( typeof selector === "string" ) {
- if ( selector[ 0 ] === "<" &&
- selector[ selector.length - 1 ] === ">" &&
- selector.length >= 3 ) {
-
- // Assume that strings that start and end with <> are HTML and skip the regex check
- match = [ null, selector, null ];
-
- } else {
- match = rquickExpr.exec( selector );
- }
-
- // Match html or make sure no context is specified for #id
- if ( match && ( match[ 1 ] || !context ) ) {
-
- // HANDLE: $(html) -> $(array)
- if ( match[ 1 ] ) {
- context = context instanceof jQuery ? context[ 0 ] : context;
-
- // Option to run scripts is true for back-compat
- // Intentionally let the error be thrown if parseHTML is not present
- jQuery.merge( this, jQuery.parseHTML(
- match[ 1 ],
- context && context.nodeType ? context.ownerDocument || context : document,
- true
- ) );
-
- // HANDLE: $(html, props)
- if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) {
- for ( match in context ) {
-
- // Properties of context are called as methods if possible
- if ( jQuery.isFunction( this[ match ] ) ) {
- this[ match ]( context[ match ] );
-
- // ...and otherwise set as attributes
- } else {
- this.attr( match, context[ match ] );
- }
- }
- }
-
- return this;
-
- // HANDLE: $(#id)
- } else {
- elem = document.getElementById( match[ 2 ] );
-
- if ( elem ) {
-
- // Inject the element directly into the jQuery object
- this[ 0 ] = elem;
- this.length = 1;
- }
- return this;
- }
-
- // HANDLE: $(expr, $(...))
- } else if ( !context || context.jquery ) {
- return ( context || root ).find( selector );
-
- // HANDLE: $(expr, context)
- // (which is just equivalent to: $(context).find(expr)
- } else {
- return this.constructor( context ).find( selector );
- }
-
- // HANDLE: $(DOMElement)
- } else if ( selector.nodeType ) {
- this[ 0 ] = selector;
- this.length = 1;
- return this;
-
- // HANDLE: $(function)
- // Shortcut for document ready
- } else if ( jQuery.isFunction( selector ) ) {
- return root.ready !== undefined ?
- root.ready( selector ) :
-
- // Execute immediately if ready is not present
- selector( jQuery );
- }
-
- return jQuery.makeArray( selector, this );
- };
-
-// Give the init function the jQuery prototype for later instantiation
-init.prototype = jQuery.fn;
-
-// Initialize central reference
-rootjQuery = jQuery( document );
-
-
-var rparentsprev = /^(?:parents|prev(?:Until|All))/,
-
- // Methods guaranteed to produce a unique set when starting from a unique set
- guaranteedUnique = {
- children: true,
- contents: true,
- next: true,
- prev: true
- };
-
-jQuery.fn.extend( {
- has: function( target ) {
- var targets = jQuery( target, this ),
- l = targets.length;
-
- return this.filter( function() {
- var i = 0;
- for ( ; i < l; i++ ) {
- if ( jQuery.contains( this, targets[ i ] ) ) {
- return true;
- }
- }
- } );
- },
-
- closest: function( selectors, context ) {
- var cur,
- i = 0,
- l = this.length,
- matched = [],
- targets = typeof selectors !== "string" && jQuery( selectors );
-
- // Positional selectors never match, since there's no _selection_ context
- if ( !rneedsContext.test( selectors ) ) {
- for ( ; i < l; i++ ) {
- for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) {
-
- // Always skip document fragments
- if ( cur.nodeType < 11 && ( targets ?
- targets.index( cur ) > -1 :
-
- // Don't pass non-elements to Sizzle
- cur.nodeType === 1 &&
- jQuery.find.matchesSelector( cur, selectors ) ) ) {
-
- matched.push( cur );
- break;
- }
- }
- }
- }
-
- return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched );
- },
-
- // Determine the position of an element within the set
- index: function( elem ) {
-
- // No argument, return index in parent
- if ( !elem ) {
- return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1;
- }
-
- // Index in selector
- if ( typeof elem === "string" ) {
- return indexOf.call( jQuery( elem ), this[ 0 ] );
- }
-
- // Locate the position of the desired element
- return indexOf.call( this,
-
- // If it receives a jQuery object, the first element is used
- elem.jquery ? elem[ 0 ] : elem
- );
- },
-
- add: function( selector, context ) {
- return this.pushStack(
- jQuery.uniqueSort(
- jQuery.merge( this.get(), jQuery( selector, context ) )
- )
- );
- },
-
- addBack: function( selector ) {
- return this.add( selector == null ?
- this.prevObject : this.prevObject.filter( selector )
- );
- }
-} );
-
-function sibling( cur, dir ) {
- while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {}
- return cur;
-}
-
-jQuery.each( {
- parent: function( elem ) {
- var parent = elem.parentNode;
- return parent && parent.nodeType !== 11 ? parent : null;
- },
- parents: function( elem ) {
- return dir( elem, "parentNode" );
- },
- parentsUntil: function( elem, i, until ) {
- return dir( elem, "parentNode", until );
- },
- next: function( elem ) {
- return sibling( elem, "nextSibling" );
- },
- prev: function( elem ) {
- return sibling( elem, "previousSibling" );
- },
- nextAll: function( elem ) {
- return dir( elem, "nextSibling" );
- },
- prevAll: function( elem ) {
- return dir( elem, "previousSibling" );
- },
- nextUntil: function( elem, i, until ) {
- return dir( elem, "nextSibling", until );
- },
- prevUntil: function( elem, i, until ) {
- return dir( elem, "previousSibling", until );
- },
- siblings: function( elem ) {
- return siblings( ( elem.parentNode || {} ).firstChild, elem );
- },
- children: function( elem ) {
- return siblings( elem.firstChild );
- },
- contents: function( elem ) {
- return elem.contentDocument || jQuery.merge( [], elem.childNodes );
- }
-}, function( name, fn ) {
- jQuery.fn[ name ] = function( until, selector ) {
- var matched = jQuery.map( this, fn, until );
-
- if ( name.slice( -5 ) !== "Until" ) {
- selector = until;
<TRUNCATED>
[19/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_router.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_router.rst.txt b/docs/latest/_sources/overview/traffic_router.rst.txt
deleted file mode 100644
index f9ed1bc..0000000
--- a/docs/latest/_sources/overview/traffic_router.rst.txt
+++ /dev/null
@@ -1,108 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _reference-label-tc-tr:
-
-.. |arrow| image:: fwda.png
-
-.. index::
- Traffic Router - Overview
-
-Traffic Router
-==============
-Traffic Router's function is to send clients to the most optimal cache. Optimal in this case is based on a number of factors:
-
-* Distance between the cache and the client (not necessarily measured in meters, but quite often in layer 3 network hops). Less network distance between the client and cache yields better performance, and lower network load. Traffic Router helps clients connect to the best performing cache for their location at the lowest network cost.
-
-* Availability of caches and health / load on the caches. A common issue in Internet and television distribution scenarios is having many clients attempting to retrieve the same content at the same time. Traffic Router helps clients route around overloaded or down caches.
-
-* Availability of content on a particular cache. Reusing of content through cache HITs is the most important performance gain a CDN can offer. Traffic Router sends clients to the cache that is most likely to already have the desired content.
-
-Traffic routing options are often configured at the Delivery Service level.
-
-|
-
-
-.. _rl-ds:
-
-|arrow| Delivery Service
-------------------------
- As discussed in the basic concepts section, the EDGE caches are configured as reverse proxies, and the Traffic Control CDN looks from the outside as a very large reverse proxy. Delivery Services are often referred to a reverse proxy remap rule. In most cases, a Delivery Service is a one to one mapping to a FQDN that is used as a hostname to deliver the content. Many options and settings regarding how to optimize the content delivery, which is configurable on a Delivery Service basis. Some examples of these Delivery Service settings are:
-
- * Cache in RAM, cache on disk, or do not cache at all.
- * Use DNS or HTTP Content routing (see below).
- * Limits on transactions per second and bandwidth.
- * Protocol (http or https).
- * Token based authentication settings.
- * Header rewrite rules.
-
- Delivery Services are also for use in allowing multi-tenants to coexist in the Traffic Control CDN without interfering with each other, and to keep information about their content separated.
-
-|
-
-.. _rl-localization:
-
-|arrow| Localization
---------------------
- Traffic Router uses a JSON input file called the *coverage zone map* to determine what *cachegroup* is closest to the client. If the client IP address is not in this coverage zone map, it falls back to *geo*, using the maxmind database to find the client's location, and the geo coordinates from Traffic Ops for the cachegroup.
-
-|
-
-Traffic Router is inserted into the HTTP retrieval process by making it DNS authoritative for the domain of the CDN delivery service. In the example of the reverse proxy, the client was given the ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` url. In a Traffic Control CDN, URLs start with either ``tr.`` or ``edge.``, for HTTP or DNS content routing respectively. These names are configurable via properties files within the Traffic Router installation.
-
-|
-
-.. index::
- Content Routing
-
-.. _rl-dns-cr:
-
-|arrow| DNS Content Routing
----------------------------
- For a DNS delivery service the client receives a URL with a hostname beginning with ``edge.`` (e.g. http://edge.dsname.cdn.com/foo/bar/fun.html). When the LDNS server is resolving this ``edge.dsname.cdn.com`` hostname to an IP address, it ends at Traffic Router because it is the authoritative DNS server for ``cdn.com`` and the domains below it, and subsequently responds with a list of IP addresses from the eligible caches based on the location of the LDNS server. When responding, Traffic Router does not know the actual client IP address or the path that the client is going to request. The decision on what cache IP address (or list of cache IP addresses) to return is solely based on the location of the LDNS server and the health of the caches. The client then connects to port 80 on the cache, and sends the ``Host: edge.dsname.cdn.com`` header. The configuration of the cache includes the remap rule ``http://edge.dsname.cdn.com http://origin.dsname.com`` to map that edge name to an o
rigin hostname.
-
-|
-
-.. _rl-http-cr:
-
-|arrow| HTTP Content Routing
-----------------------------
- For an HTTP delivery service the client receives a URL with a hostname beginning with ``tr.`` (e.g. http://tr.dsname.cdn.com/foo/bar/fun.html), the LDNS server resolves this ``tr.dsname.cdn.com`` to an IP address, but in this case Traffic Router returns its own IP address. The client opens a connection to port 80 on the Traffic Router's IP address, and sends: ::
-
- GET /foo/bar/fun.html HTTP/1.1
- Host: tr.dsname.cdn.com
-
- Traffic Router uses an HTTP 302 to redirect the client to the best cache. For example: ::
-
- HTTP/1.1 302 Moved Temporarily
- Server: Apache-Coyote/1.1
- Location: http://atsec-nyc-02.dsname.cdn.com/foo/bar/fun.html
- Content-Length: 0
- Date: Tue, 13 Jan 2015 20:01:41 GMT
-
- The information Traffic Router can consider when selecting a cache in this case is much better:
-
- * The client's IP address (the other side of the socket).
- * The URL path the client is requesting, excluding query string.
- * All HTTP 1.1 headers.
-
- The client follows the redirect and performs a DNS request for the IP address for ``atsec-nyc-02.dsname.cdn.com``, and normal HTTP steps follow, except the sending of the Host: header when connected to the cache is ``Host: atsec-nyc-02.dsname.cdn``, and the configuration of the cache includes the remap rule (e.g.``http://atsec-nyc-02.dsname.cdn http://origin.dsname.com``).
-
- Traffic Router sends all requests for the same path in a delivery service to the same cache in a cache group using consistent hashing, in this case all caches in a cache group are not carrying the same content, and there is a much larger combined cache in the cache group.
-
-In many cases DNS content routing is the best possible option, especially in cases where the client is receiving small objects from the CDN like images and web pages.
-
-Traffic Router is redundant and horizontally scalable by adding more instances into the DNS hierarchy using NS records.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_router.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_router.txt b/docs/latest/_sources/overview/traffic_router.txt
new file mode 100644
index 0000000..f9ed1bc
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_router.txt
@@ -0,0 +1,108 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _reference-label-tc-tr:
+
+.. |arrow| image:: fwda.png
+
+.. index::
+ Traffic Router - Overview
+
+Traffic Router
+==============
+Traffic Router's function is to send clients to the most optimal cache. Optimal in this case is based on a number of factors:
+
+* Distance between the cache and the client (not necessarily measured in meters, but quite often in layer 3 network hops). Less network distance between the client and cache yields better performance, and lower network load. Traffic Router helps clients connect to the best performing cache for their location at the lowest network cost.
+
+* Availability of caches and health / load on the caches. A common issue in Internet and television distribution scenarios is having many clients attempting to retrieve the same content at the same time. Traffic Router helps clients route around overloaded or down caches.
+
+* Availability of content on a particular cache. Reusing of content through cache HITs is the most important performance gain a CDN can offer. Traffic Router sends clients to the cache that is most likely to already have the desired content.
+
+Traffic routing options are often configured at the Delivery Service level.
+
+|
+
+
+.. _rl-ds:
+
+|arrow| Delivery Service
+------------------------
+ As discussed in the basic concepts section, the EDGE caches are configured as reverse proxies, and the Traffic Control CDN looks from the outside as a very large reverse proxy. Delivery Services are often referred to a reverse proxy remap rule. In most cases, a Delivery Service is a one to one mapping to a FQDN that is used as a hostname to deliver the content. Many options and settings regarding how to optimize the content delivery, which is configurable on a Delivery Service basis. Some examples of these Delivery Service settings are:
+
+ * Cache in RAM, cache on disk, or do not cache at all.
+ * Use DNS or HTTP Content routing (see below).
+ * Limits on transactions per second and bandwidth.
+ * Protocol (http or https).
+ * Token based authentication settings.
+ * Header rewrite rules.
+
+ Delivery Services are also for use in allowing multi-tenants to coexist in the Traffic Control CDN without interfering with each other, and to keep information about their content separated.
+
+|
+
+.. _rl-localization:
+
+|arrow| Localization
+--------------------
+ Traffic Router uses a JSON input file called the *coverage zone map* to determine what *cachegroup* is closest to the client. If the client IP address is not in this coverage zone map, it falls back to *geo*, using the maxmind database to find the client's location, and the geo coordinates from Traffic Ops for the cachegroup.
+
+|
+
+Traffic Router is inserted into the HTTP retrieval process by making it DNS authoritative for the domain of the CDN delivery service. In the example of the reverse proxy, the client was given the ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` url. In a Traffic Control CDN, URLs start with either ``tr.`` or ``edge.``, for HTTP or DNS content routing respectively. These names are configurable via properties files within the Traffic Router installation.
+
+|
+
+.. index::
+ Content Routing
+
+.. _rl-dns-cr:
+
+|arrow| DNS Content Routing
+---------------------------
+ For a DNS delivery service the client receives a URL with a hostname beginning with ``edge.`` (e.g. http://edge.dsname.cdn.com/foo/bar/fun.html). When the LDNS server is resolving this ``edge.dsname.cdn.com`` hostname to an IP address, it ends at Traffic Router because it is the authoritative DNS server for ``cdn.com`` and the domains below it, and subsequently responds with a list of IP addresses from the eligible caches based on the location of the LDNS server. When responding, Traffic Router does not know the actual client IP address or the path that the client is going to request. The decision on what cache IP address (or list of cache IP addresses) to return is solely based on the location of the LDNS server and the health of the caches. The client then connects to port 80 on the cache, and sends the ``Host: edge.dsname.cdn.com`` header. The configuration of the cache includes the remap rule ``http://edge.dsname.cdn.com http://origin.dsname.com`` to map that edge name to an o
rigin hostname.
+
+|
+
+.. _rl-http-cr:
+
+|arrow| HTTP Content Routing
+----------------------------
+ For an HTTP delivery service the client receives a URL with a hostname beginning with ``tr.`` (e.g. http://tr.dsname.cdn.com/foo/bar/fun.html), the LDNS server resolves this ``tr.dsname.cdn.com`` to an IP address, but in this case Traffic Router returns its own IP address. The client opens a connection to port 80 on the Traffic Router's IP address, and sends: ::
+
+ GET /foo/bar/fun.html HTTP/1.1
+ Host: tr.dsname.cdn.com
+
+ Traffic Router uses an HTTP 302 to redirect the client to the best cache. For example: ::
+
+ HTTP/1.1 302 Moved Temporarily
+ Server: Apache-Coyote/1.1
+ Location: http://atsec-nyc-02.dsname.cdn.com/foo/bar/fun.html
+ Content-Length: 0
+ Date: Tue, 13 Jan 2015 20:01:41 GMT
+
+ The information Traffic Router can consider when selecting a cache in this case is much better:
+
+ * The client's IP address (the other side of the socket).
+ * The URL path the client is requesting, excluding query string.
+ * All HTTP 1.1 headers.
+
+ The client follows the redirect and performs a DNS request for the IP address for ``atsec-nyc-02.dsname.cdn.com``, and normal HTTP steps follow, except the sending of the Host: header when connected to the cache is ``Host: atsec-nyc-02.dsname.cdn``, and the configuration of the cache includes the remap rule (e.g.``http://atsec-nyc-02.dsname.cdn http://origin.dsname.com``).
+
+ Traffic Router sends all requests for the same path in a delivery service to the same cache in a cache group using consistent hashing, in this case all caches in a cache group are not carrying the same content, and there is a much larger combined cache in the cache group.
+
+In many cases DNS content routing is the best possible option, especially in cases where the client is receiving small objects from the CDN like images and web pages.
+
+Traffic Router is redundant and horizontally scalable by adding more instances into the DNS hierarchy using NS records.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_server.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_server.rst.txt b/docs/latest/_sources/overview/traffic_server.rst.txt
deleted file mode 100644
index 4928e4e..0000000
--- a/docs/latest/_sources/overview/traffic_server.rst.txt
+++ /dev/null
@@ -1,49 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Traffic Server
-==============
-The caches in a Traffic Control CDN are servers running the Apache Traffic Server software. See `ATS documentation <http://trafficserver.readthedocs.org/en/latest/>`_ for more information. Caches in a Traffic Control CDN are deployed in cache groups.
-
-.. |arrow| image:: fwda.png
-
-.. _rl-cachegroup:
-
-|arrow| Cache Group
--------------------
- A cache group is a logical group of caches that Traffic Router tries to use as a combined cache. Traffic Router treats all servers in a cache group as though they are in the same physical location, though they are in fact only in the same region (network). A cache group has one single set of geographical coordinates even if the caches that make up the cache group are in different physical locations. The caches in a cache group are not aware of the other caches in the group - there is no clustering software or communications between caches in a cache group.
-
- There are two types of cache groups: EDGE and MID. Traffic Control is a two tier system, where the clients get directed to the EDGE cache group. On cache miss, the cache in the EDGE cache group obtains content from a MID cache group, rather than the origin, which is shared with multiple EDGEs. EDGE cache groups are configured to have one single parent cache group.
-
- .. Note:: Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance.
-
- A cache group serves a particular part of the network as defined in the coverage zone file. See :ref:`rl-asn-czf`.
-
- Consider the example CDN below:
-
- .. image:: cache_groups_1.png
- :align: center
-
- There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent.
-
-All caches (and other servers) are assigned a Profile in Traffic Ops.
-
-
-.. _rl-profile:
-
-|arrow| Profile
----------------
- A Profile is a set of configuration settings and parameters, applied to a server. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings, and bundled into groups using Profiles. Traffic Ops allows for duplication, comparison, import and export of Profiles.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_server.txt b/docs/latest/_sources/overview/traffic_server.txt
new file mode 100644
index 0000000..4928e4e
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_server.txt
@@ -0,0 +1,49 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Traffic Server
+==============
+The caches in a Traffic Control CDN are servers running the Apache Traffic Server software. See `ATS documentation <http://trafficserver.readthedocs.org/en/latest/>`_ for more information. Caches in a Traffic Control CDN are deployed in cache groups.
+
+.. |arrow| image:: fwda.png
+
+.. _rl-cachegroup:
+
+|arrow| Cache Group
+-------------------
+ A cache group is a logical group of caches that Traffic Router tries to use as a combined cache. Traffic Router treats all servers in a cache group as though they are in the same physical location, though they are in fact only in the same region (network). A cache group has one single set of geographical coordinates even if the caches that make up the cache group are in different physical locations. The caches in a cache group are not aware of the other caches in the group - there is no clustering software or communications between caches in a cache group.
+
+ There are two types of cache groups: EDGE and MID. Traffic Control is a two tier system, where the clients get directed to the EDGE cache group. On cache miss, the cache in the EDGE cache group obtains content from a MID cache group, rather than the origin, which is shared with multiple EDGEs. EDGE cache groups are configured to have one single parent cache group.
+
+ .. Note:: Often the EDGE to MID relationship is based on network distance, and does not necessarily match the geographic distance.
+
+ A cache group serves a particular part of the network as defined in the coverage zone file. See :ref:`rl-asn-czf`.
+
+ Consider the example CDN below:
+
+ .. image:: cache_groups_1.png
+ :align: center
+
+ There are two MID tier cache groups, each assigned with three EDGEs. The lax, den and chi EDGE locations are configured with the West MID as their parent, and the nyc, phl, and hou EDGEs, are configured with the East MID as their parent. On a cache miss, the EDGEs use their assigned parent.
+
+All caches (and other servers) are assigned a Profile in Traffic Ops.
+
+
+.. _rl-profile:
+
+|arrow| Profile
+---------------
+ A Profile is a set of configuration settings and parameters, applied to a server. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings, and bundled into groups using Profiles. Traffic Ops allows for duplication, comparison, import and export of Profiles.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_stats.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_stats.rst.txt b/docs/latest/_sources/overview/traffic_stats.rst.txt
deleted file mode 100644
index 10981de..0000000
--- a/docs/latest/_sources/overview/traffic_stats.rst.txt
+++ /dev/null
@@ -1,35 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _reference-label-tc-ts:
-.. |arrow| image:: fwda.png
-
-
-Traffic Stats
-=============
-Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by `Grafana <http://grafana.org>`_ - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.
-
-Stat data is stored in three different databases:
-
- - cache_stats: The cache_stats database is used to store data gathered from edge caches. The `measurements <https://influxdb.com/docs/v0.9/concepts/glossary.html#measurement>`_ stored by cache are: bandwidth, maxKbps, and client_connections (ats.proxy.process.http.current_client_connections). Cache Data is stored with `tags <https://influxdb.com/docs/v0.9/concepts/glossary.html#tag>`_ for hostname, cachegroup, and CDN. Data can be queried using tags.
-
-
- - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
-
- - daily_stats: The daily_stats database is used to store summary data for daily activities. The stats that are currently summarized are Max Bandwidth and Bytes Served and they are stored by CDN.
-
-------------
-
-Traffic Stats does not influence overall CDN operation, but is required in order to display charts in Traffic Ops and Traffic Portal.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_stats.txt b/docs/latest/_sources/overview/traffic_stats.txt
new file mode 100644
index 0000000..10981de
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_stats.txt
@@ -0,0 +1,35 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _reference-label-tc-ts:
+.. |arrow| image:: fwda.png
+
+
+Traffic Stats
+=============
+Traffic Stats is a program written in `Golang <http://golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less). The data from InfluxDb is then used to drive graphs created by `Grafana <http://grafana.org>`_ - which are linked to from Traffic Ops - as well as provide data exposed through the Traffic Ops API. Traffic Stats performs two functions: first it gathers stat data for Edge Caches and Delivery Services at a configurable interval (10 second default) from the Traffic Monitor API's and stores the data in InfluxDb; second it summarizes all of the stats once a day (around midnight UTC) and creates a daily rollup containing the Max Gbps served and the Total Bytes served.
+
+Stat data is stored in three different databases:
+
+ - cache_stats: The cache_stats database is used to store data gathered from edge caches. The `measurements <https://influxdb.com/docs/v0.9/concepts/glossary.html#measurement>`_ stored by cache are: bandwidth, maxKbps, and client_connections (ats.proxy.process.http.current_client_connections). Cache Data is stored with `tags <https://influxdb.com/docs/v0.9/concepts/glossary.html#tag>`_ for hostname, cachegroup, and CDN. Data can be queried using tags.
+
+
+ - deliveryservice_stats: The deliveryservice_stats database is used to store data for delivery services. The measurements stored by delivery service are: kbps, status_4xx, status_5xx, tps_2xx, tps_3xx, tps_4xx, tps_5xx, and tps_total. Delivery Service stats are stored with tags for cachegroup, CDN, and Deliveryservice xml_id.
+
+ - daily_stats: The daily_stats database is used to store summary data for daily activities. The stats that are currently summarized are Max Bandwidth and Bytes Served and they are stored by CDN.
+
+------------
+
+Traffic Stats does not influence overall CDN operation, but is required in order to display charts in Traffic Ops and Traffic Portal.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_vault.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_vault.rst.txt b/docs/latest/_sources/overview/traffic_vault.rst.txt
deleted file mode 100644
index 933b86b..0000000
--- a/docs/latest/_sources/overview/traffic_vault.rst.txt
+++ /dev/null
@@ -1,36 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Traffic Vault
-=============
-
-Traffic Vault is a keystore used for storing the following types of information:
-
-* SSL Certificates
- - Private Key
- - CRT
- - CSR
-* DNSSEC Keys
- - Key Signing Key
- - private key
- - public key
- - Zone Signing Key
- - private key
- - public key
-* URL Signing Keys
-
-As the name suggests, Traffic Vault is meant to be a "vault" of private keys that only certain users are allowed to access. In order to create, add, and retrieve keys a user must have admin privileges. Keys can be created via the Traffic Ops UI, but they can only be retrieved via the Traffic Ops API. The keystore used by Traffic Vault is `Riak <http://basho.com/riak/>`_. Traffic ops accesses Riak via https on port 8088. Traffic ops uses Riak's rest API with username/password authentication. Information on the API can be found `here <http://docs.basho.com/riak/latest/dev/references/http/>`_.
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_vault.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_vault.txt b/docs/latest/_sources/overview/traffic_vault.txt
new file mode 100644
index 0000000..933b86b
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_vault.txt
@@ -0,0 +1,36 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Traffic Vault
+=============
+
+Traffic Vault is a keystore used for storing the following types of information:
+
+* SSL Certificates
+ - Private Key
+ - CRT
+ - CSR
+* DNSSEC Keys
+ - Key Signing Key
+ - private key
+ - public key
+ - Zone Signing Key
+ - private key
+ - public key
+* URL Signing Keys
+
+As the name suggests, Traffic Vault is meant to be a "vault" of private keys that only certain users are allowed to access. In order to create, add, and retrieve keys a user must have admin privileges. Keys can be created via the Traffic Ops UI, but they can only be retrieved via the Traffic Ops API. The keystore used by Traffic Vault is `Riak <http://basho.com/riak/>`_. Traffic ops accesses Riak via https on port 8088. Traffic ops uses Riak's rest API with username/password authentication. Information on the API can be found `here <http://docs.basho.com/riak/latest/dev/references/http/>`_.
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/basic.css
----------------------------------------------------------------------
diff --git a/docs/latest/_static/basic.css b/docs/latest/_static/basic.css
index 7ed0e58..9fa77d8 100644
--- a/docs/latest/_static/basic.css
+++ b/docs/latest/_static/basic.css
@@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -52,8 +52,6 @@ div.sphinxsidebar {
width: 230px;
margin-left: -100%;
font-size: 90%;
- word-wrap: break-word;
- overflow-wrap : break-word;
}
div.sphinxsidebar ul {
@@ -85,6 +83,10 @@ div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
}
+div.sphinxsidebar #searchbox input[type="submit"] {
+ width: 30px;
+}
+
img {
border: 0;
max-width: 100%;
@@ -122,8 +124,6 @@ ul.keywordmatches li.goodmatch a {
table.contentstable {
width: 90%;
- margin-left: auto;
- margin-right: auto;
}
table.contentstable p.biglink {
@@ -151,14 +151,9 @@ table.indextable td {
vertical-align: top;
}
-table.indextable ul {
+table.indextable dl, table.indextable dd {
margin-top: 0;
margin-bottom: 0;
- list-style-type: none;
-}
-
-table.indextable > tbody > tr > td > ul {
- padding-left: 0em;
}
table.indextable tr.pcap {
@@ -190,22 +185,8 @@ div.genindex-jumpbox {
padding: 0.4em;
}
-/* -- domain module index --------------------------------------------------- */
-
-table.modindextable td {
- padding: 2px;
- border-collapse: collapse;
-}
-
/* -- general body styles --------------------------------------------------- */
-div.body p, div.body dd, div.body li, div.body blockquote {
- -moz-hyphens: auto;
- -ms-hyphens: auto;
- -webkit-hyphens: auto;
- hyphens: auto;
-}
-
a.headerlink {
visibility: hidden;
}
@@ -231,6 +212,10 @@ div.body td {
text-align: left;
}
+.field-list ul {
+ padding-left: 1em;
+}
+
.first {
margin-top: 0 !important;
}
@@ -347,6 +332,10 @@ table.docutils td, table.docutils th {
border-bottom: 1px solid #aaa;
}
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
table.footnote td, table.footnote th {
border: 0 !important;
}
@@ -383,20 +372,6 @@ div.figure p.caption span.caption-number {
div.figure p.caption span.caption-text {
}
-/* -- field list styles ----------------------------------------------------- */
-
-table.field-list td, table.field-list th {
- border: 0 !important;
-}
-
-.field-list ul {
- margin: 0;
- padding-left: 1em;
-}
-
-.field-list p {
- margin: 0;
-}
/* -- other body styles ----------------------------------------------------- */
@@ -447,6 +422,15 @@ dl.glossary dt {
font-size: 1.1em;
}
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
.optional {
font-size: 1.3em;
}
@@ -505,13 +489,6 @@ pre {
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
-span.pre {
- -moz-hyphens: none;
- -ms-hyphens: none;
- -webkit-hyphens: none;
- hyphens: none;
-}
-
td.linenos pre {
padding: 5px 0px;
border: 0;
@@ -603,16 +580,6 @@ span.eqno {
float: right;
}
-span.eqno a.headerlink {
- position: relative;
- left: 0px;
- z-index: 1;
-}
-
-div.math:hover a.headerlink {
- visibility: visible;
-}
-
/* -- printout stylesheet --------------------------------------------------- */
@media print {
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/comment-bright.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/comment-bright.png b/docs/latest/_static/comment-bright.png
index 15e27ed..551517b 100644
Binary files a/docs/latest/_static/comment-bright.png and b/docs/latest/_static/comment-bright.png differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/comment-close.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/comment-close.png b/docs/latest/_static/comment-close.png
index 4d91bcf..09b54be 100644
Binary files a/docs/latest/_static/comment-close.png and b/docs/latest/_static/comment-close.png differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/comment.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/comment.png b/docs/latest/_static/comment.png
index dfbc0cb..92feb52 100644
Binary files a/docs/latest/_static/comment.png and b/docs/latest/_static/comment.png differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/doctools.js
----------------------------------------------------------------------
diff --git a/docs/latest/_static/doctools.js b/docs/latest/_static/doctools.js
index 8163495..c7bfe76 100644
--- a/docs/latest/_static/doctools.js
+++ b/docs/latest/_static/doctools.js
@@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
@@ -124,7 +124,6 @@ var Documentation = {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
-
},
/**
@@ -253,29 +252,6 @@ var Documentation = {
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
- },
-
- initOnKeyListeners: function() {
- $(document).keyup(function(event) {
- var activeElementType = document.activeElement.tagName;
- // don't navigate when in search box or textarea
- if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
- switch (event.keyCode) {
- case 37: // left
- var prevHref = $('link[rel="prev"]').prop('href');
- if (prevHref) {
- window.location.href = prevHref;
- return false;
- }
- case 39: // right
- var nextHref = $('link[rel="next"]').prop('href');
- if (nextHref) {
- window.location.href = nextHref;
- return false;
- }
- }
- }
- });
}
};
@@ -284,4 +260,4 @@ _ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
-});
\ No newline at end of file
+});
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/down-pressed.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/down-pressed.png b/docs/latest/_static/down-pressed.png
index 5756c8c..7c30d00 100644
Binary files a/docs/latest/_static/down-pressed.png and b/docs/latest/_static/down-pressed.png differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/down.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/down.png b/docs/latest/_static/down.png
index 1b3bdad..f48098a 100644
Binary files a/docs/latest/_static/down.png and b/docs/latest/_static/down.png differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/file.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/file.png b/docs/latest/_static/file.png
index a858a41..254c60b 100644
Binary files a/docs/latest/_static/file.png and b/docs/latest/_static/file.png differ
[05/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/cache_stats.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/cache_stats.html b/docs/latest/development/traffic_ops_api/v12/cache_stats.html
index debdf1b..b518f91 100644
--- a/docs/latest/development/traffic_ops_api/v12/cache_stats.html
+++ b/docs/latest/development/traffic_ops_api/v12/cache_stats.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Cache Statistics — Traffic Control 1.8.1 documentation </title>
+ <title>Cache Statistics — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="CDN" href="cdn.html"/>
<link rel="prev" title="Cache Group" href="cachegroup.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Cache Statistics</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/cache_stats.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/cache_stats.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -307,49 +304,49 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"series"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"columns"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"time"</span><span class="p">,</span>
- <span class="s2">""</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"series"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"columns"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"time"</span><span class="p">,</span>
+ <span class="s">""</span>
<span class="p">],</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">29</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"bandwidth"</span><span class="p">,</span>
- <span class="s2">"tags"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"over-the-top"</span>
+ <span class="s">"count"</span><span class="p">:</span> <span class="mi">29</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"bandwidth"</span><span class="p">,</span>
+ <span class="s">"tags"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"over-the-top"</span>
<span class="p">},</span>
- <span class="s2">"values"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"values"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
- <span class="s2">"2015-08-10T22:40:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-10T22:40:00Z"</span><span class="p">,</span>
<span class="mi">229340299720</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-10T22:41:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-10T22:41:00Z"</span><span class="p">,</span>
<span class="mf">224309221713.334</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-10T22:42:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-10T22:42:00Z"</span><span class="p">,</span>
<span class="mf">229551834168.334</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-10T22:43:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-10T22:43:00Z"</span><span class="p">,</span>
<span class="mf">225179658876.667</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-10T22:44:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-10T22:44:00Z"</span><span class="p">,</span>
<span class="mi">230443968275</span>
<span class="p">]</span>
<span class="p">]</span>
<span class="p">},</span>
- <span class="s2">"summary"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"average"</span><span class="p">:</span> <span class="mf">970410.295</span><span class="p">,</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span>
- <span class="s2">"fifthPercentile"</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span>
- <span class="s2">"max"</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span>
- <span class="s2">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span>
- <span class="s2">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">2366728.63</span>
+ <span class="s">"summary"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"average"</span><span class="p">:</span> <span class="mf">970410.295</span><span class="p">,</span>
+ <span class="s">"count"</span><span class="p">:</span> <span class="mi">1376041798</span><span class="p">,</span>
+ <span class="s">"fifthPercentile"</span><span class="p">:</span> <span class="mf">202.03</span><span class="p">,</span>
+ <span class="s">"max"</span><span class="p">:</span> <span class="mf">3875441.02</span><span class="p">,</span>
+ <span class="s">"min"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">2957940.93</span><span class="p">,</span>
+ <span class="s">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">2366728.63</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -400,7 +397,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/cachegroup.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/cachegroup.html b/docs/latest/development/traffic_ops_api/v12/cachegroup.html
index a9eaca7..0c69e41 100644
--- a/docs/latest/development/traffic_ops_api/v12/cachegroup.html
+++ b/docs/latest/development/traffic_ops_api/v12/cachegroup.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Cache Group — Traffic Control 1.8.1 documentation </title>
+ <title>Cache Group — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Cache Statistics" href="cache_stats.html"/>
<link rel="prev" title="ASN" href="asn.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Cache Group</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/cachegroup.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/cachegroup.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -262,35 +259,35 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
- <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
- <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
+ <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span><span class="p">,</span>
+ <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago-1"</span><span class="p">,</span>
- <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
- <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago-1"</span><span class="p">,</span>
+ <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span><span class="p">,</span>
+ <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -325,16 +322,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span>
- <span class="p">}</span>
- <span class="p">],</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre> {
+ "response": [
+ {
+ "name": "dc-chicago"
+ },
+ {
+ "name": "dc-cmc"
+ }
+ ],
+}
</pre></div>
</div>
</div></blockquote>
@@ -410,21 +407,21 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
- <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
- <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
+ <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span><span class="p">,</span>
+ <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -487,16 +484,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -544,23 +541,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
+ <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"380"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
+ <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"380"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
+ <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -620,15 +617,15 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -688,13 +685,13 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
- <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
- <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
- <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
- <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"EDGE_LOC"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"cg_edge"</span><span class="p">,</span>
+ <span class="s">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s">"parentCachegroup"</span><span class="p">:</span> <span class="s">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"EDGE_LOC"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -771,25 +768,25 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Cachegroup successfully created: cache_group_edge"</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Cachegroup successfully created: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
- <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
- <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
- <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
- <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
- <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
- <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
- <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
- <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
- <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">'longitude'</span> <span class="p">:</span> <span class="s">'45'</span><span class="p">,</span>
+ <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s">'shortName'</span> <span class="p">:</span> <span class="s">'cg_edge'</span><span class="p">,</span>
+ <span class="s">'name'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s">'parentCachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">'latitude'</span> <span class="p">:</span> <span class="s">'12'</span><span class="p">,</span>
+ <span class="s">'typeName'</span> <span class="p">:</span> <span class="s">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s">'id'</span> <span class="p">:</span> <span class="s">'104'</span><span class="p">,</span>
+ <span class="s">'parentCachegroupId'</span> <span class="p">:</span> <span class="s">'103'</span><span class="p">,</span>
+ <span class="s">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -868,13 +865,13 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"cg_edge"</span><span class="p">,</span>
- <span class="s2">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
- <span class="s2">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
- <span class="s2">"parentCachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_mid"</span><span class="p">,</span>
- <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"EDGE_LOC"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"cache_group_edge"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"cg_edge"</span><span class="p">,</span>
+ <span class="s">"latitude"</span><span class="p">:</span> <span class="mi">12</span><span class="p">,</span>
+ <span class="s">"longitude"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span>
+ <span class="s">"parentCachegroup"</span><span class="p">:</span> <span class="s">"cache_group_mid"</span><span class="p">,</span>
+ <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"EDGE_LOC"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -951,25 +948,25 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Cachegroup was updated: cache_group_edge"</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Cachegroup was updated: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s1">'longitude'</span> <span class="p">:</span> <span class="s1">'45'</span><span class="p">,</span>
- <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 13:55:30'</span><span class="p">,</span>
- <span class="s1">'shortName'</span> <span class="p">:</span> <span class="s1">'cg_edge'</span><span class="p">,</span>
- <span class="s1">'name'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span>
- <span class="s1">'parentCachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_mid'</span><span class="p">,</span>
- <span class="s1">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s1">'latitude'</span> <span class="p">:</span> <span class="s1">'12'</span><span class="p">,</span>
- <span class="s1">'typeName'</span> <span class="p">:</span> <span class="s1">'EDGE_LOC'</span><span class="p">,</span>
- <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'104'</span><span class="p">,</span>
- <span class="s1">'parentCachegroupId'</span> <span class="p">:</span> <span class="s1">'103'</span><span class="p">,</span>
- <span class="s1">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">'longitude'</span> <span class="p">:</span> <span class="s">'45'</span><span class="p">,</span>
+ <span class="s">'lastUpdated'</span> <span class="p">:</span> <span class="s">'2016-01-25 13:55:30'</span><span class="p">,</span>
+ <span class="s">'shortName'</span> <span class="p">:</span> <span class="s">'cg_edge'</span><span class="p">,</span>
+ <span class="s">'name'</span> <span class="p">:</span> <span class="s">'cache_group_edge'</span><span class="p">,</span>
+ <span class="s">'parentCachegroup'</span> <span class="p">:</span> <span class="s">'cache_group_mid'</span><span class="p">,</span>
+ <span class="s">'secondaryParentCachegroup'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">'latitude'</span> <span class="p">:</span> <span class="s">'12'</span><span class="p">,</span>
+ <span class="s">'typeName'</span> <span class="p">:</span> <span class="s">'EDGE_LOC'</span><span class="p">,</span>
+ <span class="s">'id'</span> <span class="p">:</span> <span class="s">'104'</span><span class="p">,</span>
+ <span class="s">'parentCachegroupId'</span> <span class="p">:</span> <span class="s">'103'</span><span class="p">,</span>
+ <span class="s">'secondaryParentCachegroupId'</span> <span class="p">:</span> <span class="n">null</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1032,11 +1029,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Cachegroup was deleted: cache_group_edge"</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Cachegroup was deleted: cache_group_edge"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1132,18 +1129,18 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cachegroupName"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
- <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"queue"</span><span class="p">,</span>
- <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s2">"atsec-chi-01"</span><span class="p">,</span>
- <span class="s2">"atsec-chi-02"</span><span class="p">,</span>
- <span class="s2">"atsec-chi-03"</span><span class="p">,</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"cachegroupName"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s">"action"</span><span class="p">:</span> <span class="s">"queue"</span><span class="p">,</span>
+ <span class="s">"serverNames"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s">"atsec-chi-01"</span><span class="p">,</span>
+ <span class="s">"atsec-chi-02"</span><span class="p">,</span>
+ <span class="s">"atsec-chi-03"</span><span class="p">,</span>
<span class="p">],</span>
- <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"93"</span><span class="p">,</span>
- <span class="s2">"cdn"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
+ <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"93"</span><span class="p">,</span>
+ <span class="s">"cdn"</span><span class="p">:</span> <span class="s">"cdn_number_1"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1198,8 +1195,8 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1248,20 +1245,20 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span>
- <span class="s2">"serverNames"</span><span class="p">:</span> <span class="p">[</span> <span class="s2">"atlanta-edge-01"</span><span class="p">,</span> <span class="s2">"atlanta-edge-07"</span> <span class="p">],</span>
- <span class="s2">"deliveryServices"</span><span class="p">:</span> <span class="p">[</span> <span class="mi">234</span><span class="p">,</span> <span class="mi">235</span> <span class="p">]</span>
- <span class="p">}</span>
- <span class="s2">"alerts"</span><span class="p">:</span>
- <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery services successfully assigned to all the servers of cache group 3."</span>
- <span class="p">}</span>
- <span class="p">],</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": {
+ "id": 3,
+ "serverNames": [ "atlanta-edge-01", "atlanta-edge-07" ],
+ "deliveryServices": [ 234, 235 ]
+ }
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Delivery services successfully assigned to all the servers of cache group 3."
+ }
+ ],
+}
</pre></div>
</div>
</div></blockquote>
@@ -1309,7 +1306,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[40/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/cdn.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/cdn.txt b/docs/latest/_sources/development/traffic_ops_api/v11/cdn.txt
new file mode 100644
index 0000000..d2f742e
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/cdn.txt
@@ -0,0 +1,1086 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-cdn-health:
+
+CDN
+===
+
+.. _to-api-v11-cdn-health-route:
+
+/api/1.1/cdns
++++++++++++++
+
+**GET /api/1.1/cdns**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "over-the-top",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/cdns/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | CDN id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/cdns/name/:name**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``name`` | yes | CDN name. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+Health
+++++++
+
+**GET /api/1.1/cdns/health**
+
+ Retrieves the health of all locations (cache groups) for all CDNs.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ },
+ }
+
+
+|
+
+**GET /api/1.1/cdns/:name/health**
+
+ Retrieves the health of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |``name`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across the |
+ | | | specified CDN. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across the |
+ | | | specified CDN. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.1/cdns/usage/overview**
+
+ Retrieves the high-level CDN usage metrics.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``currentGbps`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``tps`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ |``maxGbps`` | int | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "currentGbps": 149.368167,
+ "tps": 36805,
+ "maxGbps": 3961
+ }
+ }
+
+
+**GET /api/1.1/cdns/capacity**
+
+ Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``availablePercent`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``unavailablePercent``| number | |
+ +----------------------+--------+------------------------------------------------+
+ |``utilizedPercent`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``maintenancePercent``| number | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "availablePercent": 89.0939840205533,
+ "unavailablePercent": 0,
+ "utilizedPercent": 10.9060020300395,
+ "maintenancePercent": 0.0000139494071146245
+ }
+ }
+
+|
+
+.. _to-api-v11-cdn-routing:
+
+Routing
++++++++
+
+**GET /api/1.1/cdns/routing**
+
+ Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+-----------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+=========================================+
+ | ``staticRoute`` | number | Used pre-configured DNS entries. |
+ +-----------------+--------+-----------------------------------------+
+ | ``miss`` | number | No location available for client IP. |
+ +-----------------+--------+-----------------------------------------+
+ | ``geo`` | number | Used 3rd party geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------+
+ | ``err`` | number | Error localizing client IP. |
+ +-----------------+--------+-----------------------------------------+
+ | ``cz`` | number | Used Coverage Zone geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------+
+ | ``dsr`` | number | Overflow traffic sent to secondary CDN. |
+ +-----------------+--------+-----------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "staticRoute": 0,
+ "miss": 0,
+ "geo": 37.8855391018869,
+ "err": 0,
+ "cz": 62.1144608981131,
+ "dsr": 0
+ }
+ }
+
+|
+
+.. _to-api-v11-cdn-metrics:
+
+Metrics
++++++++
+
+**GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end**
+
+ Retrieves edge metrics of one or all locations (cache groups).
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------+
+ | Name | Required | Description |
+ +=================+==========+===========================+
+ | ``metric_type`` | yes | ooff, origin_tps |
+ +-----------------+----------+---------------------------+
+ | ``start`` | yes | UNIX time, yesterday, now |
+ +-----------------+----------+---------------------------+
+ | ``end`` | yes | UNIX time, yesterday, now |
+ +-----------------+----------+---------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=====================+========+=============+
+ | ``stats`` | hash | |
+ +---------------------+--------+-------------+
+ | ``>count`` | string | |
+ +---------------------+--------+-------------+
+ | ``>98thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>min`` | string | |
+ +---------------------+--------+-------------+
+ | ``>max`` | string | |
+ +---------------------+--------+-------------+
+ | ``>5thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>95thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>mean`` | string | |
+ +---------------------+--------+-------------+
+ | ``>sum`` | string | |
+ +---------------------+--------+-------------+
+ | ``data`` | array | |
+ +---------------------+--------+-------------+
+ | ``>time`` | int | |
+ +---------------------+--------+-------------+
+ | ``>value`` | number | |
+ +---------------------+--------+-------------+
+ | ``label`` | string | |
+ +---------------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "stats": {
+ "count": 1,
+ "98thPercentile": 1668.03,
+ "min": 1668.03,
+ "max": 1668.03,
+ "5thPercentile": 1668.03,
+ "95thPercentile": 1668.03,
+ "mean": 1668.03,
+ "sum": 1668.03
+ },
+ "data": [
+ [
+ 1425135900000,
+ 1668.03
+ ],
+ [
+ 1425136200000,
+ null
+ ]
+ ],
+ "label": "Origin TPS"
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v11-cdn-domains:
+
+Domains
++++++++
+
+**GET /api/1.1/cdns/domains**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``profileId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``parameterId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``profileName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``profileDescription``| string | |
+ +----------------------+--------+------------------------------------------------+
+ |``domainName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "profileId": "5",
+ "parameterId": "404",
+ "profileName": "CR_FOO",
+ "profileDescription": "Content Router for foo.domain.net",
+ "domainName": "foo.domain.net"
+ },
+ {
+ "profileId": "8",
+ "parameterId": "405",
+ "profileName": "CR_BAR",
+ "profileDescription": "Content Router for bar.domain.net",
+ "domainName": "bar.domain.net"
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v11-cdn-topology:
+
+Topology
+++++++++
+
+**GET /api/1.1/cdns/:cdn_name/configs**
+
+ Retrieves CDN config information based upon the provided cdn name.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +--------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==============+==========+=======================+
+ | ``cdn_name`` | yes | Your cdn name or, all |
+ +--------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +-----------------------+--------+-----------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+===============================================+
+ |``id`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``value`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``name`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``config_file`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+
+ **Response Example** ::
+
+ TBD
+
+|
+
+**GET /api/1.1/cdns/:name/configs/monitoring**
+
+ Retrieves CDN monitoring information.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | CDN name |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------------------------+--------+--------------------+
+ | Parameter | Type | Description |
+ +=================================================+========+====================+
+ | ``trafficServers`` | array | A collection of |
+ | | | Traffic Servers. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>cacheGroup`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>port`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>interfaceName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>type`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hashId`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``cacheGroups`` | array | A collection of |
+ | | | cache groups. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>coordinates`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>name`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``config`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hack.ttl`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.healthParams.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.dataServer.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.timepad`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.polling.interval`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.threadPool`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.polling.interval`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.event-count`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.crConfig.polling.url`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>CDN_name`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``trafficMonitors`` | array | A collection of |
+ | | | Traffic Monitors. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>location`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>port`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``deliveryServices`` | array | A collection of |
+ | | | delivery services. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>xmlId`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>totalTpsThreshold`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>totalKbpsThreshold`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``profiles`` | array | A collection of |
+ | | | profiles. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>parameters`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.connection.timeout`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.queryTime`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>history.count`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.availableBandwidthInKbps`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.loadavg`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>name`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>type`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+
+ **Response Example**
+ ::
+
+ TBD
+
+|
+
+**GET /api/1.1/cdns/:name/configs/routing**
+
+ Retrieves CDN routing information.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------------+---------+-----------------------------------+
+ | Parameter | Type | Description |
+ +=====================================+=========+===================================+
+ | ``trafficServers`` | array | A collection of Traffic Servers. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>cacheGroup`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>deliveryServices`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>xmlId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>remaps`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>interfaceName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>type`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hashId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``stats`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsPath`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>cdnName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsVersion`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsUser`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>date`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsHost`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``cacheGroups`` | array | A collection of cache groups. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coordinates`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>name`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``config`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.admin`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tcoveragezone.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.expire`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coveragezone.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.minimum`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>domain_name`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.AAAA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.refresh`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.NS`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.SOA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation6.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.A`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.retry`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation6.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``trafficMonitors`` | array | A collection of Traffic Monitors. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>location`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``deliveryServices`` | array | A collection of delivery |
+ | | | services. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>xmlId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ttl`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geoEnabled`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coverageZoneOnly`` | boolean | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>matchSets`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>protocol`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>matchList`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>>regex`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>>matchType`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>bypassDestination`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>maxDnsIpsForLocation`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>ttl`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>type`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ttls`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>A`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>SOA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>NS`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>AAAA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>missCoordinates`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>soa`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>admin`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>retry`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>minimum`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>refresh`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>expire`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``trafficRouters`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>location`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>apiPort`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+
+
+**Response Example**
+
+::
+ TBD
+
+
+.. _to-api-v11-cdn-dnsseckeys:
+
+DNSSEC Keys
++++++++++++
+
+**GET /api/1.1/cdns/name/:name/dnsseckeys**
+
+ Gets a list of dnsseckeys for CDN and all associated Delivery Services.
+ Before returning response to user, check to make sure keys aren't expired. If they are expired, generate new ones.
+ Before returning response to user, make sure dnssec keys for all delivery services exist. If they don't exist, create them.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +------------------------+--------+---------------------------------------------------------+
+ | Parameter | Type | Description |
+ +========================+========+=========================================================+
+ | ``cdn name/ds xml_id`` | string | identifier for ds or cdn |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>zsk/ksk`` | array | collection of zsk/ksk data |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>ttl`` | string | time-to-live for dnssec requests |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>inceptionDate`` | string | epoch timestamp for when the keys were created |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>expirationDate`` | string | epoch timestamp representing the expiration of the keys |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>private`` | string | encoded private key |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>public`` | string | encoded public key |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``>>name`` | string | domain name |
+ +------------------------+--------+---------------------------------------------------------+
+ | ``version`` | string | API version |
+ +------------------------+--------+---------------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cdn1": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750",
+ "ttl": "60"
+ }
+ },
+ "ds-01": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "ds-01.foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "ds-01.foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750"
+ }
+ },
+ ... repeated for each ds in the cdn
+ },
+ }
+
+|
+
+**GET /api/1.1/cdns/name/:name/dnsseckeys/delete**
+
+ Delete dnssec keys for a cdn and all associated delivery services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+----------------------------------------------------------+
+ | Name | Required | Description |
+ +==========+==========+==========================================================+
+ | ``name`` | yes | name of the CDN for which you want to delete dnssec keys |
+ +----------+----------+----------------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------+--------+------------------+
+ | Parameter | Type | Description |
+ +==============+========+==================+
+ | ``response`` | string | success response |
+ +--------------+--------+------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "response": "Successfully deleted dnssec keys for <cdn>"
+ }
+
+|
+
+**POST /api/1.1/deliveryservices/dnsseckeys/generate**
+
+ Generates zsk and ksk keypairs for a cdn and all associated delivery services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Properties**
+
+ +-----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+=========+================================================+
+ | ``key`` | string | name of the cdn |
+ +-----------------------+---------+------------------------------------------------+
+ | ``name`` | string | domain name of the cdn |
+ +-----------------------+---------+------------------------------------------------+
+ | ``ttl`` | string | time to live |
+ +-----------------------+---------+------------------------------------------------+
+ | ``kskExpirationDays`` | string | Expiration (in days) for the key signing keys |
+ +-----------------------+---------+------------------------------------------------+
+ | ``zskExpirationDays`` | string | Expiration (in days) for the zone signing keys |
+ +-----------------------+---------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "cdn1",
+ "name" "ott.kabletown.com",
+ "ttl": "60",
+ "kskExpirationDays": "365",
+ "zskExpirationDays": "90"
+ }
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+
+ {
+ "response": "Successfully created dnssec keys for cdn1"
+ }
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/changelog.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/changelog.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/changelog.rst.txt
deleted file mode 100644
index 22b1ff1..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/changelog.rst.txt
+++ /dev/null
@@ -1,154 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v11-change-logs:
-
-Change Logs
-===========
-
-.. _to-api-v11-change-logs-route:
-
-/api/1.1/logs
-+++++++++++++
-
-**GET /api/1.1/logs.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+==========================================================================+
- | ``ticketNum`` | string | Optional field to cross reference with any bug tracking systems |
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``level`` | string | Log categories for each entry, examples: 'UICHANGE', 'OPER', 'APICHANGE'.|
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | Local unique identifier for the Log |
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``user`` | string | Current user who made the change that was logged |
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the Log entry |
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``message`` | string | Log detail about what occurred |
- +-----------------+--------+--------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "ticketNum": null,
- "level": "OPER",
- "lastUpdated": "2015-02-04 22:59:13",
- "user": "userid852",
- "id": "22661",
- "message": "Snapshot CRConfig created."
- },
- {
- "ticketNum": null,
- "level": "APICHANGE",
- "lastUpdated": "2015-02-03 17:04:20",
- "user": "userid853",
- "id": "22658",
- "message": "Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"
- },
- ],
- }
-
-|
-
-**GET /api/1.1/logs/:days/days.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------+----------+-----------------+
- | Name | Required | Description |
- +==========+==========+=================+
- | ``days`` | yes | Number of days. |
- +----------+----------+-----------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``ticketNum`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``level`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``user`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``message`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "ticketNum": null,
- "level": "OPER",
- "lastUpdated": "2015-02-04 22:59:13",
- "user": "userid852",
- "id": "22661",
- "message": "Snapshot CRConfig created."
- },
- {
- "ticketNum": null,
- "level": "APICHANGE",
- "lastUpdated": "2015-02-03 17:04:20",
- "user": "userid853",
- "id": "22658",
- "message": "Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"
- }
- ],
- }
-
-|
-
-**GET /api/1.1/logs/newcount.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``newLogcount`` | int | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "newLogcount": 0
- }
- }
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/changelog.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/changelog.txt b/docs/latest/_sources/development/traffic_ops_api/v11/changelog.txt
new file mode 100644
index 0000000..22b1ff1
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/changelog.txt
@@ -0,0 +1,154 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v11-change-logs:
+
+Change Logs
+===========
+
+.. _to-api-v11-change-logs-route:
+
+/api/1.1/logs
++++++++++++++
+
+**GET /api/1.1/logs.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+==========================================================================+
+ | ``ticketNum`` | string | Optional field to cross reference with any bug tracking systems |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``level`` | string | Log categories for each entry, examples: 'UICHANGE', 'OPER', 'APICHANGE'.|
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | Local unique identifier for the Log |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``user`` | string | Current user who made the change that was logged |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the Log entry |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``message`` | string | Log detail about what occurred |
+ +-----------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "ticketNum": null,
+ "level": "OPER",
+ "lastUpdated": "2015-02-04 22:59:13",
+ "user": "userid852",
+ "id": "22661",
+ "message": "Snapshot CRConfig created."
+ },
+ {
+ "ticketNum": null,
+ "level": "APICHANGE",
+ "lastUpdated": "2015-02-03 17:04:20",
+ "user": "userid853",
+ "id": "22658",
+ "message": "Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"
+ },
+ ],
+ }
+
+|
+
+**GET /api/1.1/logs/:days/days.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-----------------+
+ | Name | Required | Description |
+ +==========+==========+=================+
+ | ``days`` | yes | Number of days. |
+ +----------+----------+-----------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``ticketNum`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``level`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``user`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``message`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "ticketNum": null,
+ "level": "OPER",
+ "lastUpdated": "2015-02-04 22:59:13",
+ "user": "userid852",
+ "id": "22661",
+ "message": "Snapshot CRConfig created."
+ },
+ {
+ "ticketNum": null,
+ "level": "APICHANGE",
+ "lastUpdated": "2015-02-03 17:04:20",
+ "user": "userid853",
+ "id": "22658",
+ "message": "Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/logs/newcount.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``newLogcount`` | int | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "newLogcount": 0
+ }
+ }
+
[12/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_ops_using.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_ops_using.html b/docs/latest/admin/traffic_ops_using.html
index 075b078..f56ee4c 100644
--- a/docs/latest/admin/traffic_ops_using.html
+++ b/docs/latest/admin/traffic_ops_using.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Using Traffic Ops — Traffic Control 1.8.1 documentation </title>
+ <title>Using Traffic Ops — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Managing Traffic Ops Extensions" href="traffic_ops_extensions.html"/>
<link rel="prev" title="Configuring Traffic Ops" href="traffic_ops_config.html"/>
@@ -107,7 +104,7 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Using Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Using Traffic Ops</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_ops_using.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_ops_using.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -211,16 +208,16 @@
<td>A real time view into the main performance indicators of the CDNs managed by Traffic Control.
This view is sourced directly by the Traffic Monitor data and is updated every 10 seconds.
This is the default screen of Traffic Ops.
-See <a class="reference internal" href="#rl-health-table"><span class="std std-ref">The Health Table</span></a> for details.</td>
+See <a class="reference internal" href="#rl-health-table"><em>The Health Table</em></a> for details.</td>
</tr>
<tr class="row-odd"><td>Graph View</td>
<td>A real graphical time view into the main performance indicators of the CDNs managed by Traffic Control.
This view is sourced by the Traffic Monitor data and is updated every 10 seconds.
On loading, this screen will show a history of 24 hours of data from Traffic Stats
-See <a class="reference internal" href="#rl-health-graph"><span class="std std-ref">Graph View</span></a> for details.</td>
+See <a class="reference internal" href="#rl-health-graph"><em>Graph View</em></a> for details.</td>
</tr>
<tr class="row-even"><td>Server Checks</td>
-<td>A table showing the results of the periodic check extension scripts that are run. See <a class="reference internal" href="#rl-server-checks"><span class="std std-ref">Server Checks</span></a></td>
+<td>A table showing the results of the periodic check extension scripts that are run. See <a class="reference internal" href="#rl-server-checks"><em>Server Checks</em></a></td>
</tr>
<tr class="row-odd"><td>Daily Summary</td>
<td>A graph displaying the daily peaks of bandwidth, overall bytes served per day, and overall bytes served since initial installation
@@ -262,7 +259,7 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Upload Server CSV</td>
-<td>Bulk add of servers from a csv file. See <a class="reference internal" href="#rl-bulkserver"><span class="std std-ref">Bulk Upload Server</span></a></td>
+<td>Bulk add of servers from a csv file. See <a class="reference internal" href="#rl-bulkserver"><em>Bulk Upload Server</em></a></td>
</tr>
</tbody>
</table>
@@ -281,7 +278,7 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Global Profile</td>
-<td>The table of global parameters. See <a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a>. This is where you Create/Read/Update/Delete parameters in the Global profile</td>
+<td>The table of global parameters. See <a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><em>Profile Parameters</em></a>. This is where you Create/Read/Update/Delete parameters in the Global profile</td>
</tr>
<tr class="row-odd"><td>All Cache Groups</td>
<td>The table of all parameters <em>that are assgined to a cachegroup</em> - this may be slow to pull up, as there can be thousands of parameters.</td>
@@ -312,19 +309,19 @@ per CDN.</td>
</thead>
<tbody valign="top">
<tr class="row-even"><td>Generate ISO</td>
-<td>Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See <a class="reference internal" href="#rl-generate-iso"><span class="std std-ref">Generate ISO</span></a></td>
+<td>Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See <a class="reference internal" href="#rl-generate-iso"><em>Generate ISO</em></a></td>
</tr>
<tr class="row-odd"><td>Queue Updates</td>
-<td>Send Updates to the caches. See <a class="reference internal" href="#rl-queue-updates"><span class="std std-ref">Queue Updates and Snapshot CRConfig</span></a></td>
+<td>Send Updates to the caches. See <a class="reference internal" href="#rl-queue-updates"><em>Queue Updates and Snapshot CRConfig</em></a></td>
</tr>
<tr class="row-even"><td>DB Dump</td>
<td>Backup the Database to a .sql file.</td>
</tr>
<tr class="row-odd"><td>Snapshot CRConfig</td>
-<td>Send updates to the Traffic Monitor / Traffic Router servers. See <a class="reference internal" href="#rl-queue-updates"><span class="std std-ref">Queue Updates and Snapshot CRConfig</span></a></td>
+<td>Send updates to the Traffic Monitor / Traffic Router servers. See <a class="reference internal" href="#rl-queue-updates"><em>Queue Updates and Snapshot CRConfig</em></a></td>
</tr>
<tr class="row-even"><td>Invalidate Content</td>
-<td>Invalidate or purge content from all caches in the CDN. See <a class="reference internal" href="#rl-purge"><span class="std std-ref">Invalidate Content</span></a></td>
+<td>Invalidate or purge content from all caches in the CDN. See <a class="reference internal" href="#rl-purge"><em>Invalidate Content</em></a></td>
</tr>
<tr class="row-odd"><td>Manage DNSSEC keys</td>
<td>Manage DNSSEC Keys for a chosen CDN.</td>
@@ -352,10 +349,10 @@ per CDN.</td>
<td>Create/Read/Update/Delete users</td>
</tr>
<tr class="row-even"><td>Profiles</td>
-<td>Create/Read/Update/Delete profiles. See <a class="reference internal" href="#rl-working-with-profiles"><span class="std std-ref">Parameters and Profiles</span></a></td>
+<td>Create/Read/Update/Delete profiles. See <a class="reference internal" href="#rl-working-with-profiles"><em>Parameters and Profiles</em></a></td>
</tr>
<tr class="row-odd"><td>Networks(ASNs)</td>
-<td>Create/Read/Update/Delete Autonomous System Numbers See <a class="reference internal" href="#rl-asn-czf"><span class="std std-ref">The Coverage Zone File and ASN Table</span></a></td>
+<td>Create/Read/Update/Delete Autonomous System Numbers See <a class="reference internal" href="#rl-asn-czf"><em>The Coverage Zone File and ASN Table</em></a></td>
</tr>
<tr class="row-even"><td>Hardware</td>
<td>Get detailed hardware information (note: this should be moved to a Traffic Ops Extension)</td>
@@ -557,7 +554,7 @@ must have an ssh key on the edge servers.</td>
<td>A unique string that identifies this delivery service.</td>
</tr>
<tr class="row-odd"><td>Content Routing Type</td>
-<td>The type of content routing this delivery service will use. See <a class="reference internal" href="#rl-ds-types"><span class="std std-ref">Delivery Service Types</span></a>.</td>
+<td>The type of content routing this delivery service will use. See <a class="reference internal" href="#rl-ds-types"><em>Delivery Service Types</em></a>.</td>
</tr>
<tr class="row-even"><td>Protocol</td>
<td><p class="first">The protocol to serve this delivery service to the clients with:</p>
@@ -572,7 +569,7 @@ must have an ssh key on the edge servers.</td>
<td>The DSCP value to mark IP packets to the client with.</td>
</tr>
<tr class="row-even"><td>Signed URLs</td>
-<td>Use Signed URLs? See <a class="reference internal" href="#rl-signed-urls"><span class="std std-ref">Token Based Authentication</span></a>.</td>
+<td>Use Signed URLs? See <a class="reference internal" href="#rl-signed-urls"><em>Token Based Authentication</em></a>.</td>
</tr>
<tr class="row-odd"><td>Query String Handling</td>
<td><p class="first">How to treat query strings:</p>
@@ -593,7 +590,7 @@ must have an ssh key on the edge servers.</td>
</td>
</tr>
<tr class="row-odd"><td>Geo Limit Redirect URL</td>
-<td>(for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See <span class="xref std std-ref">geolimit-failure-redirect-feature</span></td>
+<td>(for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See <em class="xref std std-ref">geolimit-failure-redirect-feature</em></td>
</tr>
<tr class="row-even"><td>Bypass FQDN</td>
<td>(for HTTP routed delivery services only) This is the FQDN Traffic Router will redirect to (with the same path) when the max Bps or Max Tps for this deliveryservice are exceeded.</td>
@@ -624,7 +621,7 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>The Origin Server’s base URL. This includes the protocol (http or https). Example: <code class="docutils literal"><span class="pre">http://movies.origin.com</span></code></td>
</tr>
<tr class="row-odd"><td>Use Multi Site Origin Feature</td>
-<td>Enable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Enable the Multi Site Origin feature for this delivery service. See <a class="reference internal" href="#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td>Multi Site Origin Algorithm</td>
<td><ul class="first last simple">
@@ -636,7 +633,7 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
</td>
</tr>
<tr class="row-odd"><td>CCR profile</td>
-<td>The Traffic Router profile for this delivery service. See <a class="reference internal" href="#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a>.</td>
+<td>The Traffic Router profile for this delivery service. See <a class="reference internal" href="#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a>.</td>
</tr>
<tr class="row-even"><td>Maximum Bits per Second allowed globally</td>
<td>The maximum bits per second this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used
@@ -653,10 +650,10 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this long.</td>
</tr>
<tr class="row-even"><td>Edge Header Rewrite Rules</td>
-<td>Header Rewrite rules to apply for this delivery service at the EDGE tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id1">[1]</a></td>
+<td>Header Rewrite rules to apply for this delivery service at the EDGE tier. See <a class="reference internal" href="#rl-header-rewrite"><em>Header Rewrite Options and DSCP</em></a>. <a class="footnote-reference" href="#id6" id="id1">[1]</a></td>
</tr>
<tr class="row-odd"><td>Mid Header Rewrite Rules</td>
-<td>Header Rewrite rules to apply for this delivery service at the MID tier. See <a class="reference internal" href="#rl-header-rewrite"><span class="std std-ref">Header Rewrite Options and DSCP</span></a>. <a class="footnote-reference" href="#id6" id="id2">[1]</a></td>
+<td>Header Rewrite rules to apply for this delivery service at the MID tier. See <a class="reference internal" href="#rl-header-rewrite"><em>Header Rewrite Options and DSCP</em></a>. <a class="footnote-reference" href="#id6" id="id2">[1]</a></td>
</tr>
<tr class="row-even"><td>Regex Remap Expression</td>
<td>Regex Remap rule to apply to this delivery service at the Edge tier. See <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html">ATS documentation on regex_remap</a>. <a class="footnote-reference" href="#id6" id="id3">[1]</a></td>
@@ -692,16 +689,16 @@ AAAA records of the edge name (<code class="docutils literal"><span class="pre">
<td>(Read Only) The last time this delivery service was updated.</td>
</tr>
<tr class="row-odd"><td>Number of edges assigned</td>
-<td>(Read Only - change by clicking the <strong>Server Assignments</strong> button at the bottom) The number of EDGE caches assigned to this delivery service. See <a class="reference internal" href="#rl-assign-edges"><span class="std std-ref">Server Assignments</span></a>.</td>
+<td>(Read Only - change by clicking the <strong>Server Assignments</strong> button at the bottom) The number of EDGE caches assigned to this delivery service. See <a class="reference internal" href="#rl-assign-edges"><em>Server Assignments</em></a>.</td>
</tr>
<tr class="row-even"><td>Number of static DNS entries</td>
-<td>(Read Only - change by clicking the <strong>Static DNS</strong> button at the bottom) The number of static DNS entries for this delivery service. See <a class="reference internal" href="#rl-static-dns"><span class="std std-ref">Static DNS Entries</span></a>.</td>
+<td>(Read Only - change by clicking the <strong>Static DNS</strong> button at the bottom) The number of static DNS entries for this delivery service. See <a class="reference internal" href="#rl-static-dns"><em>Static DNS Entries</em></a>.</td>
</tr>
<tr class="row-odd"><td>Example delivery URL</td>
<td>(Read Only) An example of how the delivery URL may start. This could be multiple rows if multiple HOST_REGEXP entries have been entered.</td>
</tr>
<tr class="row-even"><td>Regular expressions for this delivery service</td>
-<td>A subtable of the regular expressions to use when routing traffic for this delivery service. See <a class="reference internal" href="#rl-ds-regexp"><span class="std std-ref">Delivery Service Regexp</span></a>.</td>
+<td>A subtable of the regular expressions to use when routing traffic for this delivery service. See <a class="reference internal" href="#rl-ds-regexp"><em>Delivery Service Regexp</em></a>.</td>
</tr>
</tbody>
</table>
@@ -1073,7 +1070,7 @@ http.parent_proxy.connect_attempts_timeout</td>
</tr>
</tbody>
</table>
-<p>see <a class="reference internal" href="quick_howto/multi_site.html#rl-multi-site-origin-qht"><span class="std std-ref">Configure Multi Site Origin</span></a> for a <em>quick how to</em> on this feature.</p>
+<p>see <a class="reference internal" href="quick_howto/multi_site.html#rl-multi-site-origin-qht"><em>Configure Multi Site Origin</em></a> for a <em>quick how to</em> on this feature.</p>
</div>
<div class="section" id="ccr-profile-or-traffic-router-profile">
<span id="rl-ccr-profile"></span><h3>CCR Profile or Traffic Router Profile<a class="headerlink" href="#ccr-profile-or-traffic-router-profile" title="Permalink to this headline">¶</a></h3>
@@ -1313,30 +1310,30 @@ http.parent_proxy.connect_attempts_timeout</td>
<div class="section" id="the-coverage-zone-file-and-asn-table">
<span id="rl-asn-czf"></span><h3>The Coverage Zone File and ASN Table<a class="headerlink" href="#the-coverage-zone-file-and-asn-table" title="Permalink to this headline">¶</a></h3>
<p>The Coverage Zone File (CZF) should contain a cachegroup name to network prefix mapping in the form:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"coverageZones"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cache-group-01"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"1234:5678::\/64"</span><span class="p">,</span>
- <span class="s2">"1234:5679::\/64"</span>
- <span class="p">],</span>
- <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"192.168.8.0\/24"</span><span class="p">,</span>
- <span class="s2">"192.168.9.0\/24"</span>
- <span class="p">]</span>
- <span class="p">}</span>
- <span class="s2">"cache-group-02"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"network6"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"1234:567a::\/64"</span><span class="p">,</span>
- <span class="s2">"1234:567b::\/64"</span>
- <span class="p">],</span>
- <span class="s2">"network"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"192.168.4.0\/24"</span><span class="p">,</span>
- <span class="s2">"192.168.5.0\/24"</span>
- <span class="p">]</span>
- <span class="p">}</span>
- <span class="p">}</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "coverageZones": {
+ "cache-group-01": {
+ "network6": [
+ "1234:5678::\/64",
+ "1234:5679::\/64"
+ ],
+ "network": [
+ "192.168.8.0\/24",
+ "192.168.9.0\/24"
+ ]
+ }
+ "cache-group-02": {
+ "network6": [
+ "1234:567a::\/64",
+ "1234:567b::\/64"
+ ],
+ "network": [
+ "192.168.4.0\/24",
+ "192.168.5.0\/24"
+ ]
+ }
+ }
+}
</pre></div>
</div>
<p>The CZF is an input to the Traffic Control CDN, and as such does not get generated by Traffic Ops, but rather, it gets consumed by Traffic Router. Some popular IP management systems output a very similar file to the CZF but in stead of a cachegroup an ASN will be listed. Traffic Ops has the “Networks (ASNs)” view to aid with the conversion of files like that to a Traffic Control CZF file; this table is not used anywhere in Traffic Ops, but can be used to script the conversion using the API.</p>
@@ -1348,7 +1345,7 @@ http.parent_proxy.connect_attempts_timeout</td>
<p>Parameters are shared between profiles if the set of <code class="docutils literal"><span class="pre">{</span> <span class="pre">name,</span> <span class="pre">config_file,</span> <span class="pre">value</span> <span class="pre">}</span></code> is the same. To change a value in one profile but not in others, the parameter has to be removed from the profile you want to change it in, and a new parameter entry has to be created (<strong>Add Parameter</strong> button at the bottom of the Parameters view), and assigned to that profile. It is easy to create new profiles from the <strong>Misc > Profiles</strong> view - just use the <strong>Add/Copy Profile</strong> button at the bottom of the profile view to copy an existing profile to a new one. Profiles can be exported from one system and imported to another using the profile view as well. It makes no sense for a parameter to not be assigned to a single profile - in that case it really has no function. To find parameters like that
use the <strong>Parameters > Orphaned Parameters</strong> view. It is easy to create orphaned parameters by removing all profiles, or not assigning a profile directly after creating the parameter.</p>
<div class="admonition seealso">
<p class="first admonition-title">See also</p>
-<p class="last"><a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><span class="std std-ref">Profile Parameters</span></a> in the <em>Configuring Traffic Ops</em> section.</p>
+<p class="last"><a class="reference internal" href="traffic_ops_config.html#rl-param-prof"><em>Profile Parameters</em></a> in the <em>Configuring Traffic Ops</em> section.</p>
</div>
</div>
<div class="section" id="tools">
@@ -1424,30 +1421,30 @@ http.parent_proxy.connect_attempts_timeout</td>
<p>What we currently do is have 2 scripts, one to do hard drive configuration and one to do network configuration. Both are relatively specific to the environment they were created in, and both are <em>probably</em> wrong for other organizations, however they are currently living in the “misc” directory as examples of how to do things.</p>
<p>We trigger those in a %pre section in ks.cfg and they will write config files to /tmp. We will then include those files in the appropriate places using %pre.</p>
<p>For example this is a section of our ks.cfg file:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">packages</span><span class="o">.</span><span class="n">txt</span>
+<div class="highlight-python"><div class="highlight"><pre>%include /mnt/stage2/ks_scripts/packages.txt
-<span class="o">%</span><span class="n">pre</span>
- <span class="n">python</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">create_network_line</span><span class="o">.</span><span class="n">py</span>
- <span class="n">bash</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">drive_config</span><span class="o">.</span><span class="n">sh</span>
-<span class="o">%</span><span class="n">end</span>
+%pre
+ python /mnt/stage2/ks_scripts/create_network_line.py
+ bash /mnt/stage2/ks_scripts/drive_config.sh
+%end
</pre></div>
</div>
<p>These two scripts will then run _before_ anaconda sets up it’s internal structures, then a bit further up in the ks.cfg file (outside of the %pre %end block) we do an</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">password</span><span class="o">.</span><span class="n">cfg</span>
-<span class="o">...</span>
-<span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network_line</span>
+<div class="highlight-python"><div class="highlight"><pre>%include /mnt/stage2/ks_scripts/password.cfg
+...
+%include /tmp/network_line
-<span class="o">%</span><span class="n">include</span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">drive_config</span>
-<span class="o">...</span>
+%include /tmp/drive_config
+...
</pre></div>
</div>
<p>This snarfs up the contents and inlines them.</p>
<p>If you only have one kind of hardware on your CDN it is probably best to just put the drive config right in the ks.cfg.</p>
<p>If you have simple networking needs (we use bonded interfaces in most, but not all locations and we have several types of hardware meaning different ethernet interface names at the OS level etc.) then something like this:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="ch">#!/bin/bash</span>
-<span class="n">source</span> <span class="o">/</span><span class="n">mnt</span><span class="o">/</span><span class="n">stage2</span><span class="o">/</span><span class="n">ks_scripts</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span>
-<span class="n">echo</span> <span class="s2">"network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME"</span> <span class="o">>></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">network</span><span class="o">.</span><span class="n">cfg</span>
-<span class="c1"># Note that this is an example and may not work at all.</span>
+<div class="highlight-python"><div class="highlight"><pre>#!/bin/bash
+source /mnt/stage2/ks_scripts/network.cfg
+echo "network --bootproto=static --activate --ipv6=$IPV6ADDR --ip=$IPADDR --netmask=$NETMASK --gateway=$GATEWAY --ipv6gateway=$GATEWAY --nameserver=$NAMESERVER --mtu=$MTU --hostname=$HOSTNAME" >> /tmp/network.cfg
+# Note that this is an example and may not work at all.
</pre></div>
</div>
<p>You could also put this in the %pre section. Lots of ways to solve it.</p>
@@ -1489,7 +1486,7 @@ http.parent_proxy.connect_attempts_timeout</td>
</div>
<div class="section" id="snapshot-crconfig">
<span id="rl-snapshot-crconfig"></span><span id="index-12"></span><h4>Snapshot CRConfig<a class="headerlink" href="#snapshot-crconfig" title="Permalink to this headline">¶</a></h4>
-<p>Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See <a class="reference internal" href="#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> for more information on the CRConfig file.</p>
+<p>Every 60 seconds Traffic Monitor will check with Traffic Ops to see if a new CRConfig snapshot exists; Traffic Monitor polls Traffic Ops for a new CRConfig, and Traffic Router polls Traffic Monitor for the same file. This is necessary to ensure that Traffic Monitor sees configuration changes first, which helps to ensure that the health and state of caches and delivery services propagates properly to Traffic Router. See <a class="reference internal" href="#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> for more information on the CRConfig file.</p>
<p>To create a new snapshot, use the <em>Tools > Snapshot CRConfig</em> menu:</p>
<blockquote>
<div><ol class="arabic">
@@ -1627,7 +1624,7 @@ between the active CRConfig and the CRConfig about to be written.</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_portal.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_portal.html b/docs/latest/admin/traffic_portal.html
index 0c5d18b..9e14d7e 100644
--- a/docs/latest/admin/traffic_portal.html
+++ b/docs/latest/admin/traffic_portal.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Portal Administration — Traffic Control 1.8.1 documentation </title>
+ <title>Traffic Portal Administration — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Monitor Administration" href="traffic_monitor.html"/>
<link rel="prev" title="Managing Traffic Ops Extensions" href="traffic_ops_extensions.html"/>
@@ -109,7 +106,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Portal Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Portal Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_portal.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_portal.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -266,7 +263,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_router.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_router.html b/docs/latest/admin/traffic_router.html
index 313e546..f805fed 100644
--- a/docs/latest/admin/traffic_router.html
+++ b/docs/latest/admin/traffic_router.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Router Administration — Traffic Control 1.8.1 documentation </title>
+ <title>Traffic Router Administration — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Stats Administration" href="traffic_stats.html"/>
<link rel="prev" title="Traffic Monitor Administration" href="traffic_monitor.html"/>
@@ -111,7 +108,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Router Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Router Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_router.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_router.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -230,7 +227,7 @@
<li><p class="first">Install a traffic router: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">yum</span> <span class="pre">install</span> <span class="pre">traffic_router</span></code>.</p>
</li>
<li><dl class="first docutils">
-<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><span class="std std-ref">Configuration files</span></a></dt>
+<dt>Edit <code class="docutils literal"><span class="pre">/opt/traffic_router/conf/traffic_monitor.properties</span></code> and specify the correct online Traffic Monitor(s) for your CDN. See <a class="reference internal" href="#rl-tr-config-files"><em>Configuration files</em></a></dt>
<dd><p class="first"># traffic_monitor.properties: url that should normally point to this file
traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties</p>
<p class="last"># Frequency for reloading this file
@@ -240,7 +237,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</li>
<li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code>, and test lookups with dig and curl against that server.</p>
</li>
-<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a></p>
+<li><p class="first">Snapshot CRConfig; See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a></p>
</li>
</ol>
<div class="admonition note">
@@ -261,7 +258,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
<p class="first admonition-title">Note</p>
<p class="last">Pre-existing installations having configuration files in <code class="docutils literal"><span class="pre">/opt/traffic_router/conf</span></code> will still be used and honored for Traffic Router 1.5 and onward.</p>
</div>
-<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><span class="std std-ref">Snapshot CRConfig</span></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p>
+<p>For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See <a class="reference internal" href="traffic_ops_using.html#rl-snapshot-crconfig"><em>Snapshot CRConfig</em></a> for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> for parameters that influence the behavior of Traffic Router via the CRConfig.</p>
<div class="section" id="configuration-files">
<span id="rl-tr-config-files"></span><h3>Configuration files<a class="headerlink" href="#configuration-files" title="Permalink to this headline">¶</a></h3>
<table border="1" class="docutils">
@@ -387,7 +384,7 @@ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.propert
</div>
<div class="section" id="operation">
<h3>Operation<a class="headerlink" href="#operation" title="Permalink to this headline">¶</a></h3>
-<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><span class="std std-ref">CCR Profile or Traffic Router Profile</span></a> documentation for more information.</p>
+<p>Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN’s top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the <a class="reference internal" href="traffic_ops_using.html#rl-ccr-profile"><em>CCR Profile or Traffic Router Profile</em></a> documentation for more information.</p>
<p>Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service’s zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD’s zone. A DS record is generated from each zone’s KSK and is placed in the CDN TLD’s zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.</p>
<p>The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN’s TLD, <strong>however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control</strong>. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment’s DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.</p>
</div>
@@ -412,8 +409,8 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="sample-message">
<h3>Sample Message<a class="headerlink" href="#sample-message" title="Permalink to this headline">¶</a></h3>
<p>Items within brackets below are detailed under the HTTP and DNS sections</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields
</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">DNS</span> <span class="n">result</span><span class="p">]</span>
-<span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">789</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <span class="n">the</span> <span class="n">HTTP</span> <span class="n">request</span><span class="p">]</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="p">[</span><span class="n">Fields</span> <span class="n">Specific</span> <span class="n">to</span> <sp
an class="n">the</span> <span class="n">HTTP</span> <span class="n">result</span><span class="p">]</span>
+<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=789 [Fields Specific to the DNS request] rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the DNS result]
+144140678.000 qtype=HTTP chi=192.168.10.11 ttms=789 [Fields Specific to the HTTP request] rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the HTTP result]
</pre></div>
</div>
<div class="admonition note">
@@ -552,7 +549,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="http-specifics">
<h3>HTTP Specifics<a class="headerlink" href="#http-specifics" title="Permalink to this headline">¶</a></h3>
<p>Sample Message</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1452197640.936</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">69.241</span><span class="o">.</span><span class="mf">53.218</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-&
quot;</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">0</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"Accept: */*"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"myheader: asdasdasdasfasg"</span>
+<div class="highlight-python"><div class="highlight"><pre>1452197640.936 qtype=HTTP chi=69.241.53.218 url="http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" pssc=302 ttms=0 rurl="http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8" rh="Accept: */*" rh="myheader: asdasdasdasfasg"
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -612,7 +609,7 @@ This file grows up to 200Mb and gets rolled into older log files, 10 log files t
<div class="section" id="dns-specifics">
<h3>DNS Specifics<a class="headerlink" href="#dns-specifics" title="Permalink to this headline">¶</a></h3>
<p>Sample Message</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">144140678.000</span> <span class="n">qtype</span><span class="o">=</span><span class="n">DNS</span> <span class="n">chi</span><span class="o">=</span><span class="mf">192.168</span><span class="o">.</span><span class="mf">10.11</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">123</span> <span class="n">xn</span><span class="o">=</span><span class="mi">65535</span> <span class="n">fqdn</span><span class="o">=</span><span class="n">www</span><span class="o">.</span><span class="n">example</span><span class="o">.</span><span class="n">com</span><span class="o">.</span> <span class="nb">type</span><span class="o">=</span><span class="n">A</span> <span class="n">class</span><span class="o">=</span><span class="n">IN</span> <span class="n">ttl</span><span class="o">=</span><span class="mi">12345</span> <span class="n">rcode</span><span class="o">=</span><span class="n">NOERRO
R</span> <span class="n">rtype</span><span class="o">=</span><span class="n">CZ</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"40.252611,58.439389"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">ans</span><span class="o">=</span><span class="s2">"192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"</span>
+<div class="highlight-python"><div class="highlight"><pre>144140678.000 qtype=DNS chi=192.168.10.11 ttms=123 xn=65535 fqdn=www.example.com. type=A class=IN ttl=12345 rcode=NOERROR rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" ans="192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"
</pre></div>
</div>
<p><strong>Request Fields</strong></p>
@@ -887,7 +884,7 @@ During the test it will provide feedback about request latency and transactions
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_server.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_server.html b/docs/latest/admin/traffic_server.html
index 4ab580e..2e9edf6 100644
--- a/docs/latest/admin/traffic_server.html
+++ b/docs/latest/admin/traffic_server.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Server Administration — Traffic Control 1.8.1 documentation </title>
+ <title>Traffic Server Administration — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Vault Administration" href="traffic_vault.html"/>
<link rel="prev" title="Traffic Stats Administration" href="traffic_stats.html"/>
@@ -113,7 +110,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Server Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li>
</ul>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Server Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_server.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_server.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -205,7 +202,7 @@
<dl class="docutils">
<dt><strong>traffic_ops_ort.pl</strong></dt>
<dd><p class="first">The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net
+<div class="highlight-python"><div class="highlight"><pre>$ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net
Thu May 26 15:52:11 UTC 2016
====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL> <Traffic_Ops_Login> [optional flags]
@@ -229,11 +226,11 @@ $
</pre></div>
</div>
<p>For initial configuration or when major changes (like a Profile change) need to be made, run the script in “badass mode”. All required rpm packages will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted. Example run below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">run</span> <span class="n">here</span>
+<div class="highlight-python"><div class="highlight"><pre>run here
</pre></div>
</div>
<p>For “every day changes” such as adding deliveryservices or changing records.config parameters caches should run the script in “syncds” mode out of cron. Example crontab entry:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">traffic_ops_ort</span><span class="o">.</span><span class="n">pl</span> <span class="n">syncds</span> <span class="n">warn</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">traffops</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="n">admin</span><span class="p">:</span><span class="n">password</span> <span class="o">></span> <span class="o">/</span><span class="n">tmp</span><span class="o">/</span><span class="n">ort</span><span class="o">/</span><span class="n">syncds</span><span class="o">.</span
><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+<div class="highlight-python"><div class="highlight"><pre>*/15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password > /tmp/ort/syncds.log 2>&1
</pre></div>
</div>
<div class="last admonition note">
@@ -283,7 +280,7 @@ $
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_stats.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_stats.html b/docs/latest/admin/traffic_stats.html
index bac3103..ec559cd 100644
--- a/docs/latest/admin/traffic_stats.html
+++ b/docs/latest/admin/traffic_stats.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Stats Administration — Traffic Control 1.8.1 documentation </title>
+ <title>Traffic Stats Administration — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Server Administration" href="traffic_server.html"/>
<link rel="prev" title="Traffic Router Administration" href="traffic_router.html"/>
@@ -112,7 +109,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Stats Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_vault.html">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Stats Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_stats.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_stats.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -340,16 +337,19 @@ They are specific for traffic stats and are not meant to be generic to influxdb.
</div></blockquote>
<p>Using create_ts_databases.go</p>
<blockquote class="last">
-<div><ol class="arabic simple">
-<li>go get github.com/influxdata/influxdb</li>
-<li>go build create_ts_databases.go</li>
+<div><ol class="arabic">
+<li><p class="first">go get github.com/influxdata/influxdb</p>
+</li>
+<li><p class="first">go build create_ts_databases.go</p>
+</li>
<li><dl class="first docutils">
<dt>Run it:</dt>
<dd><ul class="first last">
-<li>./create_ts_databases -help</li>
+<li><p class="first">./create_ts_databases -help</p>
+</li>
<li><dl class="first docutils">
<dt>optional flags:</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li>influxUrl - The influxdb url and port</li>
<li>replication - The number of nodes in the cluster</li>
<li>user - The user to use</li>
@@ -358,7 +358,8 @@ They are specific for traffic stats and are not meant to be generic to influxdb.
</dd>
</dl>
</li>
-<li>example: ./create_ts_databases -influxUrl=localhost:8086 -replication=3 -user=joe -password=mysecret</li>
+<li><p class="first">example: ./create_ts_databases -influxUrl=localhost:8086 -replication=3 -user=joe -password=mysecret</p>
+</li>
</ul>
</dd>
</dl>
@@ -385,11 +386,12 @@ They are specific for traffic stats and are not meant to be generic to influxdb.
</li>
<li><dl class="first docutils">
<dt>Run it</dt>
-<dd><ul class="first simple">
-<li>./sync_ts_databases -help</li>
+<dd><ul class="first">
+<li><p class="first">./sync_ts_databases -help</p>
+</li>
<li><dl class="first docutils">
<dt>required flags:</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li>sourceUrl - The URL of the source database</li>
<li>targetUrl - The URL of the target database</li>
</ul>
@@ -460,7 +462,7 @@ They are specific for traffic stats and are not meant to be generic to influxdb.
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_vault.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_vault.html b/docs/latest/admin/traffic_vault.html
index 0190a25..a263441 100644
--- a/docs/latest/admin/traffic_vault.html
+++ b/docs/latest/admin/traffic_vault.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Vault Administration — Traffic Control 1.8.1 documentation </title>
+ <title>Traffic Vault Administration — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Quick How To Guides" href="quick_howto/index.html"/>
<link rel="prev" title="Traffic Server Administration" href="traffic_server.html"/>
@@ -114,7 +111,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Vault Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Vault Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick_howto/index.html">Quick How To Guides</a></li>
</ul>
</li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Vault Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_vault.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_vault.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -202,12 +199,14 @@ The installation instructions for Riak can be found <a class="reference external
<div class="section" id="riak-configuration-file-configuration">
<h3>Riak configuration file configuration<a class="headerlink" href="#riak-configuration-file-configuration" title="Permalink to this headline">¶</a></h3>
<p>The following steps need to be performed on each Riak server in the cluster:</p>
-<ul class="simple">
-<li>Log into riak server as root</li>
-<li>cd to /etc/riak/</li>
+<ul>
+<li><p class="first">Log into riak server as root</p>
+</li>
+<li><p class="first">cd to /etc/riak/</p>
+</li>
<li><dl class="first docutils">
<dt>Update the following in riak.conf to reflect your IP:</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li>nodename = <a class="reference external" href="mailto:riak%40a-host.sys.kabletown.net">riak<span>@</span>a-host<span>.</span>sys<span>.</span>kabletown<span>.</span>net</a></li>
<li>listener.http.internal = a-host.sys.kabletown.net:8098 (can be 80 - This endpoint will not work with sec enabled)</li>
<li>listener.protobuf.internal = a-host.sys.kabletown.net:8087 (can be different port if you want)</li>
@@ -218,7 +217,7 @@ The installation instructions for Riak can be found <a class="reference external
</li>
<li><dl class="first docutils">
<dt>Updated the following conf file to point to your cert files</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li>ssl.certfile = /etc/riak/certs/server.crt</li>
<li>ssl.keyfile = /etc/riak/certs/server.key</li>
<li>ssl.cacertfile = /etc/pki/tls/certs/ca-bundle.crt</li>
@@ -228,7 +227,7 @@ The installation instructions for Riak can be found <a class="reference external
</li>
<li><dl class="first docutils">
<dt>Add a line at the bottom of the config for tlsv1</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li>tls_protocols.tlsv1 = on</li>
</ul>
</dd>
@@ -236,7 +235,7 @@ The installation instructions for Riak can be found <a class="reference external
</li>
<li><dl class="first docutils">
<dt>Once the config file has been updated restart riak</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li><code class="docutils literal"><span class="pre">/etc/init.d/riak</span> <span class="pre">restart</span></code></li>
</ul>
</dd>
@@ -244,7 +243,7 @@ The installation instructions for Riak can be found <a class="reference external
</li>
<li><dl class="first docutils">
<dt>Validate server is running by going to the following URL:</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li><a class="reference external" href="https:/">https:/</a>/<serverHostname>:8088/ping</li>
</ul>
</dd>
@@ -364,10 +363,10 @@ The installation instructions for Riak can be found <a class="reference external
<div class="section" id="riak-configuration">
<h3>Riak Configuration<a class="headerlink" href="#riak-configuration" title="Permalink to this headline">¶</a></h3>
<p>On Each Riak Server:</p>
-<ol class="arabic simple">
+<ol class="arabic">
<li><dl class="first docutils">
<dt>If java is not already installed on your Riak server, install Java</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li>To see if Java is already installed: <code class="docutils literal"><span class="pre">java</span> <span class="pre">-version</span></code></li>
<li>To install Java: <code class="docutils literal"><span class="pre">yum</span> <span class="pre">install</span> <span class="pre">-y</span> <span class="pre">jdk</span></code></li>
</ul>
@@ -376,7 +375,7 @@ The installation instructions for Riak can be found <a class="reference external
</li>
<li><dl class="first docutils">
<dt>enable search in riak.conf</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li><code class="docutils literal"><span class="pre">vim</span> <span class="pre">/etc/riak/riak.conf</span></code></li>
<li>look for search and change <code class="docutils literal"><span class="pre">search</span> <span class="pre">=</span> <span class="pre">off</span></code> to <code class="docutils literal"><span class="pre">search</span> <span class="pre">=</span> <span class="pre">on</span></code></li>
</ul>
@@ -385,7 +384,7 @@ The installation instructions for Riak can be found <a class="reference external
</li>
<li><dl class="first docutils">
<dt>Restart Riak so search is on</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li><code class="docutils literal"><span class="pre">service</span> <span class="pre">riak</span> <span class="pre">restart</span></code></li>
</ul>
</dd>
@@ -403,19 +402,19 @@ The installation instructions for Riak can be found <a class="reference external
<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">to</span> <span class="pre">riakuser</span></code></p>
<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">search.query</span> <span class="pre">on</span> <span class="pre">index</span> <span class="pre">sslkeys</span> <span class="pre">to</span> <span class="pre">riakuser</span></code></p>
<p><code class="docutils literal"><span class="pre">riak-admin</span> <span class="pre">security</span> <span class="pre">grant</span> <span class="pre">riak_core.set_bucket</span> <span class="pre">on</span> <span class="pre">any</span> <span class="pre">to</span> <span class="pre">admin</span></code></p>
-<ol class="arabic simple" start="2">
+<ol class="arabic" start="2">
<li><dl class="first docutils">
<dt>Add the search schema to Riak. This schema is a simple Apache Solr configuration file which will index all records on cdn, hostname, and deliveryservice.</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li>Get the schema file by either cloning the project and going to <cite>traffic_ops/app/config/misc/riak_search</cite> or from <a class="reference external" href="https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_ops/app/conf/misc/riak_search">github</a>.</li>
-<li>Use curl to add the schema to riak: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/search/schema/sslkeys"</span> <span class="pre">-H</span> <span class="pre">'Content-Type:application/xml'</span>  <span class="pre">-d</span> <span class="pre">@sslkeys.xml</span></code></li>
+<li>Use curl to add the schema to riak: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/search/schema/sslkeys"</span> <span class="pre">-H</span> <span class="pre">'Content-Type:application/xml'</span> <span class="pre">-d</span> <span class="pre">@sslkeys.xml</span></code></li>
</ul>
</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt>Add search index to Riak</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li>run the following curl command: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/search/index/sslkeys"</span> <span class="pre">-H</span> <span class="pre">'Content-Type:</span> <span class="pre">application/json'</span> <span class="pre">-d</span> <span class="pre">'{"schema":"sslkeys"}'</span></code></li>
</ul>
</dd>
@@ -423,7 +422,7 @@ The installation instructions for Riak can be found <a class="reference external
</li>
<li><dl class="first docutils">
<dt>Associate the sslkeys index to the ssl bucket in Riak</dt>
-<dd><ul class="first last">
+<dd><ul class="first last simple">
<li>run the following curl command: <code class="docutils literal"><span class="pre">curl</span> <span class="pre">-kvs</span> <span class="pre">-XPUT</span> <span class="pre">"https://admin:pass@riakserver:8088/buckets/ssl/props"</span> <span class="pre">-H'content-type:application/json'</span> <span class="pre">-d'{"props":{"search_index":"sslkeys"}}'</span></code></li>
</ul>
</dd>
@@ -481,7 +480,7 @@ The installation instructions for Riak can be found <a class="reference external
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/basics/cache_revalidation.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/cache_revalidation.html b/docs/latest/basics/cache_revalidation.html
index dc087d9..7ae01af 100644
--- a/docs/latest/basics/cache_revalidation.html
+++ b/docs/latest/basics/cache_revalidation.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Cache Control Headers and Revalidation — Traffic Control 1.8.1 documentation </title>
+ <title>Cache Control Headers and Revalidation — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="CDN Basics" href="index.html"/>
<link rel="next" title="Traffic Control Overview" href="../overview/index.html"/>
<link rel="prev" title="Caching Proxies" href="caching_proxies.html"/>
@@ -86,7 +83,7 @@
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Cache Control Headers and Revalidation</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Cache Control Headers and Revalidation</a></li>
</ul>
</li>
</ul>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">CDN Basics</a> »</li>
<li>Cache Control Headers and Revalidation</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/cache_revalidation.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/cache_revalidation.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -190,49 +187,49 @@
<div class="section" id="cache-control-headers-and-revalidation">
<span id="index-0"></span><h1>Cache Control Headers and Revalidation<a class="headerlink" href="#cache-control-headers-and-revalidation" title="Permalink to this headline">¶</a></h1>
<p>The <a class="reference external" href="https://www.ietf.org/rfc/rfc2616.txt">HTTP/1.1 spec</a> allows for origin servers and clients to influence how caches treat their requests and responses. By default, the Traffic Control CDN will honor cache control headers. Most commonly, origin servers will tell the downstream caches how long a response can be cached:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">86400</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-
-<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Date: Sun, 14 Dec 2014 23:22:44 GMT
+Server: Apache/2.2.15 (Red Hat)
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50a3559482cc0"
+Cache-Control: max-age=86400
+Content-Length: 45
+Connection: close
+Content-Type: text/html; charset=UTF-8
+
+<html><body>This is a fun file</body></html>
</pre></div>
</div>
<p>In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a <code class="docutils literal"><span class="pre">Expires:</span></code> header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn’t get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache <em>revalidates</em> the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code> response, with the new data. If it has not changed, the origin server will send back a <code class="docutils literal"><span class="pre">304</spa
n> <span class="pre">Not</span> <span class="pre">Modified</span></code> response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an <code class="docutils literal"><span class="pre">If-Not-Modified-Since:</span></code> header, or an <code class="docutils literal"><span class="pre">If-None-Match:</span></code> header. For example, in the <code class="docutils literal"><span class="pre">If-None-Match:</span></code> case, the origin will send and <code class="docutils literal"><span class="pre">ETag</span></code> header that uniquely identifies the response. The client can use that in an revalidation request like:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
-<span class="n">If</span><span class="o">-</span><span class="kc">None</span><span class="o">-</span><span class="n">Match</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
+<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
+If-None-Match: "1aa008f-2d-50a3559482cc0"
+Host: www.origin.com
</pre></div>
</div>
<p>If the content has changed (meaning, the new response would not have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">200</span> <span class="pre">OK</span></code>, like:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50aa00feadd"</span>
-<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">49</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-
-<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">NOT</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Date: Sun, 18 Dec 2014 3:22:44 GMT
+Server: Apache/2.2.15 (Red Hat)
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50aa00feadd"
+Cache-Control: max-age=604800
+Content-Length: 49
+Connection: close
+Content-Type: text/html; charset=UTF-8
+
+<html><body>This is NOT a fun file</body></html>
</pre></div>
</div>
<p>If the Content did not change (meaning, the response would have had the same ETag) it will respond with <code class="docutils literal"><span class="pre">304</span> <span class="pre">Not</span> <span class="pre">Modified</span></code>, like:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mi">304</span> <span class="n">Not</span> <span class="n">Modified</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">18</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">3</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Cache</span><span class="o">-</span><span class="n">Control</span><span class="p">:</span> <span class="nb">max</span><span class="o">-</span><span class="n">age</span><span class="o">=</span><span class="mi">604800</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
+<div class="highlight-python"><div class="highlight"><pre>304 Not Modified
+Date: Sun, 18 Dec 2014 3:22:44 GMT
+Server: Apache/2.2.15 (Red Hat)
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50a3559482cc0"
+Cache-Control: max-age=604800
+Content-Length: 45
+Connection: close
+Content-Type: text/html; charset=UTF-8
</pre></div>
</div>
<p>Note that the 304 response only has headers, not the data.</p>
@@ -276,7 +273,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[24/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/server.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/server.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/server.rst.txt
deleted file mode 100644
index 3700160..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/server.rst.txt
+++ /dev/null
@@ -1,1125 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-server:
-
-Server
-======
-
-.. _to-api-v12-servers-route:
-
-/api/1.2/servers
-++++++++++++++++
-
-**GET /api/1.2/servers**
-
- Retrieves properties of CDN servers.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +--------------------+----------+---------------------------------------------+
- | Name | Required | Description |
- +====================+==========+=============================================+
- | ``dsId`` | no | Used to filter servers by delivery service. |
- +--------------------+----------+---------------------------------------------+
- | ``status`` | no | Used to filter servers by status. |
- +--------------------+----------+---------------------------------------------+
- | ``type`` | no | Used to filter servers by type. |
- +--------------------+----------+---------------------------------------------+
- | ``profileId`` | no | Used to filter servers by profile. |
- +--------------------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+============================================================================================================+
- | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cachegroupId`` | string | The cache group id. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``domainName`` | string | The domain name part of the FQDN of the cache. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``guid`` | string | An identifier used to uniquely identify the server. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``hostName`` | string | The host name part of the cache. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The server id (database row number). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloUsername`` | string | The user name for lights-out-management. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``interfaceName`` | string | The network interface name used for serving traffic. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``rack`` | string | A string indicating rack location. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``routerHostName`` | string | The human readable name of the router. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``routerPortName`` | string | The human readable name of the router port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``updPending`` | bool | |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "cachegroup": "us-il-chicago",
- "cachegroupId": "3",
- "cdnId": "3",
- "cdnName": "CDN-1",
- "domainName": "chi.kabletown.net",
- "guid": null,
- "hostName": "atsec-chi-00",
- "id": "19",
- "iloIpAddress": "172.16.2.6",
- "iloIpGateway": "172.16.2.1",
- "iloIpNetmask": "255.255.255.0",
- "iloPassword": "********",
- "iloUsername": "",
- "interfaceMtu": "9000",
- "interfaceName": "bond0",
- "ip6Address": "2033:D0D0:3300::2:2/64",
- "ip6Gateway": "2033:D0D0:3300::2:1",
- "ipAddress": "10.10.2.2",
- "ipGateway": "10.10.2.1",
- "ipNetmask": "255.255.255.0",
- "lastUpdated": "2015-03-08 15:57:32",
- "mgmtIpAddress": "",
- "mgmtIpGateway": "",
- "mgmtIpNetmask": "",
- "offlineReason": "N/A",
- "physLocation": "plocation-chi-1",
- "physLocationId": "9",
- "profile": "EDGE1_CDN1_421_SSL",
- "profileDesc": "EDGE1_CDN1_421_SSL profile",
- "profileId": "12",
- "rack": "RR 119.02",
- "routerHostName": "rtr-chi.kabletown.net",
- "routerPortName": "2",
- "status": "ONLINE",
- "statusId": "6",
- "tcpPort": "80",
- "httpsPort": "443",
- "type": "EDGE",
- "typeId": "3",
- "updPending": false
- },
- {
- ... more server data
- }
- ]
- }
-
-|
-
-**GET /api/1.2/servers/:id**
-
- Retrieves properties of a CDN server by server ID.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | Server id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+============================================================================================================+
- | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cachegroupId`` | string | The cache group id. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``domainName`` | string | The domain name part of the FQDN of the cache. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``guid`` | string | An identifier used to uniquely identify the server. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``hostName`` | string | The host name part of the cache. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The server id (database row number). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloUsername`` | string | The user name for lights-out-management. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``interfaceName`` | string | The network interface name used for serving traffic. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``rack`` | string | A string indicating rack location. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``routerHostName`` | string | The human readable name of the router. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``routerPortName`` | string | The human readable name of the router port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``updPending`` | bool | |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "cachegroup": "us-il-chicago",
- "cachegroupId": "3",
- "cdnId": "3",
- "cdnName": "CDN-1",
- "domainName": "chi.kabletown.net",
- "guid": null,
- "hostName": "atsec-chi-00",
- "id": "19",
- "iloIpAddress": "172.16.2.6",
- "iloIpGateway": "172.16.2.1",
- "iloIpNetmask": "255.255.255.0",
- "iloPassword": "********",
- "iloUsername": "",
- "interfaceMtu": "9000",
- "interfaceName": "bond0",
- "ip6Address": "2033:D0D0:3300::2:2/64",
- "ip6Gateway": "2033:D0D0:3300::2:1",
- "ipAddress": "10.10.2.2",
- "ipGateway": "10.10.2.1",
- "ipNetmask": "255.255.255.0",
- "lastUpdated": "2015-03-08 15:57:32",
- "mgmtIpAddress": "",
- "mgmtIpGateway": "",
- "mgmtIpNetmask": "",
- "offlineReason": "N/A",
- "physLocation": "plocation-chi-1",
- "physLocationId": "9",
- "profile": "EDGE1_CDN1_421_SSL",
- "profileDesc": "EDGE1_CDN1_421_SSL profile",
- "profileId": "12",
- "rack": "RR 119.02",
- "routerHostName": "rtr-chi.kabletown.net",
- "routerPortName": "2",
- "status": "ONLINE",
- "statusId": "6",
- "tcpPort": "80",
- "httpsPort": "443",
- "type": "EDGE",
- "typeId": "3",
- "updPending": false
- }
- ]
- }
-
-|
-
-
-**GET /api/1.2/servers/summary**
-
- Retrieves a count of CDN servers by type.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------+--------+------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +===========+========+========================================================================+
- | ``count`` | int | The number of servers of this type in this instance of Traffic Ops. |
- +-----------+--------+------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of the server count (see :ref:`to-api-v12-type`). |
- +-----------+--------+------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "count": 4,
- "type": "CCR"
- },
- {
- "count": 55,
- "type": "EDGE"
- },
- {
- "type": "MID",
- "count": 18
- },
- {
- "count": 0,
- "type": "INFLUXDB"
- },
- {
- "count": 4,
- "type": "RASCAL"
- }
- }
-
-|
-
-**GET /api/1.2/servers/hostname/:name/details**
-
- Retrieves the details of a server.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------+----------+----------------------------------+
- | Name | Required | Description |
- +==========+==========+==================================+
- | ``name`` | yes | The host name part of the cache. |
- +----------+----------+----------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+=============================================================================================================+
- | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v12-cachegroup`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``deliveryservices`` | array | Array of strings with the delivery service ids assigned (see :ref:`to-api-v12-ds`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``domainName`` | string | The domain name part of the FQDN of the cache. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``hardwareInfo`` | hash | Hwinfo struct (see :ref:`to-api-v12-hwinfo`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``hostName`` | string | The host name part of the cache. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The server id (database row number). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloUsername`` | string | The user name for lights-out-management. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``interfaceName`` | string | The network interface name used for serving traffic. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time/Date of the last update for this server. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``physLocation`` | string | The physical location name (see :ref:`to-api-v12-phys-loc`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``profile`` | string | The assigned profile name (see :ref:`to-api-v12-profile`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``rack`` | string | A string indicating rack location. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``routerHostName`` | string | The human readable name of the router. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``routerPortName`` | string | The human readable name of the router port. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``status`` | string | The Status string (See :ref:`to-api-v12-status`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of this server (see :ref:`to-api-v12-type`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``xmppId`` | string | Deprecated. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``xmppPasswd`` | string | Deprecated. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "cachegroup": "us-il-chicago",
- "deliveryservices": [
- "1",
- "2",
- "3",
- "4"
- ],
- "domainName": "chi.kabletown.net",
- "hardwareInfo": {
- "Physical Disk 0:1:3": "D1S2",
- "Physical Disk 0:1:2": "D1S2",
- "Physical Disk 0:1:15": "D1S2",
- "Power Supply.Slot.2": "04.07.15",
- "Physical Disk 0:1:24": "YS08",
- "Physical Disk 0:1:1": "D1S2",
- "Model": "PowerEdge R720xd",
- "Physical Disk 0:1:22": "D1S2",
- "Physical Disk 0:1:18": "D1S2",
- "Enterprise UEFI Diagnostics": "4217A5",
- "Lifecycle Controller": "1.0.8.42",
- "Physical Disk 0:1:8": "D1S2",
- "Manufacturer": "Dell Inc.",
- "Physical Disk 0:1:6": "D1S2",
- "SysMemTotalSize": "196608",
- "PopulatedDIMMSlots": "24",
- "Physical Disk 0:1:20": "D1S2",
- "Intel(R) Ethernet 10G 2P X520 Adapter": "13.5.7",
- "Physical Disk 0:1:14": "D1S2",
- "BACKPLANE FIRMWARE": "1.00",
- "Dell OS Drivers Pack, 7.0.0.29, A00": "7.0.0.29",
- "Integrated Dell Remote Access Controller": "1.57.57",
- "Physical Disk 0:1:5": "D1S2",
- "ServiceTag": "D6XPDV1",
- "PowerState": "2",
- "Physical Disk 0:1:23": "D1S2",
- "Physical Disk 0:1:25": "D903",
- "BIOS": "1.3.6",
- "Physical Disk 0:1:12": "D1S2",
- "System CPLD": "1.0.3",
- "Physical Disk 0:1:4": "D1S2",
- "Physical Disk 0:1:0": "D1S2",
- "Power Supply.Slot.1": "04.07.15",
- "PERC H710P Mini": "21.0.2-0001",
- "PowerCap": "689",
- "Physical Disk 0:1:16": "D1S2",
- "Physical Disk 0:1:10": "D1S2",
- "Physical Disk 0:1:11": "D1S2",
- "Lifecycle Controller 2": "1.0.8.42",
- "BP12G+EXP 0:1": "1.07",
- "Physical Disk 0:1:9": "D1S2",
- "Physical Disk 0:1:17": "D1S2",
- "Broadcom Gigabit Ethernet BCM5720": "7.2.20",
- "Physical Disk 0:1:21": "D1S2",
- "Physical Disk 0:1:13": "D1S2",
- "Physical Disk 0:1:7": "D1S2",
- "Physical Disk 0:1:19": "D1S2"
- },
- "hostName": "atsec-chi-00",
- "id": "19",
- "iloIpAddress": "172.16.2.6",
- "iloIpGateway": "172.16.2.1",
- "iloIpNetmask": "255.255.255.0",
- "iloPassword": "********",
- "iloUsername": "",
- "interfaceMtu": "9000",
- "interfaceName": "bond0",
- "ip6Address": "2033:D0D0:3300::2:2/64",
- "ip6Gateway": "2033:D0D0:3300::2:1",
- "ipAddress": "10.10.2.2",
- "ipGateway": "10.10.2.1",
- "ipNetmask": "255.255.255.0",
- "mgmtIpAddress": "",
- "mgmtIpGateway": "",
- "mgmtIpNetmask": "",
- "physLocation": "plocation-chi-1",
- "profile": "EDGE1_CDN1_421_SSL",
- "rack": "RR 119.02",
- "routerHostName": "rtr-chi.kabletown.net",
- "routerPortName": "2",
- "status": "ONLINE",
- "tcpPort": "80",
- "httpsPort": "443",
- "type": "EDGE",
- "xmppId": "atsec-chi-00-dummyxmpp",
- "xmppPasswd": "X"
-
- }
- }
-
-|
-
-**POST /api/1.2/servercheck**
-
- Post a server check result to the serverchecks table.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------------------------+----------+-------------+
- | Name | Required | Description |
- +============================+==========+=============+
- | ``id`` | yes | |
- +----------------------------+----------+-------------+
- | ``host_name`` | yes | |
- +----------------------------+----------+-------------+
- | ``servercheck_short_name`` | yes | |
- +----------------------------+----------+-------------+
- | ``value`` | yes | |
- +----------------------------+----------+-------------+
-
- **Request Example** ::
-
- {
- "id": "",
- "host_name": "",
- "servercheck_short_name": "",
- "value": ""
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- Response Example:
-
- {
- "alerts":
- [
- {
- "level": "success",
- "text": "Server Check was successfully updated."
- }
- ],
- }
-
-|
-
-**POST /api/1.2/servers**
-
- Allow user to create a server.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Properties**
-
- +----------------+----------+------------------------------------------------+
- | Name | Required | Description |
- +================+==========+================================================+
- | hostName | yes | The host name part of the server. |
- +----------------+----------+------------------------------------------------+
- | domainName | yes | The domain name part of the FQDN of the cache. |
- +----------------+----------+------------------------------------------------+
- | cachegroup | yes | cache group name |
- +----------------+----------+------------------------------------------------+
- | interfaceName | yes | |
- +----------------+----------+------------------------------------------------+
- | ipAddress | yes | |
- +----------------+----------+------------------------------------------------+
- | ipNetmask | yes | |
- +----------------+----------+------------------------------------------------+
- | ipGateway | yes | |
- +----------------+----------+------------------------------------------------+
- | interfaceMtu | no | 1500 or 9000 |
- +----------------+----------+------------------------------------------------+
- | physLocation | yes | |
- +----------------+----------+------------------------------------------------+
- | type | yes | server type |
- +----------------+----------+------------------------------------------------+
- | profile | yes | |
- +----------------+----------+------------------------------------------------+
- | cdnName | yes | cdn name the server belongs to |
- +----------------+----------+------------------------------------------------+
- | tcpPort | no | |
- +----------------+----------+------------------------------------------------+
- | httpsPort | no | |
- +----------------+----------+------------------------------------------------+
- | xmppId | no | |
- +----------------+----------+------------------------------------------------+
- | xmppPasswd | no | |
- +----------------+----------+------------------------------------------------+
- | ip6Address | no | |
- +----------------+----------+------------------------------------------------+
- | ip6Gateway | no | |
- +----------------+----------+------------------------------------------------+
- | rack | no | |
- +----------------+----------+------------------------------------------------+
- | mgmtIpAddress | no | |
- +----------------+----------+------------------------------------------------+
- | mgmtIpNetmask | no | |
- +----------------+----------+------------------------------------------------+
- | mgmtIpGateway | no | |
- +----------------+----------+------------------------------------------------+
- | iloIpAddress | no | |
- +----------------+----------+------------------------------------------------+
- | iloIpNetmask | no | |
- +----------------+----------+------------------------------------------------+
- | iloIpGateway | no | |
- +----------------+----------+------------------------------------------------+
- | iloUsername | no | |
- +----------------+----------+------------------------------------------------+
- | iloPassword | no | |
- +----------------+----------+------------------------------------------------+
- | routerHostName | no | |
- +----------------+----------+------------------------------------------------+
- | routerPortName | no | |
- +----------------+----------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "hostName": "tc1_ats1",
- "domainName": "my.test.com",
- "cachegroup": "cache_group_edge",
- "cdnName": "cdn_number_1",
- "interfaceName": "eth0",
- "ipAddress": "10.74.27.188",
- "ipNetmask": "255.255.255.0",
- "ipGateway": "10.74.27.1",
- "interfaceMtu": "1500",
- "physLocation": "plocation-chi-1",
- "type": "EDGE",
- "profile": "EDGE1_CDN1_421"
- }
-
-|
-
- **Response Properties**
-
- +----------------+--------+------------------------------------------------+
- | Name | Type | Description |
- +================+========+================================================+
- | hostName | string | The host name part of the server. |
- +----------------+--------+------------------------------------------------+
- | Name | string | Description |
- +----------------+--------+------------------------------------------------+
- | domainName | string | The domain name part of the FQDN of the cache. |
- +----------------+--------+------------------------------------------------+
- | cachegroup | string | cache group name |
- +----------------+--------+------------------------------------------------+
- | interfaceName | string | |
- +----------------+--------+------------------------------------------------+
- | ipAddress | string | |
- +----------------+--------+------------------------------------------------+
- | ipNetmask | string | |
- +----------------+--------+------------------------------------------------+
- | ipGateway | string | |
- +----------------+--------+------------------------------------------------+
- | interfaceMtu | string | 1500 or 9000 |
- +----------------+--------+------------------------------------------------+
- | physLocation | string | |
- +----------------+--------+------------------------------------------------+
- | type | string | server type |
- +----------------+--------+------------------------------------------------+
- | profile | string | |
- +----------------+--------+------------------------------------------------+
- | cdnName | string | cdn name the server belongs to |
- +----------------+--------+------------------------------------------------+
- | tcpPort | string | |
- +----------------+--------+------------------------------------------------+
- | httpsPort | string | |
- +----------------+--------+------------------------------------------------+
- | xmppId | string | |
- +----------------+--------+------------------------------------------------+
- | xmppPasswd | string | |
- +----------------+--------+------------------------------------------------+
- | ip6Address | string | |
- +----------------+--------+------------------------------------------------+
- | ip6Gateway | string | |
- +----------------+--------+------------------------------------------------+
- | rack | string | |
- +----------------+--------+------------------------------------------------+
- | mgmtIpAddress | string | |
- +----------------+--------+------------------------------------------------+
- | mgmtIpNetmask | string | |
- +----------------+--------+------------------------------------------------+
- | mgmtIpGateway | string | |
- +----------------+--------+------------------------------------------------+
- | iloIpAddress | string | |
- +----------------+--------+------------------------------------------------+
- | iloIpNetmask | string | |
- +----------------+--------+------------------------------------------------+
- | iloIpGateway | string | |
- +----------------+--------+------------------------------------------------+
- | iloUsername | string | |
- +----------------+--------+------------------------------------------------+
- | iloPassword | string | |
- +----------------+--------+------------------------------------------------+
- | routerHostName | string | |
- +----------------+--------+------------------------------------------------+
- | routerPortName | string | |
- +----------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- 'response' : {
- 'xmppPasswd' : '**********',
- 'profile' : 'EDGE1_CDN1_421',
- 'iloUsername' : null,
- 'status' : 'REPORTED',
- 'ipAddress' : '10.74.27.188',
- 'cdnId' : '1',
- 'physLocation' : 'plocation-chi-1',
- 'cachegroup' : 'cache_group_edge',
- 'interfaceName' : 'eth0',
- 'ip6Gateway' : null,
- 'iloPassword' : null,
- 'id' : '1003',
- 'routerPortName' : null,
- 'lastUpdated' : '2016-01-25 14:16:16',
- 'ipNetmask' : '255.255.255.0',
- 'ipGateway' : '10.74.27.1',
- 'tcpPort' : '80',
- 'httpsPort' : '443',
- 'mgmtIpAddress' : null,
- 'ip6Address' : null,
- 'interfaceMtu' : '1500',
- 'iloIpGateway' : null,
- 'hostName' : 'tc1_ats1',
- 'xmppId' : 'tc1_ats1',
- 'rack' : null,
- 'mgmtIpNetmask' : null,
- 'iloIpAddress' : null,
- 'mgmtIpGateway' : null,
- 'type' : 'EDGE',
- 'domainName' : 'my.test.com',
- 'iloIpNetmask' : null,
- 'routerHostName' : null
- }
- }
-
-|
-
-**PUT /api/1.2/servers/{:id}**
-
- Allow user to edit server through api.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +------+----------+-------------------------------+
- | Name | Required | Description |
- +======+==========+===============================+
- | id | yes | The id of the server to edit. |
- +------+----------+-------------------------------+
-
- **Request Properties**
-
- +----------------+----------+------------------------------------------------+
- | Name | Required | Description |
- +================+==========+================================================+
- | hostName | yes | The host name part of the server. |
- +----------------+----------+------------------------------------------------+
- | domainName | yes | The domain name part of the FQDN of the cache. |
- +----------------+----------+------------------------------------------------+
- | cachegroup | yes | cache group name |
- +----------------+----------+------------------------------------------------+
- | interfaceName | yes | |
- +----------------+----------+------------------------------------------------+
- | ipAddress | yes | |
- +----------------+----------+------------------------------------------------+
- | ipNetmask | yes | |
- +----------------+----------+------------------------------------------------+
- | ipGateway | yes | |
- +----------------+----------+------------------------------------------------+
- | interfaceMtu | no | 1500 or 9000 |
- +----------------+----------+------------------------------------------------+
- | physLocation | yes | |
- +----------------+----------+------------------------------------------------+
- | type | yes | server type |
- +----------------+----------+------------------------------------------------+
- | profile | yes | |
- +----------------+----------+------------------------------------------------+
- | cdnName | yes | cdn name the server belongs to |
- +----------------+----------+------------------------------------------------+
- | tcpPort | no | |
- +----------------+----------+------------------------------------------------+
- | httpsPort | no | |
- +----------------+----------+------------------------------------------------+
- | xmppId | no | |
- +----------------+----------+------------------------------------------------+
- | xmppPasswd | no | |
- +----------------+----------+------------------------------------------------+
- | ip6Address | no | |
- +----------------+----------+------------------------------------------------+
- | ip6Gateway | no | |
- +----------------+----------+------------------------------------------------+
- | rack | no | |
- +----------------+----------+------------------------------------------------+
- | mgmtIpAddress | no | |
- +----------------+----------+------------------------------------------------+
- | mgmtIpNetmask | no | |
- +----------------+----------+------------------------------------------------+
- | mgmtIpGateway | no | |
- +----------------+----------+------------------------------------------------+
- | iloIpAddress | no | |
- +----------------+----------+------------------------------------------------+
- | iloIpNetmask | no | |
- +----------------+----------+------------------------------------------------+
- | iloIpGateway | no | |
- +----------------+----------+------------------------------------------------+
- | iloUsername | no | |
- +----------------+----------+------------------------------------------------+
- | iloPassword | no | |
- +----------------+----------+------------------------------------------------+
- | routerHostName | no | |
- +----------------+----------+------------------------------------------------+
- | routerPortName | no | |
- +----------------+----------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "hostName": "tc1_ats2",
- "domainName": "my.test.com",
- "cachegroup": "cache_group_edge",
- "cdnName": "cdn_number_1",
- "interfaceName": "eth0",
- "ipAddress": "10.74.27.188",
- "ipNetmask": "255.255.255.0",
- "ipGateway": "10.74.27.1",
- "interfaceMtu": "1500",
- "physLocation": "plocation-chi-1",
- "type": "EDGE",
- "profile": "EDGE1_CDN1_421"
- }
-
-|
-
- **Response Properties**
-
- +----------------+--------+------------------------------------------------+
- | Name | Type | Description |
- +================+========+================================================+
- | hostName | string | The host name part of the server. |
- +----------------+--------+------------------------------------------------+
- | Name | string | Description |
- +----------------+--------+------------------------------------------------+
- | domainName | string | The domain name part of the FQDN of the cache. |
- +----------------+--------+------------------------------------------------+
- | cachegroup | string | cache group name |
- +----------------+--------+------------------------------------------------+
- | interfaceName | string | |
- +----------------+--------+------------------------------------------------+
- | ipAddress | string | |
- +----------------+--------+------------------------------------------------+
- | ipNetmask | string | |
- +----------------+--------+------------------------------------------------+
- | ipGateway | string | |
- +----------------+--------+------------------------------------------------+
- | interfaceMtu | string | 1500 or 9000 |
- +----------------+--------+------------------------------------------------+
- | physLocation | string | |
- +----------------+--------+------------------------------------------------+
- | type | string | server type |
- +----------------+--------+------------------------------------------------+
- | profile | string | |
- +----------------+--------+------------------------------------------------+
- | cdnName | string | cdn name the server belongs to |
- +----------------+--------+------------------------------------------------+
- | tcpPort | string | |
- +----------------+--------+------------------------------------------------+
- | httpsPort | string | |
- +----------------+--------+------------------------------------------------+
- | xmppId | string | |
- +----------------+--------+------------------------------------------------+
- | xmppPasswd | string | |
- +----------------+--------+------------------------------------------------+
- | ip6Address | string | |
- +----------------+--------+------------------------------------------------+
- | ip6Gateway | string | |
- +----------------+--------+------------------------------------------------+
- | rack | string | |
- +----------------+--------+------------------------------------------------+
- | mgmtIpAddress | string | |
- +----------------+--------+------------------------------------------------+
- | mgmtIpNetmask | string | |
- +----------------+--------+------------------------------------------------+
- | mgmtIpGateway | string | |
- +----------------+--------+------------------------------------------------+
- | iloIpAddress | string | |
- +----------------+--------+------------------------------------------------+
- | iloIpNetmask | string | |
- +----------------+--------+------------------------------------------------+
- | iloIpGateway | string | |
- +----------------+--------+------------------------------------------------+
- | iloUsername | string | |
- +----------------+--------+------------------------------------------------+
- | iloPassword | string | |
- +----------------+--------+------------------------------------------------+
- | routerHostName | string | |
- +----------------+--------+------------------------------------------------+
- | routerPortName | string | |
- +----------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- 'response' : {
- 'xmppPasswd' : '**********',
- 'profile' : 'EDGE1_CDN1_421',
- 'iloUsername' : null,
- 'status' : 'REPORTED',
- 'ipAddress' : '10.74.27.188',
- 'cdnId' : '1',
- 'physLocation' : 'plocation-chi-1',
- 'cachegroup' : 'cache_group_edge',
- 'interfaceName' : 'eth0',
- 'ip6Gateway' : null,
- 'iloPassword' : null,
- 'id' : '1003',
- 'routerPortName' : null,
- 'lastUpdated' : '2016-01-25 14:16:16',
- 'ipNetmask' : '255.255.255.0',
- 'ipGateway' : '10.74.27.1',
- 'tcpPort' : '80',
- 'httpsPort' : '443',
- 'mgmtIpAddress' : null,
- 'ip6Address' : null,
- 'interfaceMtu' : '1500',
- 'iloIpGateway' : null,
- 'hostName' : 'tc1_ats2',
- 'xmppId' : 'tc1_ats1',
- 'rack' : null,
- 'mgmtIpNetmask' : null,
- 'iloIpAddress' : null,
- 'mgmtIpGateway' : null,
- 'type' : 'EDGE',
- 'domainName' : 'my.test.com',
- 'iloIpNetmask' : null,
- 'routerHostName' : null
- }
- }
-
-|
-
-**DELETE /api/1.2/servers/{:id}**
-
- Allow user to delete server through api.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +------+----------+---------------------------------+
- | Name | Required | Description |
- +======+==========+=================================+
- | id | yes | The id of the server to delete. |
- +------+----------+---------------------------------+
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Server was deleted."
- }
- ],
- }
-
-|
-
-**POST /api/1.2/servers/{:id}/queue_update**
-
- Queue or dequeue updates for a specific server.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-----------+----------+------------------+
- | Name | Required | Description |
- +===========+==========+==================+
- | id | yes | the server id. |
- +-----------+----------+------------------+
-
- **Request Properties**
-
- +--------------+---------+-----------------------------------------------+
- | Name | Type | Description |
- +==============+=========+===============================================+
- | action | string | queue or dequeue |
- +--------------+---------+-----------------------------------------------+
-
- **Response Properties**
-
- +--------------+---------+-----------------------------------------------+
- | Name | Type | Description |
- +==============+=========+===============================================+
- | action | string | The action processed, queue or dequeue. |
- +--------------+---------+-----------------------------------------------+
- | serverId | integer | server id |
- +--------------+---------+-----------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "serverId": "1",
- "action": "queue"
- }
- }
-
-|
-
[02/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html
index d9f3862..c248589 100644
--- a/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html
+++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice_stats.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Delivery Service Statistics — Traffic Control 1.8.1 documentation </title>
+ <title>Delivery Service Statistics — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Divisions" href="division.html"/>
<link rel="prev" title="Delivery Service" href="deliveryservice.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Delivery Service Statistics</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/deliveryservice_stats.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -319,61 +316,61 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"source"</span><span class="p">:</span> <span class="s2">"TrafficStats"</span><span class="p">,</span>
- <span class="s2">"summary"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"average"</span><span class="p">:</span> <span class="mf">1081172.785</span><span class="p">,</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">28</span><span class="p">,</span>
- <span class="s2">"fifthPercentile"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
- <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1326680.31</span><span class="p">,</span>
- <span class="s2">"min"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
- <span class="s2">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
- <span class="s2">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
- <span class="s2">"totalBytes"</span><span class="p">:</span> <span class="mf">37841047.475</span><span class="p">,</span>
- <span class="s2">"totalTransactions"</span><span class="p">:</span> <span class="mi">1020202030101</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"source"</span><span class="p">:</span> <span class="s">"TrafficStats"</span><span class="p">,</span>
+ <span class="s">"summary"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"average"</span><span class="p">:</span> <span class="mf">1081172.785</span><span class="p">,</span>
+ <span class="s">"count"</span><span class="p">:</span> <span class="mi">28</span><span class="p">,</span>
+ <span class="s">"fifthPercentile"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
+ <span class="s">"max"</span><span class="p">:</span> <span class="mf">1326680.31</span><span class="p">,</span>
+ <span class="s">"min"</span><span class="p">:</span> <span class="mf">888827.26</span><span class="p">,</span>
+ <span class="s">"ninetyEighthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
+ <span class="s">"ninetyFifthPercentile"</span><span class="p">:</span> <span class="mf">1324785.47</span><span class="p">,</span>
+ <span class="s">"totalBytes"</span><span class="p">:</span> <span class="mf">37841047.475</span><span class="p">,</span>
+ <span class="s">"totalTransactions"</span><span class="p">:</span> <span class="mi">1020202030101</span>
<span class="p">},</span>
- <span class="s2">"series"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"columns"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"time"</span><span class="p">,</span>
- <span class="s2">""</span>
+ <span class="s">"series"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"columns"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"time"</span><span class="p">,</span>
+ <span class="s">""</span>
<span class="p">],</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">60</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"kbps"</span><span class="p">,</span>
- <span class="s2">"tags"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"total"</span>
+ <span class="s">"count"</span><span class="p">:</span> <span class="mi">60</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"kbps"</span><span class="p">,</span>
+ <span class="s">"tags"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"total"</span>
<span class="p">},</span>
- <span class="s2">"values"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"values"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
- <span class="s2">"2015-08-11T11:36:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-11T11:36:00Z"</span><span class="p">,</span>
<span class="mf">888827.26</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-11T11:37:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-11T11:37:00Z"</span><span class="p">,</span>
<span class="mf">980336.563333333</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-11T11:38:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-11T11:38:00Z"</span><span class="p">,</span>
<span class="mf">952111.975</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-11T11:39:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-11T11:39:00Z"</span><span class="p">,</span>
<span class="n">null</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-11T11:43:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-11T11:43:00Z"</span><span class="p">,</span>
<span class="n">null</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-11T11:44:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-11T11:44:00Z"</span><span class="p">,</span>
<span class="mf">934682.943333333</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-11T11:45:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-11T11:45:00Z"</span><span class="p">,</span>
<span class="mf">1251121.28</span>
<span class="p">],</span>
<span class="p">[</span>
- <span class="s2">"2015-08-11T11:46:00Z"</span><span class="p">,</span>
+ <span class="s">"2015-08-11T11:46:00Z"</span><span class="p">,</span>
<span class="mf">1111012.99</span>
<span class="p">]</span>
<span class="p">]</span>
@@ -427,7 +424,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/division.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/division.html b/docs/latest/development/traffic_ops_api/v12/division.html
index 5bbbbd8..ea99d51 100644
--- a/docs/latest/development/traffic_ops_api/v12/division.html
+++ b/docs/latest/development/traffic_ops_api/v12/division.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Divisions — Traffic Control 1.8.1 documentation </title>
+ <title>Divisions — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Federation" href="federation.html"/>
<link rel="prev" title="Delivery Service Statistics" href="deliveryservice_stats.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Divisions</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/division.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/division.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -227,20 +224,20 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Central"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"West"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="last highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "West",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
</pre></div>
</div>
</dd>
@@ -282,15 +279,15 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Central"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="last highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
</pre></div>
</div>
</dd>
@@ -344,8 +341,8 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"mydivision1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -384,17 +381,17 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Division update was successful."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Division update was successful."</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-03-18 08:57:39"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"mydivision1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -429,8 +426,8 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"mydivision1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -465,10 +462,10 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
- <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'4'</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">'name'</span><span class="p">:</span> <span class="s">'mydivision1'</span><span class="p">,</span>
+ <span class="s">'id'</span><span class="p">:</span> <span class="s">'4'</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -518,7 +515,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/federation.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/federation.html b/docs/latest/development/traffic_ops_api/v12/federation.html
index a118cf2..6d337a2 100644
--- a/docs/latest/development/traffic_ops_api/v12/federation.html
+++ b/docs/latest/development/traffic_ops_api/v12/federation.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Federation — Traffic Control 1.8.1 documentation </title>
+ <title>Federation — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Hardware Info" href="hwinfo.html"/>
<link rel="prev" title="Divisions" href="division.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Federation</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/federation.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/federation.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -227,17 +224,17 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"cname"</span><span class="p">:</span> <span class="s2">"cname-01."</span><span class="p">,</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">8865</span><span class="p">,</span>
- <span class="p">]</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "mappings": [
+ "cname": "cname-01.",
+ "ttl": 8865,
+ ]
+ "deliveryService": "ds-01",
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -278,16 +275,16 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"federations"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span>
- <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"255.255.255.255"</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"ccp-omg-01"</span><span class="p">,</span>
+ <span class="s">"mappings"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"255.255.255.255"</span>
<span class="p">],</span>
- <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
+ <span class="s">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -342,16 +339,16 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"federations"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"federations"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"ccp-omg-01"</span><span class="p">,</span>
- <span class="s2">"mappings"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"255.255.255.255"</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"ccp-omg-01"</span><span class="p">,</span>
+ <span class="s">"mappings"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"resolve4"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"255.255.255.255"</span>
<span class="p">],</span>
- <span class="s2">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
+ <span class="s">"resolve6"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"FE80::0202:B3FF:FE1E:8329"</span><span class="p">,</span>
<span class="p">]</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -404,7 +401,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/hwinfo.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/hwinfo.html b/docs/latest/development/traffic_ops_api/v12/hwinfo.html
index d533362..8d8c524 100644
--- a/docs/latest/development/traffic_ops_api/v12/hwinfo.html
+++ b/docs/latest/development/traffic_ops_api/v12/hwinfo.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Hardware Info — Traffic Control 1.8.1 documentation </title>
+ <title>Hardware Info — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Parameter" href="parameter.html"/>
<link rel="prev" title="Federation" href="federation.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Hardware Info</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/hwinfo.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/hwinfo.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -234,19 +231,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
- <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:0"</span>
+ <span class="s">"serverId"</span><span class="p">:</span> <span class="s">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s">"val"</span><span class="p">:</span> <span class="s">"D1S4"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Physical Disk 0:1:0"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
- <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:1"</span>
+ <span class="s">"serverId"</span><span class="p">:</span> <span class="s">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s">"val"</span><span class="p">:</span> <span class="s">"D1S4"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Physical Disk 0:1:1"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -297,7 +294,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/influxdb.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/influxdb.html b/docs/latest/development/traffic_ops_api/v12/influxdb.html
index b1d23eb..31df294 100644
--- a/docs/latest/development/traffic_ops_api/v12/influxdb.html
+++ b/docs/latest/development/traffic_ops_api/v12/influxdb.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>InfluxDB — Traffic Control 1.8.1 documentation </title>
+ <title>InfluxDB — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Regions" href="region.html"/>
<link rel="prev" title="Profile parameters" href="profile_parameter.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>InfluxDB</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/influxdb.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/influxdb.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -219,28 +216,28 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"aaData"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"aaData"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
- <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"ALL"</span><span class="p">,</span>
- <span class="s2">"ALL"</span><span class="p">,</span>
- <span class="s2">"ALL"</span><span class="p">,</span>
- <span class="s2">"true"</span><span class="p">,</span>
- <span class="s2">"ALL"</span><span class="p">,</span>
- <span class="s2">"142035"</span><span class="p">,</span>
- <span class="s2">"172365661.85"</span>
+ <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"ALL"</span><span class="p">,</span>
+ <span class="s">"ALL"</span><span class="p">,</span>
+ <span class="s">"ALL"</span><span class="p">,</span>
+ <span class="s">"true"</span><span class="p">,</span>
+ <span class="s">"ALL"</span><span class="p">,</span>
+ <span class="s">"142035"</span><span class="p">,</span>
+ <span class="s">"172365661.85"</span>
<span class="p">],</span>
<span class="p">[</span>
<span class="mi">1</span><span class="p">,</span>
- <span class="s2">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span>
- <span class="s2">"odol-atsec-atl-03"</span><span class="p">,</span>
- <span class="s2">"us-ga-atlanta"</span><span class="p">,</span>
- <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"REPORTED"</span><span class="p">,</span>
- <span class="s2">"596"</span><span class="p">,</span>
- <span class="s2">"923510.04"</span><span class="p">,</span>
- <span class="s2">"69.241.82.126"</span>
+ <span class="s">"EDGE1_TOP_421_PSPP"</span><span class="p">,</span>
+ <span class="s">"odol-atsec-atl-03"</span><span class="p">,</span>
+ <span class="s">"us-ga-atlanta"</span><span class="p">,</span>
+ <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"REPORTED"</span><span class="p">,</span>
+ <span class="s">"596"</span><span class="p">,</span>
+ <span class="s">"923510.04"</span><span class="p">,</span>
+ <span class="s">"69.241.82.126"</span>
<span class="p">]</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -286,7 +283,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/parameter.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/parameter.html b/docs/latest/development/traffic_ops_api/v12/parameter.html
index 8283294..2e73b3c 100644
--- a/docs/latest/development/traffic_ops_api/v12/parameter.html
+++ b/docs/latest/development/traffic_ops_api/v12/parameter.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Parameter — Traffic Control 1.8.1 documentation </title>
+ <title>Parameter — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Physical Location" href="phys_location.html"/>
<link rel="prev" title="Hardware Info" href="hwinfo.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Parameter</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/parameter.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/parameter.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -234,28 +231,28 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -306,15 +303,15 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span><span class="p">,</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span><span class="p">,</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -385,28 +382,28 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -477,28 +474,28 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -676,21 +673,21 @@ The request route parameters accept 2 formats, both single paramter and paramete
<p>]</p>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1139"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+ <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span><span class="s">"1139"</span><span class="p">,</span>
+ <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value2"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param2"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1140"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile2"</span>
+ <span class="s">"value"</span><span class="p">:</span><span class="s">"value2"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span><span class="mi">1</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span><span class="s">"param2"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span><span class="s">"1140"</span><span class="p">,</span>
+ <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile2"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -801,22 +798,22 @@ The request route parameters accept 2 formats, both single paramter and paramete
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+}
</pre></div>
</div>
<p><strong>Response Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1134"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span><span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span><span class="s">"1134"</span><span class="p">,</span>
+ <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -885,17 +882,17 @@ The request route parameters accept 2 formats, both single paramter and paramete
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span>
+<div class="last highlight-python"><div class="highlight"><pre>Response Example:
-<span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span>
- <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Parameter was successfully deleted."</span>
- <span class="p">}</span>
- <span class="p">],</span>
-<span class="p">}</span>
+{
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Parameter was successfully deleted."
+ }
+ ],
+}
</pre></div>
</div>
</dd>
@@ -973,21 +970,21 @@ The request route parameters accept 2 formats, both single paramter and paramete
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+}
</pre></div>
</div>
<p><strong>Response Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"value"</span><span class="p">:</span><span class="s2">"value1"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span><span class="s2">"param1"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span><span class="s2">"1134"</span><span class="p">,</span>
- <span class="s2">"configFile"</span><span class="p">:</span><span class="s2">"configFile1"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"value"</span><span class="p">:</span><span class="s">"value1"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span><span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span><span class="s">"param1"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span><span class="s">"1134"</span><span class="p">,</span>
+ <span class="s">"configFile"</span><span class="p">:</span><span class="s">"configFile1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1038,7 +1035,7 @@ The request route parameters accept 2 formats, both single paramter and paramete
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[25/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
new file mode 100644
index 0000000..bec8f9f
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/profile.txt
@@ -0,0 +1,357 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-profile:
+
+
+Profiles
+========
+
+.. _to-api-v12-profiles-route:
+
+/api/1.2/profiles
++++++++++++++++++
+
+**GET /api/1.2/profiles**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +---------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +===============+==========+====================================================+
+ | ``param`` | no | Used to filter profiles by parameter. |
+ +---------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/profiles/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "CCR_TOP"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/profiles/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+------------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+============+================================================+
+ | ``id`` | yes | The ID of the profile. |
+ +-----------------+------------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.2/profiles**
+ Create a new empty profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +-----------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+====================================================+
+ | ``name`` | string | The name of the new profile |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``description`` | string | new profile description |
+ +-----------------------+--------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "CCR_COPY",
+ "description": "CCR_COPY description",
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+====================================================+
+ | ``id`` | string | Id of the new profile |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name of the new profile |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``description`` | string | new profile description |
+ +-----------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "66",
+ "name": "CCR_COPY",
+ "description": "CCR_COPY description",
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/name/:profile_name/copy/:profile_copy_from**
+ Copy profile to a new profile. The new profile name must not exist.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------------+----------+-------------------------------+
+ | Name | Required | Description |
+ +=======================+==========+===============================+
+ | ``profile_name`` | yes | The name of profile to copy |
+ +-----------------------+----------+-------------------------------+
+ | ``profile_copy_from`` | yes | The name of profile copy from |
+ +-----------------------+----------+-------------------------------+
+
+
+ **Response Properties**
+
+ +-----------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+====================================================+
+ | ``id`` | string | Id of the new profile |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name of the new profile |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``profileCopyFrom`` | string | The name of profile to copy |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``idCopyFrom`` | string | The id of profile to copy |
+ +-----------------------+--------+----------------------------------------------------+
+ | ``description`` | string | new profile's description (copied) |
+ +-----------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "66",
+ "name": "CCR_COPY",
+ "profileCopyFrom": "CCR1",
+ "description": "CCR_COPY description",
+ "idCopyFrom": "3"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/profiles/{:id}**
+
+ Allows user to edit a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The new name for the profile. |
+ +-----------------+----------+---------------------------------------------------+
+ | ``description`` | yes | The new description for the profile. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+ }
+
+ **Response Properties**
+
+ +------------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+==================================+
+ | ``response`` | | The updated profile info. |
+ +------------------+--------+----------------------------------+
+ | ``>id`` | string | Profile id. |
+ +------------------+--------+----------------------------------+
+ | ``>name`` | string | Profile name. |
+ +------------------+--------+----------------------------------+
+ | ``>description`` | string | Profile description. |
+ +------------------+--------+----------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +------------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "id": "219",
+ "name": "CCR_UPDATE",
+ "description": "CCR_UPDATE description"
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile was updated: 219"
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profiles/{:id}**
+
+ Allows user to delete a profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+----------------------------+
+ | Name | Required | Description |
+ +=================+==========+============================+
+ | ``id`` | yes | profile id. |
+ +-----------------+----------+----------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Profile was deleted."
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.rst.txt
deleted file mode 100644
index 31b5789..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.rst.txt
+++ /dev/null
@@ -1,457 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-profileparameters:
-
-
-Profile parameters
-==================
-
-.. _to-api-v12-profileparameters-route:
-
-/api/1.2/profileparameters
-++++++++++++++++++++++++++
-
-**POST /api/1.2/profileparameters**
-
- Associate parameter to profile.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Properties**
- This accept two formats: single profile-parameter, profile-parameter array.
-
- Single profile-parameter format:
-
- +------------------+----------+----------------------------------------------------+
- | Parameter | Required | Description |
- +==================+==========+====================================================+
- | ``profileId`` | yes | profile id. |
- +------------------+----------+----------------------------------------------------+
- | ``parameterId`` | yes | parameter id. |
- +------------------+----------+----------------------------------------------------+
-
- Profile-parameter array format:
-
- +------------------+----------+----------------------------------------------------+
- | Parameter | Required | Description |
- +==================+==========+====================================================+
- | | yes | profile-parameter array. |
- +------------------+----------+----------------------------------------------------+
- | ``>profileId`` | yes | profile id. |
- +------------------+----------+----------------------------------------------------+
- | ``>parameterId`` | yes | parameter id. |
- +------------------+----------+----------------------------------------------------+
-
- **Request Example** ::
-
- Single profile-parameter format:
-
- {
- "profileId": 2,
- "parameterId": 6
- }
-
- Profile-parameter array format:
-
- [
- {
- "profileId": 2,
- "parameterId": 6
- },
- {
- "profileId": 2,
- "parameterId": 7
- },
- {
- "profileId": 3,
- "parameterId": 6
- }
- ]
-
- **Response Properties**
-
- +-------------------+---------+-----------------------------------------------------+
- | Parameter | Type | Description |
- +===================+=========+=====================================================+
- | ``response`` | array | Profile-parameter associations. |
- +-------------------+---------+-----------------------------------------------------+
- | ``>profileId`` | string | Profile id. |
- +-------------------+---------+-----------------------------------------------------+
- | ``>parameterId`` | string | Parameter id. |
- +-------------------+---------+-----------------------------------------------------+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------------+---------+-----------------------------------------------------+
- | ``>level`` | string | success, info, warning or error. |
- +-------------------+---------+-----------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------------+---------+-----------------------------------------------------+
- | ``version`` | string | |
- +-------------------+---------+-----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response":[
- {
- "profileId": "2",
- "parameterId": "6"
- },
- {
- "profileId": "2",
- "parameterId": "7"
- },
- {
- "profileId": "3",
- "parameterId": "6"
- }
- ]
- "alerts":[
- {
- "level": "success",
- "text": "Profile parameter associations were created."
- }
- ]
- }
-
-|
-
-**DELETE /api/1.2/profileparameters/{:profile_id}/{:parameter_id}**
-
- Delete a profile parameter association.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +------------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +==================+==========+====================================================+
- | ``profile_id`` | yes | profile id. |
- +------------------+----------+----------------------------------------------------+
- | ``parameter_id`` | yes | parameter id. |
- +------------------+----------+----------------------------------------------------+
-
- **Response Properties**
-
- +-------------------+--------+-----------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=====================================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------------+--------+-----------------------------------------------------+
- | ``>level`` | string | success, info, warning or error. |
- +-------------------+--------+-----------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------------+--------+-----------------------------------------------------+
- | ``version`` | string | |
- +-------------------+--------+-----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "alerts":[
- {
- "level": "success",
- "text": "Profile parameter association was deleted."
- }
- ]
- }
-
-|
-
-**POST /api/1.2/profiles/name/{:name}/parameters**
-
- Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
- If the profile does not exist, the API returns fail.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
-
- **Request Route Parameters**
-
- +------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +============+==========+====================================================+
- | ``name`` | yes | profile name. |
- +------------+----------+----------------------------------------------------+
-
- **Request Properties**
- The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
-
- single parameter format:
-
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +=================+==========+=========+======================================================================================+
- | ``name`` | yes | string | parameter name |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``configFile`` | yes | string | parameter config_file |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``value`` | yes | string | parameter value |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- array parameters format:
-
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +=================+==========+=========+======================================================================================+
- | | yes | array | parameters array |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>name`` | yes | string | parameter name |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>configFile`` | yes | string | parameter config_file |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>value`` | yes | string | parameter value |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- **Request Example** ::
-
- 1. single parameter format exampe:
- {
- "name":"param1",
- "configFile":"configFile1",
- "value":"value1",
- "secure":0,
- }
-
- 2. array format example:
- [
- {
- "name":"param1",
- "configFile":"configFile1",
- "value":"value1",
- "secure":0,
- },
- {
- "name":"param2",
- "configFile":"configFile2",
- "value":"value2",
- "secure":1,
- }
- ]
-
-
- **Response Properties** ::
-
- +------------------+---------+--------------------------------------------------------------------------------------+
- | Name | Type | Description |
- +==================+=========+======================================================================================+
- | ``response`` | | Parameters associated with the profile. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>profileName`` | string | profile name |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>profileId`` | integer | profile index |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>parameters`` | array | parameters array |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>id`` | integer | parameter index |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>name`` | string | parameter name |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>configFile`` | string | parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>value`` | string | parameter value |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``alerts`` | array | A collection of alert messages. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>level`` | string | success, info, warning or error. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``version`` | string | |
- +------------------+---------+--------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response":{
- "profileName": "CCR1",
- "profileId" : "12",
- "parameters":[
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":"0",
- },
- {
- "name":"param2",
- "configFile":"configFile2"
- "value":"value2",
- "secure":"1",
- }
- ]
- }
- "alerts":[
- {
- "level": "success",
- "text": ""Assign parameters successfully to profile CCR1"
- }
- ]
- }
-
-|
-
-**POST /api/1.2/profiles/id/{:id}/parameters**
-
- Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
- If the profile does not exist, the API returns fail.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
-
- **Request Route Parameters**
-
- +------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +============+==========+====================================================+
- | ``id`` | yes | profile name. |
- +------------+----------+----------------------------------------------------+
-
- **Request Properties**
- The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
-
- single parameter format:
-
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +=================+==========+=========+======================================================================================+
- | ``name`` | yes | string | parameter name |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``configFile`` | yes | string | parameter config_file |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``value`` | yes | string | parameter value |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- array parameters format:
-
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +=================+==========+=========+======================================================================================+
- | | yes | array | parameters array |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>name`` | yes | string | parameter name |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>configFile`` | yes | string | parameter config_file |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>value`` | yes | string | parameter value |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- **Request Example** ::
-
- 1. single parameter format exampe:
- {
- "name":"param1",
- "configFile":"configFile1",
- "value":"value1",
- "secure":0,
- }
-
- 2. array format example:
- [
- {
- "name":"param1",
- "configFile":"configFile1",
- "value":"value1",
- "secure":0,
- },
- {
- "name":"param2",
- "configFile":"configFile2",
- "value":"value2",
- "secure":1,
- }
- ]
-
-
- **Response Properties** ::
-
- +------------------+---------+--------------------------------------------------------------------------------------+
- | Name | Type | Description |
- +==================+=========+======================================================================================+
- | ``response`` | | Parameters associated with the profile. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>profileName`` | string | profile name |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>profileId`` | integer | profile index |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>parameters`` | array | parameters array |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>id`` | integer | parameter index |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>name`` | string | parameter name |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>configFile`` | string | parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>value`` | string | parameter value |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``alerts`` | array | A collection of alert messages. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>level`` | string | success, info, warning or error. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +------------------+---------+--------------------------------------------------------------------------------------+
- | ``version`` | string | |
- +------------------+---------+--------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response":{
- "profileName": "CCR1",
- "profileId" : "12",
- "parameters":[
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":"0",
- },
- {
- "name":"param2",
- "configFile":"configFile2"
- "value":"value2",
- "secure":"1",
- }
- ]
- }
- "alerts":[
- {
- "level": "success",
- "text": ""Assign parameters successfully to profile CCR1"
- }
- ]
- }
-
-|
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
new file mode 100644
index 0000000..31b5789
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/profile_parameter.txt
@@ -0,0 +1,457 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-profileparameters:
+
+
+Profile parameters
+==================
+
+.. _to-api-v12-profileparameters-route:
+
+/api/1.2/profileparameters
+++++++++++++++++++++++++++
+
+**POST /api/1.2/profileparameters**
+
+ Associate parameter to profile.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+ This accept two formats: single profile-parameter, profile-parameter array.
+
+ Single profile-parameter format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | ``profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ Profile-parameter array format:
+
+ +------------------+----------+----------------------------------------------------+
+ | Parameter | Required | Description |
+ +==================+==========+====================================================+
+ | | yes | profile-parameter array. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>profileId`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``>parameterId`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ Single profile-parameter format:
+
+ {
+ "profileId": 2,
+ "parameterId": 6
+ }
+
+ Profile-parameter array format:
+
+ [
+ {
+ "profileId": 2,
+ "parameterId": 6
+ },
+ {
+ "profileId": 2,
+ "parameterId": 7
+ },
+ {
+ "profileId": 3,
+ "parameterId": 6
+ }
+ ]
+
+ **Response Properties**
+
+ +-------------------+---------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+=========+=====================================================+
+ | ``response`` | array | Profile-parameter associations. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>profileId`` | string | Profile id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>parameterId`` | string | Parameter id. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+---------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+---------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":[
+ {
+ "profileId": "2",
+ "parameterId": "6"
+ },
+ {
+ "profileId": "2",
+ "parameterId": "7"
+ },
+ {
+ "profileId": "3",
+ "parameterId": "6"
+ }
+ ]
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter associations were created."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/profileparameters/{:profile_id}/{:parameter_id}**
+
+ Delete a profile parameter association.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+====================================================+
+ | ``profile_id`` | yes | profile id. |
+ +------------------+----------+----------------------------------------------------+
+ | ``parameter_id`` | yes | parameter id. |
+ +------------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-----------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=====================================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------------+--------+-----------------------------------------------------+
+ | ``version`` | string | |
+ +-------------------+--------+-----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Profile parameter association was deleted."
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/name/{:name}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``name`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+
+ **Response Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>name`` | string | parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>configFile`` | string | parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>value`` | string | parameter value |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/profiles/id/{:id}/parameters**
+
+ Associate parameters to a profile. If the parameter does not exist, create it and associate to the profile. If the parameter already exists, associate it to the profile. If the parameter already associate the profile, keep the association.
+ If the profile does not exist, the API returns fail.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper. If there is parameter's secure equals 1 in the request properties, need admin role.
+
+ **Request Route Parameters**
+
+ +------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +============+==========+====================================================+
+ | ``id`` | yes | profile name. |
+ +------------+----------+----------------------------------------------------+
+
+ **Request Properties**
+ The request properties accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ array parameters format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1",
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2",
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+
+ **Response Properties** ::
+
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | Name | Type | Description |
+ +==================+=========+======================================================================================+
+ | ``response`` | | Parameters associated with the profile. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileName`` | string | profile name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>profileId`` | integer | profile index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>parameters`` | array | parameters array |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>id`` | integer | parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>name`` | string | parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>configFile`` | string | parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>value`` | string | parameter value |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+ | ``version`` | string | |
+ +------------------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "profileName": "CCR1",
+ "profileId" : "12",
+ "parameters":[
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":"1",
+ }
+ ]
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": ""Assign parameters successfully to profile CCR1"
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/region.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/region.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/region.rst.txt
deleted file mode 100644
index 2fd96d9..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/region.rst.txt
+++ /dev/null
@@ -1,235 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-region:
-
-Regions
-=======
-
-.. _to-api-v12-regions-route:
-
-/api/1.2/regions
-++++++++++++++++
-
-**GET /api/1.1/regions**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | Region ID. |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | Region name. |
- +----------------------+--------+------------------------------------------------+
- |``division`` | string | Division ID. |
- +----------------------+--------+------------------------------------------------+
- |``divisionName`` | string | Division name. |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "6",
- "name": "Atlanta",
- "division": "2",
- "divisionName": "West"
- },
- {
- "id": "7",
- "name": "Denver",
- "division": "2",
- "divisionName": "West"
- },
- ]
- }
-
-
-**GET /api/1.1/regions/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | Region id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | Region ID. |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | Region name. |
- +----------------------+--------+------------------------------------------------+
- |``division`` | string | Division ID. |
- +----------------------+--------+------------------------------------------------+
- |``divisionName`` | string | Division name. |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "6",
- "name": "Atlanta",
- "division": "2",
- "divisionName": "West"
- }
- ]
- }
-
-
-**PUT /api/1.2/regions/:id**
- Update a region
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Type | Description |
- +===================+==========+================================================+
- | ``id`` | int | Region id. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +----------------+----------+--------------------------+
- | Parameter | Required | Description |
- +================+==========+==========================+
- | ``name`` | yes | The name of the region |
- +----------------+----------+--------------------------+
- | ``division`` | yes | The division Id |
- +----------------+----------+--------------------------+
-
- **Request Example** ::
-
- {
- "name": "myregion1",
- "division": "4"
- }
-
-|
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``division`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``divisionName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Region update was successful."
- }
- ],
- "response": {
- "id": "1",
- "lastUpdated": "2014-03-18 08:57:39",
- "name": "myregion1",
- "division": "4",
- "divisionName": "mydivision1"
- }
- }
-|
-
-**POST /api/1.2/divisions/:division_name/regions**
- Create Region
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- division_name - The name of division to create new region into.
-
- ** Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Required | Description |
- +===================+==========+================================================+
- | ``division_name`` | yes | The name of division will create new region in |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +-------------------+----------+------------------------------------------+
- | Parameter | Required | Description |
- +===================+==========+==========================================+
- | ``name`` | yes | The name of the region |
- +-------------------+----------+------------------------------------------+
-
- **Request Example** ::
-
- {
- "name": "myregion1",
- }
-
-|
-
- **Response Properties**
-
- +-------------------+--------+-------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+===========================================+
- | ``name`` | string | name of region created |
- +-------------------+--------+-------------------------------------------+
- | ``id`` | string | id of region created |
- +-------------------+--------+-------------------------------------------+
- | ``divisionName`` | string | the division name the region belongs to. |
- +-------------------+--------+-------------------------------------------+
- | ``divisionId`` | string | the id of division the region belongs to. |
- +-------------------+--------+-------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- 'divisionName': 'mydivision1',
- 'divsionId': '4',
- 'name': 'myregion1',
- 'id': '19'
- }
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/region.txt b/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
new file mode 100644
index 0000000..2fd96d9
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/region.txt
@@ -0,0 +1,235 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-region:
+
+Regions
+=======
+
+.. _to-api-v12-regions-route:
+
+/api/1.2/regions
+++++++++++++++++
+
+**GET /api/1.1/regions**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ },
+ {
+ "id": "7",
+ "name": "Denver",
+ "division": "2",
+ "divisionName": "West"
+ },
+ ]
+ }
+
+
+**GET /api/1.1/regions/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Region id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ }
+ ]
+ }
+
+
+**PUT /api/1.2/regions/:id**
+ Update a region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Region id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +================+==========+==========================+
+ | ``name`` | yes | The name of the region |
+ +----------------+----------+--------------------------+
+ | ``division`` | yes | The division Id |
+ +----------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ "division": "4"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``division`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Region update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "myregion1",
+ "division": "4",
+ "divisionName": "mydivision1"
+ }
+ }
+|
+
+**POST /api/1.2/divisions/:division_name/regions**
+ Create Region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ division_name - The name of division to create new region into.
+
+ ** Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +===================+==========+================================================+
+ | ``division_name`` | yes | The name of division will create new region in |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+==========================================+
+ | ``name`` | yes | The name of the region |
+ +-------------------+----------+------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+===========================================+
+ | ``name`` | string | name of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``id`` | string | id of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionName`` | string | the division name the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionId`` | string | the id of division the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'divisionName': 'mydivision1',
+ 'divsionId': '4',
+ 'name': 'myregion1',
+ 'id': '19'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/role.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/role.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/role.rst.txt
deleted file mode 100644
index b993c97..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/role.rst.txt
+++ /dev/null
@@ -1,59 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-roles:
-
-Roles
-=====
-
-.. _to-api-v12-roles-route:
-
-/api/1.2/roles
-++++++++++++++
-
-**GET /api/1.2/roles.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``privLevel`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``description`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "read-only",
- "id": "2",
- "privLevel": "10",
- "description": "read-only user"
- }
- ]
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/role.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/role.txt b/docs/latest/_sources/development/traffic_ops_api/v12/role.txt
new file mode 100644
index 0000000..b993c97
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/role.txt
@@ -0,0 +1,59 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-roles:
+
+Roles
+=====
+
+.. _to-api-v12-roles-route:
+
+/api/1.2/roles
+++++++++++++++
+
+**GET /api/1.2/roles.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``privLevel`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "read-only",
+ "id": "2",
+ "privLevel": "10",
+ "description": "read-only user"
+ }
+ ]
+ }
+
+|
[36/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/region.txt b/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
new file mode 100644
index 0000000..faddbb1
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/region.txt
@@ -0,0 +1,235 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-region:
+
+Regions
+=======
+
+.. _to-api-v11-regions-route:
+
+/api/1.1/regions
+++++++++++++++++
+
+**GET /api/1.1/regions**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ },
+ {
+ "id": "7",
+ "name": "Denver",
+ "division": "2",
+ "divisionName": "West"
+ },
+ ]
+ }
+
+
+**GET /api/1.1/regions/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Region id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | Region ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | Region name. |
+ +----------------------+--------+------------------------------------------------+
+ |``division`` | string | Division ID. |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | Division name. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "6",
+ "name": "Atlanta",
+ "division": "2",
+ "divisionName": "West"
+ }
+ ]
+ }
+
+
+**PUT /api/1.1/regions/:id**
+ Update a region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Region id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +================+==========+==========================+
+ | ``name`` | yes | The name of the region |
+ +----------------+----------+--------------------------+
+ | ``division`` | yes | The division Id |
+ +----------------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ "division": "4"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``division`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``divisionName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Region update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "myregion1",
+ "division": "4",
+ "divisionName": "mydivision1"
+ }
+ }
+|
+
+**POST /api/1.1/divisions/:division_name/regions**
+ Create Region
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ division_name - The name of division to create new region into.
+
+ ** Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +===================+==========+================================================+
+ | ``division_name`` | yes | The name of division will create new region in |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+==========================================+
+ | ``name`` | yes | The name of the region |
+ +-------------------+----------+------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "myregion1",
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+===========================================+
+ | ``name`` | string | name of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``id`` | string | id of region created |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionName`` | string | the division name the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+ | ``divisionId`` | string | the id of division the region belongs to. |
+ +-------------------+--------+-------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'divisionName': 'mydivision1',
+ 'divsionId': '4',
+ 'name': 'myregion1',
+ 'id': '19'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/role.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/role.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/role.rst.txt
deleted file mode 100644
index bf3337c..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/role.rst.txt
+++ /dev/null
@@ -1,58 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-roles:
-
-Roles
-=====
-
-.. _to-api-v11-roles-route:
-
-/api/1.1/roles
-++++++++++++++
-
-**GET /api/1.1/roles.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``privLevel`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``description`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "read-only",
- "id": "2",
- "privLevel": "10",
- "description": "read-only user"
- }
- ],
- }
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/role.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/role.txt b/docs/latest/_sources/development/traffic_ops_api/v11/role.txt
new file mode 100644
index 0000000..bf3337c
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/role.txt
@@ -0,0 +1,58 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-roles:
+
+Roles
+=====
+
+.. _to-api-v11-roles-route:
+
+/api/1.1/roles
+++++++++++++++
+
+**GET /api/1.1/roles.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``privLevel`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "read-only",
+ "id": "2",
+ "privLevel": "10",
+ "description": "read-only user"
+ }
+ ],
+ }
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/server.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/server.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/server.rst.txt
deleted file mode 100644
index 44f1292..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/server.rst.txt
+++ /dev/null
@@ -1,630 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-server:
-
-Server
-======
-
-.. _to-api-v11-servers-route:
-
-/api/1.1/servers
-++++++++++++++++
-
-**GET /api/1.1/servers**
-
- Retrieves properties of CDN servers.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +--------------------+----------+---------------------------------------------+
- | Name | Required | Description |
- +====================+==========+=============================================+
- | ``dsId`` | no | Used to filter servers by delivery service. |
- +--------------------+----------+---------------------------------------------+
- | ``status`` | no | Used to filter servers by status. |
- +--------------------+----------+---------------------------------------------+
- | ``type`` | no | Used to filter servers by type. |
- +--------------------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+============================================================================================================+
- | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cachegroupId`` | string | The cache group id. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``domainName`` | string | The domain name part of the FQDN of the cache. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``guid`` | string | An identifier used to uniquely identify the server. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``hostName`` | string | The host name part of the cache. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The server id (database row number). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloUsername`` | string | The user name for lights-out-management. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``interfaceName`` | string | The network interface name used for serving traffic. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``rack`` | string | A string indicating rack location. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``routerHostName`` | string | The human readable name of the router. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``routerPortName`` | string | The human readable name of the router port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``updPending`` | bool | |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "cachegroup": "us-il-chicago",
- "cachegroupId": "3",
- "cdnId": "3",
- "cdnName": "CDN-1",
- "domainName": "chi.kabletown.net",
- "guid": null,
- "hostName": "atsec-chi-00",
- "id": "19",
- "iloIpAddress": "172.16.2.6",
- "iloIpGateway": "172.16.2.1",
- "iloIpNetmask": "255.255.255.0",
- "iloPassword": "********",
- "iloUsername": "",
- "interfaceMtu": "9000",
- "interfaceName": "bond0",
- "ip6Address": "2033:D0D0:3300::2:2/64",
- "ip6Gateway": "2033:D0D0:3300::2:1",
- "ipAddress": "10.10.2.2",
- "ipGateway": "10.10.2.1",
- "ipNetmask": "255.255.255.0",
- "lastUpdated": "2015-03-08 15:57:32",
- "mgmtIpAddress": "",
- "mgmtIpGateway": "",
- "mgmtIpNetmask": "",
- "offlineReason": "N/A",
- "physLocation": "plocation-chi-1",
- "physLocationId": "9",
- "profile": "EDGE1_CDN1_421_SSL",
- "profileDesc": "EDGE1_CDN1_421_SSL profile",
- "profileId": "12",
- "rack": "RR 119.02",
- "routerHostName": "rtr-chi.kabletown.net",
- "routerPortName": "2",
- "status": "ONLINE",
- "statusId": "6",
- "tcpPort": "80",
- "httpsPort": "443",
- "type": "EDGE",
- "typeId": "3",
- "updPending": false
- },
- {
- ... more server data
- }
- ]
- }
-
-|
-
-**GET /api/1.1/servers/:id**
-
- Retrieves properties of a CDN server by server ID.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | Server id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+============================================================================================================+
- | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cachegroupId`` | string | The cache group id. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``domainName`` | string | The domain name part of the FQDN of the cache. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``guid`` | string | An identifier used to uniquely identify the server. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``hostName`` | string | The host name part of the cache. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The server id (database row number). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``iloUsername`` | string | The user name for lights-out-management. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``interfaceName`` | string | The network interface name used for serving traffic. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``rack`` | string | A string indicating rack location. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``routerHostName`` | string | The human readable name of the router. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``routerPortName`` | string | The human readable name of the router port. |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
- | ``updPending`` | bool | |
- +--------------------+--------+------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "cachegroup": "us-il-chicago",
- "cachegroupId": "3",
- "cdnId": "3",
- "cdnName": "CDN-1",
- "domainName": "chi.kabletown.net",
- "guid": null,
- "hostName": "atsec-chi-00",
- "id": "19",
- "iloIpAddress": "172.16.2.6",
- "iloIpGateway": "172.16.2.1",
- "iloIpNetmask": "255.255.255.0",
- "iloPassword": "********",
- "iloUsername": "",
- "interfaceMtu": "9000",
- "interfaceName": "bond0",
- "ip6Address": "2033:D0D0:3300::2:2/64",
- "ip6Gateway": "2033:D0D0:3300::2:1",
- "ipAddress": "10.10.2.2",
- "ipGateway": "10.10.2.1",
- "ipNetmask": "255.255.255.0",
- "lastUpdated": "2015-03-08 15:57:32",
- "mgmtIpAddress": "",
- "mgmtIpGateway": "",
- "mgmtIpNetmask": "",
- "offlineReason": "N/A",
- "physLocation": "plocation-chi-1",
- "physLocationId": "9",
- "profile": "EDGE1_CDN1_421_SSL",
- "profileDesc": "EDGE1_CDN1_421_SSL profile",
- "profileId": "12",
- "rack": "RR 119.02",
- "routerHostName": "rtr-chi.kabletown.net",
- "routerPortName": "2",
- "status": "ONLINE",
- "statusId": "6",
- "tcpPort": "80",
- "httpsPort": "443",
- "type": "EDGE",
- "typeId": "3",
- "updPending": false
- }
- ]
- }
-
-|
-
-
-**GET /api/1.1/servers/summary**
-
- Retrieves a count of CDN servers by type.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------+--------+------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +===========+========+========================================================================+
- | ``count`` | int | The number of servers of this type in this instance of Traffic Ops. |
- +-----------+--------+------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of the server count (see :ref:`to-api-v11-type`). |
- +-----------+--------+------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "count": 4,
- "type": "CCR"
- },
- {
- "count": 55,
- "type": "EDGE"
- },
- {
- "type": "MID",
- "count": 18
- },
- {
- "count": 0,
- "type": "INFLUXDB"
- },
- {
- "count": 4,
- "type": "RASCAL"
- }
- }
-
-|
-
-**GET /api/1.1/servers/hostname/:name/details**
-
- Retrieves the details of a server.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------+----------+----------------------------------+
- | Name | Required | Description |
- +==========+==========+==================================+
- | ``name`` | yes | The host name part of the cache. |
- +----------+----------+----------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+=============================================================================================================+
- | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``deliveryservices`` | array | Array of strings with the delivery service ids assigned (see :ref:`to-api-v11-ds`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``domainName`` | string | The domain name part of the FQDN of the cache. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``hardwareInfo`` | hash | Hwinfo struct (see :ref:`to-api-v11-hwinfo`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``hostName`` | string | The host name part of the cache. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The server id (database row number). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``iloUsername`` | string | The user name for lights-out-management. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``interfaceName`` | string | The network interface name used for serving traffic. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time/Date of the last update for this server. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``rack`` | string | A string indicating rack location. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``routerHostName`` | string | The human readable name of the router. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``routerPortName`` | string | The human readable name of the router port. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``xmppId`` | string | Deprecated. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
- | ``xmppPasswd`` | string | Deprecated. |
- +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "cachegroup": "us-il-chicago",
- "deliveryservices": [
- "1",
- "2",
- "3",
- "4"
- ],
- "domainName": "chi.kabletown.net",
- "hardwareInfo": {
- "Physical Disk 0:1:3": "D1S2",
- "Physical Disk 0:1:2": "D1S2",
- "Physical Disk 0:1:15": "D1S2",
- "Power Supply.Slot.2": "04.07.15",
- "Physical Disk 0:1:24": "YS08",
- "Physical Disk 0:1:1": "D1S2",
- "Model": "PowerEdge R720xd",
- "Physical Disk 0:1:22": "D1S2",
- "Physical Disk 0:1:18": "D1S2",
- "Enterprise UEFI Diagnostics": "4217A5",
- "Lifecycle Controller": "1.0.8.42",
- "Physical Disk 0:1:8": "D1S2",
- "Manufacturer": "Dell Inc.",
- "Physical Disk 0:1:6": "D1S2",
- "SysMemTotalSize": "196608",
- "PopulatedDIMMSlots": "24",
- "Physical Disk 0:1:20": "D1S2",
- "Intel(R) Ethernet 10G 2P X520 Adapter": "13.5.7",
- "Physical Disk 0:1:14": "D1S2",
- "BACKPLANE FIRMWARE": "1.00",
- "Dell OS Drivers Pack, 7.0.0.29, A00": "7.0.0.29",
- "Integrated Dell Remote Access Controller": "1.57.57",
- "Physical Disk 0:1:5": "D1S2",
- "ServiceTag": "D6XPDV1",
- "PowerState": "2",
- "Physical Disk 0:1:23": "D1S2",
- "Physical Disk 0:1:25": "D903",
- "BIOS": "1.3.6",
- "Physical Disk 0:1:12": "D1S2",
- "System CPLD": "1.0.3",
- "Physical Disk 0:1:4": "D1S2",
- "Physical Disk 0:1:0": "D1S2",
- "Power Supply.Slot.1": "04.07.15",
- "PERC H710P Mini": "21.0.2-0001",
- "PowerCap": "689",
- "Physical Disk 0:1:16": "D1S2",
- "Physical Disk 0:1:10": "D1S2",
- "Physical Disk 0:1:11": "D1S2",
- "Lifecycle Controller 2": "1.0.8.42",
- "BP12G+EXP 0:1": "1.07",
- "Physical Disk 0:1:9": "D1S2",
- "Physical Disk 0:1:17": "D1S2",
- "Broadcom Gigabit Ethernet BCM5720": "7.2.20",
- "Physical Disk 0:1:21": "D1S2",
- "Physical Disk 0:1:13": "D1S2",
- "Physical Disk 0:1:7": "D1S2",
- "Physical Disk 0:1:19": "D1S2"
- },
- "hostName": "atsec-chi-00",
- "id": "19",
- "iloIpAddress": "172.16.2.6",
- "iloIpGateway": "172.16.2.1",
- "iloIpNetmask": "255.255.255.0",
- "iloPassword": "********",
- "iloUsername": "",
- "interfaceMtu": "9000",
- "interfaceName": "bond0",
- "ip6Address": "2033:D0D0:3300::2:2/64",
- "ip6Gateway": "2033:D0D0:3300::2:1",
- "ipAddress": "10.10.2.2",
- "ipGateway": "10.10.2.1",
- "ipNetmask": "255.255.255.0",
- "mgmtIpAddress": "",
- "mgmtIpGateway": "",
- "mgmtIpNetmask": "",
- "physLocation": "plocation-chi-1",
- "profile": "EDGE1_CDN1_421_SSL",
- "rack": "RR 119.02",
- "routerHostName": "rtr-chi.kabletown.net",
- "routerPortName": "2",
- "status": "ONLINE",
- "tcpPort": "80",
- "httpsPort": "443",
- "type": "EDGE",
- "xmppId": "atsec-chi-00-dummyxmpp",
- "xmppPasswd": "X"
-
- }
- }
-
-|
-
-**POST /api/1.1/servercheck**
-
- Post a server check result to the serverchecks table.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------------------------+----------+-------------+
- | Name | Required | Description |
- +============================+==========+=============+
- | ``id`` | yes | |
- +----------------------------+----------+-------------+
- | ``host_name`` | yes | |
- +----------------------------+----------+-------------+
- | ``servercheck_short_name`` | yes | |
- +----------------------------+----------+-------------+
- | ``value`` | yes | |
- +----------------------------+----------+-------------+
-
- **Request Example** ::
-
- {
- "id": "",
- "host_name": "",
- "servercheck_short_name": "",
- "value": ""
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
-
- Response Example:
-
- {
- "alerts":
- [
- {
- "level": "success",
- "text": "Server Check was successfully updated."
- }
- ],
- }
-
[04/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/cdn.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/cdn.html b/docs/latest/development/traffic_ops_api/v12/cdn.html
index 694380c..409368a 100644
--- a/docs/latest/development/traffic_ops_api/v12/cdn.html
+++ b/docs/latest/development/traffic_ops_api/v12/cdn.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>CDN — Traffic Control 1.8.1 documentation </title>
+ <title>CDN — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Change Logs" href="changelog.html"/>
<link rel="prev" title="Cache Statistics" href="cache_stats.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>CDN</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/cdn.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/cdn.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -230,22 +227,22 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "1"
+ "name": "over-the-top",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -309,16 +306,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -382,16 +379,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -430,9 +427,9 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"cdn_test"</span><span class="p">,</span>
+ <span class="s">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -481,19 +478,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
- <span class="p">},</span>
- <span class="s2">"alerts"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"cdn was created."</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response":{
+ "name": "cdn_test",
+ "id": 3
+ "dnssecEnabled": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was created."
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -552,9 +549,9 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test2"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"cdn_test2"</span><span class="p">,</span>
+ <span class="s">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -603,19 +600,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn_test2"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="mi">3</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="mi">0</span>
- <span class="p">},</span>
- <span class="s2">"alerts"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"cdn was updated."</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response":{
+ "name": "cdn_test2",
+ "id": 3
+ "dnssecEnabled": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was updated."
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -676,11 +673,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"cdn was deleted."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"cdn was deleted."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -740,20 +737,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -833,20 +830,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -891,11 +888,11 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
- <span class="s2">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
- <span class="s2">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
+ <span class="s">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
+ <span class="s">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -942,12 +939,12 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1005,14 +1002,14 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1126,20 +1123,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
- <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
+ <span class="s">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
<span class="p">},</span>
- <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="mi">1425135900000</span><span class="p">,</span>
<span class="mf">1668.03</span>
@@ -1149,7 +1146,7 @@ group.</td>
<span class="n">null</span>
<span class="p">]</span>
<span class="p">],</span>
- <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"Origin TPS"</span>
+ <span class="s">"label"</span><span class="p">:</span> <span class="s">"Origin TPS"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1203,21 +1200,21 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
- <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"404"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_FOO"</span><span class="p">,</span>
- <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for foo.domain.net"</span><span class="p">,</span>
- <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"foo.domain.net"</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
+ <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"404"</span><span class="p">,</span>
+ <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_FOO"</span><span class="p">,</span>
+ <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for foo.domain.net"</span><span class="p">,</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"foo.domain.net"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"405"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_BAR"</span><span class="p">,</span>
- <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for bar.domain.net"</span><span class="p">,</span>
- <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"bar.domain.net"</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"405"</span><span class="p">,</span>
+ <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_BAR"</span><span class="p">,</span>
+ <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for bar.domain.net"</span><span class="p">,</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"bar.domain.net"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1287,7 +1284,7 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
@@ -1549,7 +1546,7 @@ profiles.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
@@ -1964,7 +1961,7 @@ services.</td>
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
</pre></div>
</div>
<div class="line-block">
@@ -2063,51 +2060,51 @@ services.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cdn1"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
- <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
- <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
- <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
- <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span>
- <span class="p">},</span>
- <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span><span class="p">,</span>
- <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
- <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
- <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
- <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
- <span class="n">dsRecord</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"algorithm"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
- <span class="s2">"digestType"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"digest"</span><span class="p">:</span> <span class="s2">"abc123def456"</span>
- <span class="p">}</span>
- <span class="p">}</span>
- <span class="p">},</span>
- <span class="s2">"ds-01"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
- <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
- <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
- <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
- <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span>
- <span class="p">},</span>
- <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span><span class="p">,</span>
- <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
- <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
- <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
- <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span>
- <span class="p">}</span>
- <span class="p">},</span>
- <span class="o">...</span> <span class="n">repeated</span> <span class="k">for</span> <span class="n">each</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">cdn</span>
- <span class="p">},</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": {
+ "cdn1": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750",
+ "ttl": "60",
+ dsRecord: {
+ "algorithm": "5",
+ "digestType": "2",
+ "digest": "abc123def456"
+ }
+ }
+ },
+ "ds-01": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "ds-01.foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "ds-01.foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750"
+ }
+ },
+ ... repeated for each ds in the cdn
+ },
+}
</pre></div>
</div>
</div></blockquote>
@@ -2160,8 +2157,8 @@ services.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted dnssec keys for <cdn>"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully deleted dnssec keys for <cdn>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -2211,13 +2208,13 @@ services.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
- <span class="s2">"name"</span> <span class="s2">"ott.kabletown.com"</span><span class="p">,</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
- <span class="s2">"kskExpirationDays"</span><span class="p">:</span> <span class="s2">"365"</span><span class="p">,</span>
- <span class="s2">"zskExpirationDays"</span><span class="p">:</span> <span class="s2">"90"</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "key": "cdn1",
+ "name" "ott.kabletown.com",
+ "ttl": "60",
+ "kskExpirationDays": "365",
+ "zskExpirationDays": "90"
+}
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
@@ -2245,8 +2242,8 @@ services.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created dnssec keys for cdn1"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully created dnssec keys for cdn1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -2312,20 +2309,20 @@ services.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"ds1"</span><span class="p">,</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"base64encodedcrt1"</span><span class="p">,</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"base64encodedkey1"</span>
+ <span class="s">"deliveryservice"</span><span class="p">:</span> <span class="s">"ds1"</span><span class="p">,</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"base64encodedcrt1"</span><span class="p">,</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"base64encodedkey1"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"ds2"</span><span class="p">,</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"base64encodedcrt2"</span><span class="p">,</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"base64encodedkey2"</span>
+ <span class="s">"deliveryservice"</span><span class="p">:</span> <span class="s">"ds2"</span><span class="p">,</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"base64encodedcrt2"</span><span class="p">,</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"base64encodedkey2"</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="p">]</span>
@@ -2377,7 +2374,7 @@ services.</td>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/changelog.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/changelog.html b/docs/latest/development/traffic_ops_api/v12/changelog.html
index 28956b8..655c4bc 100644
--- a/docs/latest/development/traffic_ops_api/v12/changelog.html
+++ b/docs/latest/development/traffic_ops_api/v12/changelog.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Change Logs — Traffic Control 1.8.1 documentation </title>
+ <title>Change Logs — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Delivery Service" href="deliveryservice.html"/>
<link rel="prev" title="CDN" href="cdn.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Change Logs</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/changelog.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/changelog.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -238,23 +235,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
- <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
+ <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
+ <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
- <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
+ <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
+ <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
<span class="p">},</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -329,23 +326,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
- <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
+ <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
+ <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
- <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
+ <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
+ <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -380,9 +377,9 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -429,7 +426,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[03/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
index 005fd00..ee2134f 100644
--- a/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
+++ b/docs/latest/development/traffic_ops_api/v12/deliveryservice.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Delivery Service — Traffic Control 1.8.1 documentation </title>
+ <title>Delivery Service — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Delivery Service Statistics" href="deliveryservice_stats.html"/>
<link rel="prev" title="Change Logs" href="changelog.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Delivery Service</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/deliveryservice.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -368,11 +365,11 @@ available).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
@@ -470,77 +467,77 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
- <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
- <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
- <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
- <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
- <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
- <span class="p">],</span>
- <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
- <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
- <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
- <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
- <span class="p">}</span>
- <span class="p">],</span>
- <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
- <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
- <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
- <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
- <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
- <span class="p">}</span>
- <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
- <span class="p">{</span> <span class="o">..</span> <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -730,11 +727,11 @@ available).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
@@ -832,72 +829,72 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
- <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
- <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
- <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
- <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
- <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="s">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"ccrDnsTtl"</span><span class="p">:</span> <span class="s">"3600"</span><span class="p">,</span>
+ <span class="s">"cdnId"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
+ <span class="s">"checkPath"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"displayName"</span><span class="p">:</span> <span class="s">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s">"dnsBypassCname"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"dnsBypassIp"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"dnsBypassIp6"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"dnsBypassTtl"</span><span class="p">:</span> <span class="s">"30"</span><span class="p">,</span>
+ <span class="s">"dscp"</span><span class="p">:</span> <span class="s">"40"</span><span class="p">,</span>
+ <span class="s">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"http://edge.foo-ds.foo.bar.net"</span>
<span class="p">],</span>
- <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
- <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
- <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"geoLimit"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"geoProvider"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"globalMaxTps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"httpBypassFqdn"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"442"</span><span class="p">,</span>
+ <span class="s">"infoUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"initialDispersion"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"longDesc"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"longDesc1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"longDesc2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"matchList"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
- <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">.foo-ds</span><span class="se">\\</span><span class="s">..*"</span><span class="p">,</span>
+ <span class="s">"setNumber"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"HOST_REGEXP"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
- <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
- <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
- <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
- <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="s">"maxDnsAnswers"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"missLat"</span><span class="p">:</span> <span class="s">"41.881944"</span><span class="p">,</span>
+ <span class="s">"missLong"</span><span class="p">:</span> <span class="s">"-87.627778"</span><span class="p">,</span>
+ <span class="s">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"orgServerFqdn"</span><span class="p">:</span> <span class="s">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
+ <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s">"protocol"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"qstringIgnore"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"rangeRequestHandling"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"sslKeyVersion"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"trResponseHeaders"</span><span class="p">:</span> <span class="s">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"HTTP"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"foo-ds"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -964,18 +961,18 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"failover"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
- <span class="s2">"destination"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"location"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"DNS"</span><span class="p">,</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"failover"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s">"destination"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"location"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"DNS"</span><span class="p">,</span>
<span class="p">},</span>
- <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="s">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"enabled"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s">"enabled"</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1031,20 +1028,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -1117,12 +1114,12 @@ delivery service that is down for maintenance.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1211,17 +1208,17 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"fed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"regionalAlternate"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"regionalDenied"</span><span class="p">:</span> <span class="mi">0</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"fed"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"regionalAlternate"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"regionalDenied"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1287,22 +1284,22 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
- <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</span><span class="p">,</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s">"orderby"</span><span class="p">:</span> <span class="s">"deliveryservice"</span><span class="p">,</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span>
- <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:43"</span><span class="p">,</span>
+ <span class="s">"server"</span><span class="p">:</span> <span class="s">"20"</span><span class="p">,</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span>
- <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:44"</span><span class="p">,</span>
+ <span class="s">"server"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
<span class="p">},</span>
<span class="p">],</span>
- <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s">"limit"</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1411,20 +1408,20 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
- <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
+ <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</span>
<span class="p">},</span>
- <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
- <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
- <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
+ <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
+ <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
+ <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1534,20 +1531,20 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
- <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
+ <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</span>
<span class="p">},</span>
- <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
- <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
- <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
+ <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
+ <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
+ <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1621,8 +1618,8 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted ssl keys for <xml_id>"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully deleted ssl keys for <xml_id>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1684,20 +1681,20 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
- <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
- <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"ds-01"</span><span class="p">,</span>
+ <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN Engineering"</span><span class="p">,</span>
+ <span class="s">"version"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"some_key"</span><span class="p">,</span>
+ <span class="s">"csr"</span><span class="p">:</span> <span class="s">"some_csr"</span><span class="p">,</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"some_crt"</span>
<span class="p">},</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
- <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"Kabletown"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
+ <span class="s">"organization"</span><span class="p">:</span> <span class="s">"Kabletown"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1731,8 +1728,8 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created ssl keys for ds-01"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully created ssl keys for ds-01"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1782,13 +1779,13 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
- <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"ds-01"</span><span class="p">,</span>
+ <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"some_key"</span><span class="p">,</span>
+ <span class="s">"csr"</span><span class="p">:</span> <span class="s">"some_csr"</span><span class="p">,</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"some_crt"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1823,8 +1820,8 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully added ssl keys for ds-01"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully added ssl keys for ds-01"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1993,39 +1990,39 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"emailTo"</span><span class="p">:</span> <span class="s2">"foo@bar.com"</span><span class="p">,</span>
- <span class="s2">"details"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"customer"</span><span class="p">:</span> <span class="s2">"XYZ Corporation"</span><span class="p">,</span>
- <span class="s2">"contentType"</span><span class="p">:</span> <span class="s2">"video-on-demand"</span><span class="p">,</span>
- <span class="s2">"deliveryProtocol"</span><span class="p">:</span> <span class="s2">"http"</span><span class="p">,</span>
- <span class="s2">"routingType"</span><span class="p">:</span> <span class="s2">"dns"</span><span class="p">,</span>
- <span class="s2">"serviceDesc"</span><span class="p">:</span> <span class="s2">"service description goes here"</span><span class="p">,</span>
- <span class="s2">"peakBPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-5-Gbps"</span><span class="p">,</span>
- <span class="s2">"peakTPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-1000-TPS"</span><span class="p">,</span>
- <span class="s2">"maxLibrarySizeEstimate"</span><span class="p">:</span> <span class="s2">"less-than-200-GB"</span><span class="p">,</span>
- <span class="s2">"originURL"</span><span class="p">:</span> <span class="s2">"http://myorigin.com"</span><span class="p">,</span>
- <span class="s2">"hasOriginDynamicRemap"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"originTestFile"</span><span class="p">:</span> <span class="s2">"http://myorigin.com/crossdomain.xml"</span><span class="p">,</span>
- <span class="s2">"hasOriginACLWhitelist"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"originHeaders"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"otherOriginSecurity"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"queryStringHandling"</span><span class="p">:</span> <span class="s2">"ignore-in-cache-key-and-pass-up"</span><span class="p">,</span>
- <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"range-requests-not-used"</span><span class="p">,</span>
- <span class="s2">"hasSignedURLs"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"hasNegativeCachingCustomization"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"negativeCachingCustomizationNote"</span><span class="p">:</span> <span class="s2">"negative caching instructions"</span><span class="p">,</span>
- <span class="s2">"serviceAliases"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"http://alias1.com"</span><span class="p">,</span>
- <span class="s2">"http://alias2.com"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"emailTo"</span><span class="p">:</span> <span class="s">"foo@bar.com"</span><span class="p">,</span>
+ <span class="s">"details"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"customer"</span><span class="p">:</span> <span class="s">"XYZ Corporation"</span><span class="p">,</span>
+ <span class="s">"contentType"</span><span class="p">:</span> <span class="s">"video-on-demand"</span><span class="p">,</span>
+ <span class="s">"deliveryProtocol"</span><span class="p">:</span> <span class="s">"http"</span><span class="p">,</span>
+ <span class="s">"routingType"</span><span class="p">:</span> <span class="s">"dns"</span><span class="p">,</span>
+ <span class="s">"serviceDesc"</span><span class="p">:</span> <span class="s">"service description goes here"</span><span class="p">,</span>
+ <span class="s">"peakBPSEstimate"</span><span class="p">:</span> <span class="s">"less-than-5-Gbps"</span><span class="p">,</span>
+ <span class="s">"peakTPSEstimate"</span><span class="p">:</span> <span class="s">"less-than-1000-TPS"</span><span class="p">,</span>
+ <span class="s">"maxLibrarySizeEstimate"</span><span class="p">:</span> <span class="s">"less-than-200-GB"</span><span class="p">,</span>
+ <span class="s">"originURL"</span><span class="p">:</span> <span class="s">"http://myorigin.com"</span><span class="p">,</span>
+ <span class="s">"hasOriginDynamicRemap"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"originTestFile"</span><span class="p">:</span> <span class="s">"http://myorigin.com/crossdomain.xml"</span><span class="p">,</span>
+ <span class="s">"hasOriginACLWhitelist"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"originHeaders"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"otherOriginSecurity"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"queryStringHandling"</span><span class="p">:</span> <span class="s">"ignore-in-cache-key-and-pass-up"</span><span class="p">,</span>
+ <span class="s">"rangeRequestHandling"</span><span class="p">:</span> <span class="s">"range-requests-not-used"</span><span class="p">,</span>
+ <span class="s">"hasSignedURLs"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"hasNegativeCachingCustomization"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"negativeCachingCustomizationNote"</span><span class="p">:</span> <span class="s">"negative caching instructions"</span><span class="p">,</span>
+ <span class="s">"serviceAliases"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"http://alias1.com"</span><span class="p">,</span>
+ <span class="s">"http://alias2.com"</span>
<span class="p">],</span>
- <span class="s2">"rateLimitingGBPS"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
- <span class="s2">"rateLimitingTPS"</span><span class="p">:</span> <span class="mi">5000</span><span class="p">,</span>
- <span class="s2">"overflowService"</span><span class="p">:</span> <span class="s2">"http://overflowcdn.com"</span><span class="p">,</span>
- <span class="s2">"headerRewriteEdge"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"headerRewriteMid"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"headerRewriteRedirectRouter"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"notes"</span><span class="p">:</span> <span class="s2">""</span>
+ <span class="s">"rateLimitingGBPS"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
+ <span class="s">"rateLimitingTPS"</span><span class="p">:</span> <span class="mi">5000</span><span class="p">,</span>
+ <span class="s">"overflowService"</span><span class="p">:</span> <span class="s">"http://overflowcdn.com"</span><span class="p">,</span>
+ <span class="s">"headerRewriteEdge"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"headerRewriteMid"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"headerRewriteRedirectRouter"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"notes"</span><span class="p">:</span> <span class="s">""</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -2068,11 +2065,11 @@ regional geoblocking URL.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery Service request sent to foo@bar.com."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Delivery Service request sent to foo@bar.com."</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -2348,100 +2345,100 @@ be a HIT)</li>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"my_ds_1"</span><span class="p">,</span>
- <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"my_ds_displayname_1"</span><span class="p">,</span>
- <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://10.75.168.91"</span><span class="p">,</span>
- <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR_CDN1"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
- <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"active"</span><span class="p">:</span> <span class="s2">"false"</span><span class="p">,</span>
- <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
- <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.ds_1</span><span class="se">\\</span><span class="s2">..*"</span>
- <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
- <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.my_vod1</span><span class="se">\\</span><span class="s2">..*"</span>
- <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"1"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "xmlId": "my_ds_1",
+ "displayName": "my_ds_displayname_1",
+ "protocol": "1",
+ "orgServerFqdn": "http://10.75.168.91",
+ "cdnName": "cdn_number_1",
+ "profileName": "CCR_CDN1",
+ "type": "HTTP",
+ "multiSiteOrigin": "0",
+ "active": "false",
+ "matchList": [
+ {
+ "type": "HOST_REGEXP",
+ "pattern": ".*\\.ds_1\\..*"
+ "setNumber": "0"
+ },
+ {
+ "type": "HOST_REGEXP",
+ "pattern": ".*\\.my_vod1\\..*"
+ "setNumber": "1"
+ }
+ ]
+}
</pre></div>
</div>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:{</span>
- <span class="s2">"xmlId"</span><span class="p">:</span><span class="s2">"my_ds_1"</span><span class="p">,</span>
- <span class="s2">"active"</span><span class="p">:</span><span class="s2">"false"</span><span class="p">,</span>
- <span class="s2">"protocol"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"missLong"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"maxDnsAnswers"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR_CDN1"</span><span class="p">,</span>
- <span class="s2">"multiSiteOrigin"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp6"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"globalMaxTps"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"orgServerFqdn"</span><span class="p">:</span><span class="s2">"http:\/\/10.75.168.91"</span><span class="p">,</span>
- <span class="s2">"infoUrl"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"rangeRequestHandling"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span><span class="s2">"311"</span><span class="p">,</span>
- <span class="s2">"trResponseHeaders"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"midHeaderRewrite"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"longDesc"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"httpBypassFqdn"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"cdnName"</span><span class="p">:</span><span class="s2">"cdn_number_1"</span><span class="p">,</span>
- <span class="s2">"protocol"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"missLat"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"globalMaxMbps"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"initialDispersion"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span><span class="s2">"HTTP"</span><span class="p">,</span>
- <span class="s2">"geoLimit"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"dnsBypassTtl"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"dnsBypassCname"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"ccrDnsTtl"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"longDesc2"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"remapText"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"longDesc1"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"checkPath"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"qstringIgnore"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"dscp"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"regexRemap"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"sslKeyVersion"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"displayName"</span><span class="p">:</span><span class="s2">"my_ds_displayname_1"</span><span class="p">,</span>
- <span class="s2">"cacheurl"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"signed"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"matchList"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"type"</span><span class="p">:</span><span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
- <span class="s2">"setNumber"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"pattern"</span><span class="p">:</span><span class="s2">".*</span><span class="se">\\</span><span class="s2">.ds_1</span><span class="se">\\</span><span class="s2">..*"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"type"</span><span class="p">:</span><span class="s2">"HOST_REGEXP"</span><span class="p">,</span>
- <span class="s2">"setNumber"</span><span class="p">:</span><span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"pattern"</span><span class="p">:</span><span class="s2">".*</span><span class="se">\\</span><span class="s2">.my_vod1</span><span class="se">\\</span><span class="s2">..*"</span>
- <span class="p">}</span>
- <span class="p">],</span>
- <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span><span class="mi">0</span><span class="p">,</span>
- <span class="s2">"originShield"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"trRequestHeaders"</span><span class="p">:</span><span class="n">null</span><span class="p">,</span>
- <span class="s2">"geoProvider"</span><span class="p">:</span><span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"logsEnabled"</span><span class="p">:</span><span class="s2">"false"</span><span class="p">,</span>
- <span class="p">}</span>
- <span class="s2">"alerts"</span><span class="p">:[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery service was created: 312"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response":{
+ "xmlId":"my_ds_1",
+ "active":"false",
+ "protocol":"0",
+ "missLong":null,
+ "maxDnsAnswers":"0",
+ "profileName": "CCR_CDN1",
+ "multiSiteOrigin":"0",
+ "dnsBypassIp6":null,
+ "globalMaxTps":"0",
+ "orgServerFqdn":"http:\/\/10.75.168.91",
+ "infoUrl":null,
+ "rangeRequestHandling":null,
+ "id":"311",
+ "trResponseHeaders":null,
+ "ipv6RoutingEnabled":null,
+ "midHeaderRewrite":null,
+ "longDesc":null,
+ "httpBypassFqdn":null,
+ "cdnName":"cdn_number_1",
+ "protocol":"1",
+ "missLat":null,
+ "globalMaxMbps":"0",
+ "initialDispersion":null,
+ "type":"HTTP",
+ "geoLimit":null,
+ "dnsBypassTtl":null,
+ "dnsBypassCname":null,
+ "ccrDnsTtl":null,
+ "longDesc2":null,
+ "remapText":null,
+ "dnsBypassIp":null,
+ "longDesc1":null,
+ "checkPath":null,
+ "qstringIgnore":null,
+ "dscp":"1",
+ "regexRemap":null,
+ "edgeHeaderRewrite":null,
+ "sslKeyVersion":"0",
+ "displayName":"my_ds_displayname_1",
+ "cacheurl":null,
+ "signed":"0",
+ "matchList":[
+ {
+ "type":"HOST_REGEXP",
+ "setNumber":"0",
+ "pattern":".*\\.ds_1\\..*"
+ },
+ {
+ "type":"HOST_REGEXP",
+ "setNumber":"1",
+ "pattern":".*\\.my_vod1\\..*"
+ }
+ ],
+ "regionalGeoBlocking":0,
+ "originShield":null,
+ "trRequestHeaders":null,
+ "geoProvider":"0",
+ "logsEnabled":"false",
+ }
+ "alerts":[
+ {
+ "level": "success",
+ "text": "Delivery service was created: 312"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -2734,100 +2731,100 @@ be a HIT)</li>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"my_ds_2"</span><span class="p">,</span>
- <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"my_ds_displayname_2"</span><span class="p">,</span>
- <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://10.75.168.91"</span><span class="p">,</span>
- <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CCR_CDN1"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
- <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"active"</span><span class="p">:</span> <span class="s2">"true"</span><span class="p">,</span>
- <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP&
<TRUNCATED>
[22/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/status.txt b/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
new file mode 100644
index 0000000..a97a313
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/status.txt
@@ -0,0 +1,127 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-status:
+
+Status
+======
+
+.. _to-api-v12-statuses-route:
+
+/api/1.2/statuses
++++++++++++++++++
+
+**GET /api/1.2/statuses**
+
+ Retrieves a list of the server status codes available.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "5",
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "1",
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "2",
+ "name": "ONLINE",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "3",
+ "name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
+**GET /api/1.2/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/system.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/system.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/system.rst.txt
deleted file mode 100644
index 2740d22..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/system.rst.txt
+++ /dev/null
@@ -1,80 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-sys:
-
-System
-======
-
-.. _to-api-v12-sys-route:
-
-/api/1.1/system
-+++++++++++++++
-
-**GET /api/1.2/system/info.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Key | Type | Description |
- +============================+========+======================================================================================================================================+
- | ``parameters`` | hash | This is a hash with the parameter names that describe the Traffic Ops installation as keys. |
- | | | These are all the parameters in the ``GLOBAL`` profile. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.toolname`` | string | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated |
- | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.instance_name`` | string | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>traffic_rtr_fwd_proxy`` | string | When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. |
- | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
- | | | this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to |
- | | | set this parameter on a production system. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.url`` | string | The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated |
- | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>traffic_mon_fwd_proxy`` | string | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. |
- | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
- | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
- | | | set this parameter on a production system. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.logourl`` | string | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.infourl`` | string | This is the "for more information go here" URL, which is visible in the About page. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "parameters": {
- "tm.toolname": "Traffic Ops",
- "tm.infourl": "http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info",
- "traffic_mon_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
- "traffic_rtr_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
- "tm.logourl": "\/images\/tc_logo.png",
- "tm.url": "https:\/\/tm.kabletown.net\/",
- "tm.instance_name": "Kabletown CDN"
- }
- },
- }
-
-|
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/system.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/system.txt b/docs/latest/_sources/development/traffic_ops_api/v12/system.txt
new file mode 100644
index 0000000..2740d22
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/system.txt
@@ -0,0 +1,80 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-sys:
+
+System
+======
+
+.. _to-api-v12-sys-route:
+
+/api/1.1/system
++++++++++++++++
+
+**GET /api/1.2/system/info.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Type | Description |
+ +============================+========+======================================================================================================================================+
+ | ``parameters`` | hash | This is a hash with the parameter names that describe the Traffic Ops installation as keys. |
+ | | | These are all the parameters in the ``GLOBAL`` profile. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.toolname`` | string | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated |
+ | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.instance_name`` | string | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>traffic_rtr_fwd_proxy`` | string | When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. |
+ | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+ | | | this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to |
+ | | | set this parameter on a production system. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.url`` | string | The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated |
+ | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>traffic_mon_fwd_proxy`` | string | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. |
+ | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+ | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
+ | | | set this parameter on a production system. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.logourl`` | string | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.infourl`` | string | This is the "for more information go here" URL, which is visible in the About page. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "parameters": {
+ "tm.toolname": "Traffic Ops",
+ "tm.infourl": "http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info",
+ "traffic_mon_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
+ "traffic_rtr_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
+ "tm.logourl": "\/images\/tc_logo.png",
+ "tm.url": "https:\/\/tm.kabletown.net\/",
+ "tm.instance_name": "Kabletown CDN"
+ }
+ },
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.rst.txt
deleted file mode 100644
index 44c0246..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.rst.txt
+++ /dev/null
@@ -1,206 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-ext:
-
-TO Extensions
-=============
-
-.. _to-api-v12-ext-route:
-
-/api/1.2/to_extensions
-++++++++++++++++++++++
-
-**GET /api/1.2/to_extensions.json**
-
-Retrieves the list of extensions.
-
-Authentication Required: Yes
-
-Role(s) Required: None
-
-**Response Properties**
-
-+--------------------------+--------+--------------------------------------------+
-| Parameter | Type | Description |
-+==========================+========+============================================+
-|``script_file`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``version`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``name`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``description`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``info_url`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``additional_config_json``| string | |
-+--------------------------+--------+--------------------------------------------+
-|``isactive`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``id`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``type`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``servercheck_short_name``| string | |
-+--------------------------+--------+--------------------------------------------+
-
-**Response Example** ::
-
- {
- "response": [
- {
- script_file: "ping",
- version: "1.0.0",
- name: "ILO_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
- isactive: "1",
- id: "1",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "ILO"
- },
- {
- script_file: "ping",
- version: "1.0.0",
- name: "10G_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
- isactive: "1",
- id: "2",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "10G"
- }
- ],
- }
-
-|
-
-**POST /api/1.2/to_extensions**
-
- Creates a Traffic Ops extension.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Parameters**
-
- +--------------------------+--------+--------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+============================================+
- |``name`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``version`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``info_url`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``script_file`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``isactive`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``additional_config_json``| string | |
- +--------------------------+--------+--------------------------------------------+
- |``description`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``servercheck_short_name``| string | |
- +--------------------------+--------+--------------------------------------------+
- |``type`` | string | |
- +--------------------------+--------+--------------------------------------------+
-
- **Request Example** ::
-
- {
- "name": "ILO_PING",
- "version": "1.0.0",
- "info_url": "http://foo.com/bar.html",
- "script_file": "ping",
- "isactive": "1",
- "additional_config_json": "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}",
- "description": null,
- "servercheck_short_name": "ILO"
- "type": "CHECK_EXTENSION_BOOL",
- }
-
-|
-
- **Response Properties**
-
- +------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Check Extension loaded."
- }
- ],
- }
-
-|
-
-**POST /api/1.2/to_extensions/:id/delete**
-
- Deletes a Traffic Ops extension.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +--------+----------+-----------------+
- | Name | Required | Description |
- +========+==========+=================+
- | ``id`` | yes | TO extension id |
- +--------+----------+-----------------+
-
- **Response Properties**
-
- +------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Extension deleted."
- }
- ],
- }
-
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt
new file mode 100644
index 0000000..44c0246
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/to_extension.txt
@@ -0,0 +1,206 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-ext:
+
+TO Extensions
+=============
+
+.. _to-api-v12-ext-route:
+
+/api/1.2/to_extensions
+++++++++++++++++++++++
+
+**GET /api/1.2/to_extensions.json**
+
+Retrieves the list of extensions.
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+**Response Properties**
+
++--------------------------+--------+--------------------------------------------+
+| Parameter | Type | Description |
++==========================+========+============================================+
+|``script_file`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``version`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``name`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``description`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``info_url`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``additional_config_json``| string | |
++--------------------------+--------+--------------------------------------------+
+|``isactive`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``id`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``type`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``servercheck_short_name``| string | |
++--------------------------+--------+--------------------------------------------+
+
+**Response Example** ::
+
+ {
+ "response": [
+ {
+ script_file: "ping",
+ version: "1.0.0",
+ name: "ILO_PING",
+ description: null,
+ info_url: "http://foo.com/bar.html",
+ additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
+ isactive: "1",
+ id: "1",
+ type: "CHECK_EXTENSION_BOOL",
+ servercheck_short_name: "ILO"
+ },
+ {
+ script_file: "ping",
+ version: "1.0.0",
+ name: "10G_PING",
+ description: null,
+ info_url: "http://foo.com/bar.html",
+ additional_config_json: "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
+ isactive: "1",
+ id: "2",
+ type: "CHECK_EXTENSION_BOOL",
+ servercheck_short_name: "10G"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/to_extensions**
+
+ Creates a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Parameters**
+
+ +--------------------------+--------+--------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+============================================+
+ |``name`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``version`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``info_url`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``script_file`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``isactive`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``additional_config_json``| string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``description`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``servercheck_short_name``| string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``type`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "ILO_PING",
+ "version": "1.0.0",
+ "info_url": "http://foo.com/bar.html",
+ "script_file": "ping",
+ "isactive": "1",
+ "additional_config_json": "{ "path": "/api/1.2/servers.json", "match": { "type": "EDGE"}",
+ "description": null,
+ "servercheck_short_name": "ILO"
+ "type": "CHECK_EXTENSION_BOOL",
+ }
+
+|
+
+ **Response Properties**
+
+ +------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Check Extension loaded."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/to_extensions/:id/delete**
+
+ Deletes a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +--------+----------+-----------------+
+ | Name | Required | Description |
+ +========+==========+=================+
+ | ``id`` | yes | TO extension id |
+ +--------+----------+-----------------+
+
+ **Response Properties**
+
+ +------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Extension deleted."
+ }
+ ],
+ }
+
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/topology.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/topology.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/topology.rst.txt
deleted file mode 100644
index 89444f0..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/topology.rst.txt
+++ /dev/null
@@ -1,54 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-topology:
-
-Snapshot CRConfig
-=================
-
-.. _to-api-v12-topology-route:
-
-/api/1.2/snapshot/{:cdn_name}
-+++++++++++++++++++++++++++++
-
-**PUT /api/1.2/snapshot/{:cdn_name}**
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +----------+----------+-------------------------------------------+
- | Name | Required | Description |
- +==========+==========+===========================================+
- | cdn_name | yes | The name of the cdn to snapshot configure |
- +----------+----------+-------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |response | string | "SUCCESS" |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": "SUCCESS"
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
new file mode 100644
index 0000000..89444f0
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/topology.txt
@@ -0,0 +1,54 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-topology:
+
+Snapshot CRConfig
+=================
+
+.. _to-api-v12-topology-route:
+
+/api/1.2/snapshot/{:cdn_name}
++++++++++++++++++++++++++++++
+
+**PUT /api/1.2/snapshot/{:cdn_name}**
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------------------------------------+
+ | Name | Required | Description |
+ +==========+==========+===========================================+
+ | cdn_name | yes | The name of the cdn to snapshot configure |
+ +----------+----------+-------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |response | string | "SUCCESS" |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": "SUCCESS"
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/type.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/type.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/type.rst.txt
deleted file mode 100644
index 6d614c5..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/type.rst.txt
+++ /dev/null
@@ -1,151 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-type:
-
-Types
-=====
-
-.. _to-api-v12-types-route:
-
-/api/1.2/types
-++++++++++++++
-
-**GET /api/1.1/types**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +----------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +================+==========+====================================================+
- | ``useInTable`` | no | Filter types by the table in which they apply |
- +----------------+----------+----------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``description`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "22",
- "name": "AAAA_RECORD",
- "description": "Static DNS AAAA entry",
- "useInTable": "staticdnsentry",
- "lastUpdated": "2013-10-23 15:28:31"
- }
- ]
- }
-
-
-|
-
-**GET /api/1.1/types/trimmed**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "AAAA_RECORD"
- },
- {
- "name": "ACTIVE_DIRECTORY"
- },
- {
- "name": "A_RECORD"
- },
- {
- "name": "CCR"
- }
- ],
- }
-
-**GET /api/1.1/types/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +================+==========+====================================================+
- | ``id`` | yes | Type ID. |
- +----------------+----------+----------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``description`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "22",
- "name": "AAAA_RECORD",
- "description": "Static DNS AAAA entry",
- "useInTable": "staticdnsentry",
- "lastUpdated": "2013-10-23 15:28:31"
- }
- ]
- }
-
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/type.txt b/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
new file mode 100644
index 0000000..6d614c5
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/type.txt
@@ -0,0 +1,151 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-type:
+
+Types
+=====
+
+.. _to-api-v12-types-route:
+
+/api/1.2/types
+++++++++++++++
+
+**GET /api/1.1/types**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
+
+**GET /api/1.1/types/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "AAAA_RECORD"
+ },
+ {
+ "name": "ACTIVE_DIRECTORY"
+ },
+ {
+ "name": "A_RECORD"
+ },
+ {
+ "name": "CCR"
+ }
+ ],
+ }
+
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
[17/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/jquery-1.11.1.js
----------------------------------------------------------------------
diff --git a/docs/latest/_static/jquery-1.11.1.js b/docs/latest/_static/jquery-1.11.1.js
new file mode 100644
index 0000000..d4b67f7
--- /dev/null
+++ b/docs/latest/_static/jquery-1.11.1.js
@@ -0,0 +1,10308 @@
+/*!
+ * jQuery JavaScript Library v1.11.1
+ * http://jquery.com/
+ *
+ * Includes Sizzle.js
+ * http://sizzlejs.com/
+ *
+ * Copyright 2005, 2014 jQuery Foundation, Inc. and other contributors
+ * Released under the MIT license
+ * http://jquery.org/license
+ *
+ * Date: 2014-05-01T17:42Z
+ */
+
+(function( global, factory ) {
+
+ if ( typeof module === "object" && typeof module.exports === "object" ) {
+ // For CommonJS and CommonJS-like environments where a proper window is present,
+ // execute the factory and get jQuery
+ // For environments that do not inherently posses a window with a document
+ // (such as Node.js), expose a jQuery-making factory as module.exports
+ // This accentuates the need for the creation of a real window
+ // e.g. var jQuery = require("jquery")(window);
+ // See ticket #14549 for more info
+ module.exports = global.document ?
+ factory( global, true ) :
+ function( w ) {
+ if ( !w.document ) {
+ throw new Error( "jQuery requires a window with a document" );
+ }
+ return factory( w );
+ };
+ } else {
+ factory( global );
+ }
+
+// Pass this if window is not defined yet
+}(typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
+
+// Can't do this because several apps including ASP.NET trace
+// the stack via arguments.caller.callee and Firefox dies if
+// you try to trace through "use strict" call chains. (#13335)
+// Support: Firefox 18+
+//
+
+var deletedIds = [];
+
+var slice = deletedIds.slice;
+
+var concat = deletedIds.concat;
+
+var push = deletedIds.push;
+
+var indexOf = deletedIds.indexOf;
+
+var class2type = {};
+
+var toString = class2type.toString;
+
+var hasOwn = class2type.hasOwnProperty;
+
+var support = {};
+
+
+
+var
+ version = "1.11.1",
+
+ // Define a local copy of jQuery
+ jQuery = function( selector, context ) {
+ // The jQuery object is actually just the init constructor 'enhanced'
+ // Need init if jQuery is called (just allow error to be thrown if not included)
+ return new jQuery.fn.init( selector, context );
+ },
+
+ // Support: Android<4.1, IE<9
+ // Make sure we trim BOM and NBSP
+ rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,
+
+ // Matches dashed string for camelizing
+ rmsPrefix = /^-ms-/,
+ rdashAlpha = /-([\da-z])/gi,
+
+ // Used by jQuery.camelCase as callback to replace()
+ fcamelCase = function( all, letter ) {
+ return letter.toUpperCase();
+ };
+
+jQuery.fn = jQuery.prototype = {
+ // The current version of jQuery being used
+ jquery: version,
+
+ constructor: jQuery,
+
+ // Start with an empty selector
+ selector: "",
+
+ // The default length of a jQuery object is 0
+ length: 0,
+
+ toArray: function() {
+ return slice.call( this );
+ },
+
+ // Get the Nth element in the matched element set OR
+ // Get the whole matched element set as a clean array
+ get: function( num ) {
+ return num != null ?
+
+ // Return just the one element from the set
+ ( num < 0 ? this[ num + this.length ] : this[ num ] ) :
+
+ // Return all the elements in a clean array
+ slice.call( this );
+ },
+
+ // Take an array of elements and push it onto the stack
+ // (returning the new matched element set)
+ pushStack: function( elems ) {
+
+ // Build a new jQuery matched element set
+ var ret = jQuery.merge( this.constructor(), elems );
+
+ // Add the old object onto the stack (as a reference)
+ ret.prevObject = this;
+ ret.context = this.context;
+
+ // Return the newly-formed element set
+ return ret;
+ },
+
+ // Execute a callback for every element in the matched set.
+ // (You can seed the arguments with an array of args, but this is
+ // only used internally.)
+ each: function( callback, args ) {
+ return jQuery.each( this, callback, args );
+ },
+
+ map: function( callback ) {
+ return this.pushStack( jQuery.map(this, function( elem, i ) {
+ return callback.call( elem, i, elem );
+ }));
+ },
+
+ slice: function() {
+ return this.pushStack( slice.apply( this, arguments ) );
+ },
+
+ first: function() {
+ return this.eq( 0 );
+ },
+
+ last: function() {
+ return this.eq( -1 );
+ },
+
+ eq: function( i ) {
+ var len = this.length,
+ j = +i + ( i < 0 ? len : 0 );
+ return this.pushStack( j >= 0 && j < len ? [ this[j] ] : [] );
+ },
+
+ end: function() {
+ return this.prevObject || this.constructor(null);
+ },
+
+ // For internal use only.
+ // Behaves like an Array's method, not like a jQuery method.
+ push: push,
+ sort: deletedIds.sort,
+ splice: deletedIds.splice
+};
+
+jQuery.extend = jQuery.fn.extend = function() {
+ var src, copyIsArray, copy, name, options, clone,
+ target = arguments[0] || {},
+ i = 1,
+ length = arguments.length,
+ deep = false;
+
+ // Handle a deep copy situation
+ if ( typeof target === "boolean" ) {
+ deep = target;
+
+ // skip the boolean and the target
+ target = arguments[ i ] || {};
+ i++;
+ }
+
+ // Handle case when target is a string or something (possible in deep copy)
+ if ( typeof target !== "object" && !jQuery.isFunction(target) ) {
+ target = {};
+ }
+
+ // extend jQuery itself if only one argument is passed
+ if ( i === length ) {
+ target = this;
+ i--;
+ }
+
+ for ( ; i < length; i++ ) {
+ // Only deal with non-null/undefined values
+ if ( (options = arguments[ i ]) != null ) {
+ // Extend the base object
+ for ( name in options ) {
+ src = target[ name ];
+ copy = options[ name ];
+
+ // Prevent never-ending loop
+ if ( target === copy ) {
+ continue;
+ }
+
+ // Recurse if we're merging plain objects or arrays
+ if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) {
+ if ( copyIsArray ) {
+ copyIsArray = false;
+ clone = src && jQuery.isArray(src) ? src : [];
+
+ } else {
+ clone = src && jQuery.isPlainObject(src) ? src : {};
+ }
+
+ // Never move original objects, clone them
+ target[ name ] = jQuery.extend( deep, clone, copy );
+
+ // Don't bring in undefined values
+ } else if ( copy !== undefined ) {
+ target[ name ] = copy;
+ }
+ }
+ }
+ }
+
+ // Return the modified object
+ return target;
+};
+
+jQuery.extend({
+ // Unique for each copy of jQuery on the page
+ expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ),
+
+ // Assume jQuery is ready without the ready module
+ isReady: true,
+
+ error: function( msg ) {
+ throw new Error( msg );
+ },
+
+ noop: function() {},
+
+ // See test/unit/core.js for details concerning isFunction.
+ // Since version 1.3, DOM methods and functions like alert
+ // aren't supported. They return false on IE (#2968).
+ isFunction: function( obj ) {
+ return jQuery.type(obj) === "function";
+ },
+
+ isArray: Array.isArray || function( obj ) {
+ return jQuery.type(obj) === "array";
+ },
+
+ isWindow: function( obj ) {
+ /* jshint eqeqeq: false */
+ return obj != null && obj == obj.window;
+ },
+
+ isNumeric: function( obj ) {
+ // parseFloat NaNs numeric-cast false positives (null|true|false|"")
+ // ...but misinterprets leading-number strings, particularly hex literals ("0x...")
+ // subtraction forces infinities to NaN
+ return !jQuery.isArray( obj ) && obj - parseFloat( obj ) >= 0;
+ },
+
+ isEmptyObject: function( obj ) {
+ var name;
+ for ( name in obj ) {
+ return false;
+ }
+ return true;
+ },
+
+ isPlainObject: function( obj ) {
+ var key;
+
+ // Must be an Object.
+ // Because of IE, we also have to check the presence of the constructor property.
+ // Make sure that DOM nodes and window objects don't pass through, as well
+ if ( !obj || jQuery.type(obj) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) {
+ return false;
+ }
+
+ try {
+ // Not own constructor property must be Object
+ if ( obj.constructor &&
+ !hasOwn.call(obj, "constructor") &&
+ !hasOwn.call(obj.constructor.prototype, "isPrototypeOf") ) {
+ return false;
+ }
+ } catch ( e ) {
+ // IE8,9 Will throw exceptions on certain host objects #9897
+ return false;
+ }
+
+ // Support: IE<9
+ // Handle iteration over inherited properties before own properties.
+ if ( support.ownLast ) {
+ for ( key in obj ) {
+ return hasOwn.call( obj, key );
+ }
+ }
+
+ // Own properties are enumerated firstly, so to speed up,
+ // if last one is own, then all properties are own.
+ for ( key in obj ) {}
+
+ return key === undefined || hasOwn.call( obj, key );
+ },
+
+ type: function( obj ) {
+ if ( obj == null ) {
+ return obj + "";
+ }
+ return typeof obj === "object" || typeof obj === "function" ?
+ class2type[ toString.call(obj) ] || "object" :
+ typeof obj;
+ },
+
+ // Evaluates a script in a global context
+ // Workarounds based on findings by Jim Driscoll
+ // http://weblogs.java.net/blog/driscoll/archive/2009/09/08/eval-javascript-global-context
+ globalEval: function( data ) {
+ if ( data && jQuery.trim( data ) ) {
+ // We use execScript on Internet Explorer
+ // We use an anonymous function so that context is window
+ // rather than jQuery in Firefox
+ ( window.execScript || function( data ) {
+ window[ "eval" ].call( window, data );
+ } )( data );
+ }
+ },
+
+ // Convert dashed to camelCase; used by the css and data modules
+ // Microsoft forgot to hump their vendor prefix (#9572)
+ camelCase: function( string ) {
+ return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase );
+ },
+
+ nodeName: function( elem, name ) {
+ return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase();
+ },
+
+ // args is for internal usage only
+ each: function( obj, callback, args ) {
+ var value,
+ i = 0,
+ length = obj.length,
+ isArray = isArraylike( obj );
+
+ if ( args ) {
+ if ( isArray ) {
+ for ( ; i < length; i++ ) {
+ value = callback.apply( obj[ i ], args );
+
+ if ( value === false ) {
+ break;
+ }
+ }
+ } else {
+ for ( i in obj ) {
+ value = callback.apply( obj[ i ], args );
+
+ if ( value === false ) {
+ break;
+ }
+ }
+ }
+
+ // A special, fast, case for the most common use of each
+ } else {
+ if ( isArray ) {
+ for ( ; i < length; i++ ) {
+ value = callback.call( obj[ i ], i, obj[ i ] );
+
+ if ( value === false ) {
+ break;
+ }
+ }
+ } else {
+ for ( i in obj ) {
+ value = callback.call( obj[ i ], i, obj[ i ] );
+
+ if ( value === false ) {
+ break;
+ }
+ }
+ }
+ }
+
+ return obj;
+ },
+
+ // Support: Android<4.1, IE<9
+ trim: function( text ) {
+ return text == null ?
+ "" :
+ ( text + "" ).replace( rtrim, "" );
+ },
+
+ // results is for internal usage only
+ makeArray: function( arr, results ) {
+ var ret = results || [];
+
+ if ( arr != null ) {
+ if ( isArraylike( Object(arr) ) ) {
+ jQuery.merge( ret,
+ typeof arr === "string" ?
+ [ arr ] : arr
+ );
+ } else {
+ push.call( ret, arr );
+ }
+ }
+
+ return ret;
+ },
+
+ inArray: function( elem, arr, i ) {
+ var len;
+
+ if ( arr ) {
+ if ( indexOf ) {
+ return indexOf.call( arr, elem, i );
+ }
+
+ len = arr.length;
+ i = i ? i < 0 ? Math.max( 0, len + i ) : i : 0;
+
+ for ( ; i < len; i++ ) {
+ // Skip accessing in sparse arrays
+ if ( i in arr && arr[ i ] === elem ) {
+ return i;
+ }
+ }
+ }
+
+ return -1;
+ },
+
+ merge: function( first, second ) {
+ var len = +second.length,
+ j = 0,
+ i = first.length;
+
+ while ( j < len ) {
+ first[ i++ ] = second[ j++ ];
+ }
+
+ // Support: IE<9
+ // Workaround casting of .length to NaN on otherwise arraylike objects (e.g., NodeLists)
+ if ( len !== len ) {
+ while ( second[j] !== undefined ) {
+ first[ i++ ] = second[ j++ ];
+ }
+ }
+
+ first.length = i;
+
+ return first;
+ },
+
+ grep: function( elems, callback, invert ) {
+ var callbackInverse,
+ matches = [],
+ i = 0,
+ length = elems.length,
+ callbackExpect = !invert;
+
+ // Go through the array, only saving the items
+ // that pass the validator function
+ for ( ; i < length; i++ ) {
+ callbackInverse = !callback( elems[ i ], i );
+ if ( callbackInverse !== callbackExpect ) {
+ matches.push( elems[ i ] );
+ }
+ }
+
+ return matches;
+ },
+
+ // arg is for internal usage only
+ map: function( elems, callback, arg ) {
+ var value,
+ i = 0,
+ length = elems.length,
+ isArray = isArraylike( elems ),
+ ret = [];
+
+ // Go through the array, translating each of the items to their new values
+ if ( isArray ) {
+ for ( ; i < length; i++ ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+
+ // Go through every key on the object,
+ } else {
+ for ( i in elems ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+ }
+
+ // Flatten any nested arrays
+ return concat.apply( [], ret );
+ },
+
+ // A global GUID counter for objects
+ guid: 1,
+
+ // Bind a function to a context, optionally partially applying any
+ // arguments.
+ proxy: function( fn, context ) {
+ var args, proxy, tmp;
+
+ if ( typeof context === "string" ) {
+ tmp = fn[ context ];
+ context = fn;
+ fn = tmp;
+ }
+
+ // Quick check to determine if target is callable, in the spec
+ // this throws a TypeError, but we will just return undefined.
+ if ( !jQuery.isFunction( fn ) ) {
+ return undefined;
+ }
+
+ // Simulated bind
+ args = slice.call( arguments, 2 );
+ proxy = function() {
+ return fn.apply( context || this, args.concat( slice.call( arguments ) ) );
+ };
+
+ // Set the guid of unique handler to the same of original handler, so it can be removed
+ proxy.guid = fn.guid = fn.guid || jQuery.guid++;
+
+ return proxy;
+ },
+
+ now: function() {
+ return +( new Date() );
+ },
+
+ // jQuery.support is not used in Core but other projects attach their
+ // properties to it so it needs to exist.
+ support: support
+});
+
+// Populate the class2type map
+jQuery.each("Boolean Number String Function Array Date RegExp Object Error".split(" "), function(i, name) {
+ class2type[ "[object " + name + "]" ] = name.toLowerCase();
+});
+
+function isArraylike( obj ) {
+ var length = obj.length,
+ type = jQuery.type( obj );
+
+ if ( type === "function" || jQuery.isWindow( obj ) ) {
+ return false;
+ }
+
+ if ( obj.nodeType === 1 && length ) {
+ return true;
+ }
+
+ return type === "array" || length === 0 ||
+ typeof length === "number" && length > 0 && ( length - 1 ) in obj;
+}
+var Sizzle =
+/*!
+ * Sizzle CSS Selector Engine v1.10.19
+ * http://sizzlejs.com/
+ *
+ * Copyright 2013 jQuery Foundation, Inc. and other contributors
+ * Released under the MIT license
+ * http://jquery.org/license
+ *
+ * Date: 2014-04-18
+ */
+(function( window ) {
+
+var i,
+ support,
+ Expr,
+ getText,
+ isXML,
+ tokenize,
+ compile,
+ select,
+ outermostContext,
+ sortInput,
+ hasDuplicate,
+
+ // Local document vars
+ setDocument,
+ document,
+ docElem,
+ documentIsHTML,
+ rbuggyQSA,
+ rbuggyMatches,
+ matches,
+ contains,
+
+ // Instance-specific data
+ expando = "sizzle" + -(new Date()),
+ preferredDoc = window.document,
+ dirruns = 0,
+ done = 0,
+ classCache = createCache(),
+ tokenCache = createCache(),
+ compilerCache = createCache(),
+ sortOrder = function( a, b ) {
+ if ( a === b ) {
+ hasDuplicate = true;
+ }
+ return 0;
+ },
+
+ // General-purpose constants
+ strundefined = typeof undefined,
+ MAX_NEGATIVE = 1 << 31,
+
+ // Instance methods
+ hasOwn = ({}).hasOwnProperty,
+ arr = [],
+ pop = arr.pop,
+ push_native = arr.push,
+ push = arr.push,
+ slice = arr.slice,
+ // Use a stripped-down indexOf if we can't use a native one
+ indexOf = arr.indexOf || function( elem ) {
+ var i = 0,
+ len = this.length;
+ for ( ; i < len; i++ ) {
+ if ( this[i] === elem ) {
+ return i;
+ }
+ }
+ return -1;
+ },
+
+ booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",
+
+ // Regular expressions
+
+ // Whitespace characters http://www.w3.org/TR/css3-selectors/#whitespace
+ whitespace = "[\\x20\\t\\r\\n\\f]",
+ // http://www.w3.org/TR/css3-syntax/#characters
+ characterEncoding = "(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",
+
+ // Loosely modeled on CSS identifier characters
+ // An unquoted value should be a CSS identifier http://www.w3.org/TR/css3-selectors/#attribute-selectors
+ // Proper syntax: http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier
+ identifier = characterEncoding.replace( "w", "w#" ),
+
+ // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors
+ attributes = "\\[" + whitespace + "*(" + characterEncoding + ")(?:" + whitespace +
+ // Operator (capture 2)
+ "*([*^$|!~]?=)" + whitespace +
+ // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]"
+ "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace +
+ "*\\]",
+
+ pseudos = ":(" + characterEncoding + ")(?:\\((" +
+ // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:
+ // 1. quoted (capture 3; capture 4 or capture 5)
+ "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" +
+ // 2. simple (capture 6)
+ "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" +
+ // 3. anything else (capture 2)
+ ".*" +
+ ")\\)|)",
+
+ // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter
+ rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ),
+
+ rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ),
+ rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ),
+
+ rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ),
+
+ rpseudo = new RegExp( pseudos ),
+ ridentifier = new RegExp( "^" + identifier + "$" ),
+
+ matchExpr = {
+ "ID": new RegExp( "^#(" + characterEncoding + ")" ),
+ "CLASS": new RegExp( "^\\.(" + characterEncoding + ")" ),
+ "TAG": new RegExp( "^(" + characterEncoding.replace( "w", "w*" ) + ")" ),
+ "ATTR": new RegExp( "^" + attributes ),
+ "PSEUDO": new RegExp( "^" + pseudos ),
+ "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace +
+ "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace +
+ "*(\\d+)|))" + whitespace + "*\\)|)", "i" ),
+ "bool": new RegExp( "^(?:" + booleans + ")$", "i" ),
+ // For use in libraries implementing .is()
+ // We use this for POS matching in `select`
+ "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" +
+ whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" )
+ },
+
+ rinputs = /^(?:input|select|textarea|button)$/i,
+ rheader = /^h\d$/i,
+
+ rnative = /^[^{]+\{\s*\[native \w/,
+
+ // Easily-parseable/retrievable ID or TAG or CLASS selectors
+ rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,
+
+ rsibling = /[+~]/,
+ rescape = /'|\\/g,
+
+ // CSS escapes http://www.w3.org/TR/CSS21/syndata.html#escaped-characters
+ runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ),
+ funescape = function( _, escaped, escapedWhitespace ) {
+ var high = "0x" + escaped - 0x10000;
+ // NaN means non-codepoint
+ // Support: Firefox<24
+ // Workaround erroneous numeric interpretation of +"0x"
+ return high !== high || escapedWhitespace ?
+ escaped :
+ high < 0 ?
+ // BMP codepoint
+ String.fromCharCode( high + 0x10000 ) :
+ // Supplemental Plane codepoint (surrogate pair)
+ String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );
+ };
+
+// Optimize for push.apply( _, NodeList )
+try {
+ push.apply(
+ (arr = slice.call( preferredDoc.childNodes )),
+ preferredDoc.childNodes
+ );
+ // Support: Android<4.0
+ // Detect silently failing push.apply
+ arr[ preferredDoc.childNodes.length ].nodeType;
+} catch ( e ) {
+ push = { apply: arr.length ?
+
+ // Leverage slice if possible
+ function( target, els ) {
+ push_native.apply( target, slice.call(els) );
+ } :
+
+ // Support: IE<9
+ // Otherwise append directly
+ function( target, els ) {
+ var j = target.length,
+ i = 0;
+ // Can't trust NodeList.length
+ while ( (target[j++] = els[i++]) ) {}
+ target.length = j - 1;
+ }
+ };
+}
+
+function Sizzle( selector, context, results, seed ) {
+ var match, elem, m, nodeType,
+ // QSA vars
+ i, groups, old, nid, newContext, newSelector;
+
+ if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) {
+ setDocument( context );
+ }
+
+ context = context || document;
+ results = results || [];
+
+ if ( !selector || typeof selector !== "string" ) {
+ return results;
+ }
+
+ if ( (nodeType = context.nodeType) !== 1 && nodeType !== 9 ) {
+ return [];
+ }
+
+ if ( documentIsHTML && !seed ) {
+
+ // Shortcuts
+ if ( (match = rquickExpr.exec( selector )) ) {
+ // Speed-up: Sizzle("#ID")
+ if ( (m = match[1]) ) {
+ if ( nodeType === 9 ) {
+ elem = context.getElementById( m );
+ // Check parentNode to catch when Blackberry 4.6 returns
+ // nodes that are no longer in the document (jQuery #6963)
+ if ( elem && elem.parentNode ) {
+ // Handle the case where IE, Opera, and Webkit return items
+ // by name instead of ID
+ if ( elem.id === m ) {
+ results.push( elem );
+ return results;
+ }
+ } else {
+ return results;
+ }
+ } else {
+ // Context is not a document
+ if ( context.ownerDocument && (elem = context.ownerDocument.getElementById( m )) &&
+ contains( context, elem ) && elem.id === m ) {
+ results.push( elem );
+ return results;
+ }
+ }
+
+ // Speed-up: Sizzle("TAG")
+ } else if ( match[2] ) {
+ push.apply( results, context.getElementsByTagName( selector ) );
+ return results;
+
+ // Speed-up: Sizzle(".CLASS")
+ } else if ( (m = match[3]) && support.getElementsByClassName && context.getElementsByClassName ) {
+ push.apply( results, context.getElementsByClassName( m ) );
+ return results;
+ }
+ }
+
+ // QSA path
+ if ( support.qsa && (!rbuggyQSA || !rbuggyQSA.test( selector )) ) {
+ nid = old = expando;
+ newContext = context;
+ newSelector = nodeType === 9 && selector;
+
+ // qSA works strangely on Element-rooted queries
+ // We can work around this by specifying an extra ID on the root
+ // and working up from there (Thanks to Andrew Dupont for the technique)
+ // IE 8 doesn't work on object elements
+ if ( nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) {
+ groups = tokenize( selector );
+
+ if ( (old = context.getAttribute("id")) ) {
+ nid = old.replace( rescape, "\\$&" );
+ } else {
+ context.setAttribute( "id", nid );
+ }
+ nid = "[id='" + nid + "'] ";
+
+ i = groups.length;
+ while ( i-- ) {
+ groups[i] = nid + toSelector( groups[i] );
+ }
+ newContext = rsibling.test( selector ) && testContext( context.parentNode ) || context;
+ newSelector = groups.join(",");
+ }
+
+ if ( newSelector ) {
+ try {
+ push.apply( results,
+ newContext.querySelectorAll( newSelector )
+ );
+ return results;
+ } catch(qsaError) {
+ } finally {
+ if ( !old ) {
+ context.removeAttribute("id");
+ }
+ }
+ }
+ }
+ }
+
+ // All others
+ return select( selector.replace( rtrim, "$1" ), context, results, seed );
+}
+
+/**
+ * Create key-value caches of limited size
+ * @returns {Function(string, Object)} Returns the Object data after storing it on itself with
+ * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)
+ * deleting the oldest entry
+ */
+function createCache() {
+ var keys = [];
+
+ function cache( key, value ) {
+ // Use (key + " ") to avoid collision with native prototype properties (see Issue #157)
+ if ( keys.push( key + " " ) > Expr.cacheLength ) {
+ // Only keep the most recent entries
+ delete cache[ keys.shift() ];
+ }
+ return (cache[ key + " " ] = value);
+ }
+ return cache;
+}
+
+/**
+ * Mark a function for special use by Sizzle
+ * @param {Function} fn The function to mark
+ */
+function markFunction( fn ) {
+ fn[ expando ] = true;
+ return fn;
+}
+
+/**
+ * Support testing using an element
+ * @param {Function} fn Passed the created div and expects a boolean result
+ */
+function assert( fn ) {
+ var div = document.createElement("div");
+
+ try {
+ return !!fn( div );
+ } catch (e) {
+ return false;
+ } finally {
+ // Remove from its parent by default
+ if ( div.parentNode ) {
+ div.parentNode.removeChild( div );
+ }
+ // release memory in IE
+ div = null;
+ }
+}
+
+/**
+ * Adds the same handler for all of the specified attrs
+ * @param {String} attrs Pipe-separated list of attributes
+ * @param {Function} handler The method that will be applied
+ */
+function addHandle( attrs, handler ) {
+ var arr = attrs.split("|"),
+ i = attrs.length;
+
+ while ( i-- ) {
+ Expr.attrHandle[ arr[i] ] = handler;
+ }
+}
+
+/**
+ * Checks document order of two siblings
+ * @param {Element} a
+ * @param {Element} b
+ * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b
+ */
+function siblingCheck( a, b ) {
+ var cur = b && a,
+ diff = cur && a.nodeType === 1 && b.nodeType === 1 &&
+ ( ~b.sourceIndex || MAX_NEGATIVE ) -
+ ( ~a.sourceIndex || MAX_NEGATIVE );
+
+ // Use IE sourceIndex if available on both nodes
+ if ( diff ) {
+ return diff;
+ }
+
+ // Check if b follows a
+ if ( cur ) {
+ while ( (cur = cur.nextSibling) ) {
+ if ( cur === b ) {
+ return -1;
+ }
+ }
+ }
+
+ return a ? 1 : -1;
+}
+
+/**
+ * Returns a function to use in pseudos for input types
+ * @param {String} type
+ */
+function createInputPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for buttons
+ * @param {String} type
+ */
+function createButtonPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return (name === "input" || name === "button") && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for positionals
+ * @param {Function} fn
+ */
+function createPositionalPseudo( fn ) {
+ return markFunction(function( argument ) {
+ argument = +argument;
+ return markFunction(function( seed, matches ) {
+ var j,
+ matchIndexes = fn( [], seed.length, argument ),
+ i = matchIndexes.length;
+
+ // Match elements found at the specified indexes
+ while ( i-- ) {
+ if ( seed[ (j = matchIndexes[i]) ] ) {
+ seed[j] = !(matches[j] = seed[j]);
+ }
+ }
+ });
+ });
+}
+
+/**
+ * Checks a node for validity as a Sizzle context
+ * @param {Element|Object=} context
+ * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value
+ */
+function testContext( context ) {
+ return context && typeof context.getElementsByTagName !== strundefined && context;
+}
+
+// Expose support vars for convenience
+support = Sizzle.support = {};
+
+/**
+ * Detects XML nodes
+ * @param {Element|Object} elem An element or a document
+ * @returns {Boolean} True iff elem is a non-HTML XML node
+ */
+isXML = Sizzle.isXML = function( elem ) {
+ // documentElement is verified for cases where it doesn't yet exist
+ // (such as loading iframes in IE - #4833)
+ var documentElement = elem && (elem.ownerDocument || elem).documentElement;
+ return documentElement ? documentElement.nodeName !== "HTML" : false;
+};
+
+/**
+ * Sets document-related variables once based on the current document
+ * @param {Element|Object} [doc] An element or document object to use to set the document
+ * @returns {Object} Returns the current document
+ */
+setDocument = Sizzle.setDocument = function( node ) {
+ var hasCompare,
+ doc = node ? node.ownerDocument || node : preferredDoc,
+ parent = doc.defaultView;
+
+ // If no document and documentElement is available, return
+ if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) {
+ return document;
+ }
+
+ // Set our document
+ document = doc;
+ docElem = doc.documentElement;
+
+ // Support tests
+ documentIsHTML = !isXML( doc );
+
+ // Support: IE>8
+ // If iframe document is assigned to "document" variable and if iframe has been reloaded,
+ // IE will throw "permission denied" error when accessing "document" variable, see jQuery #13936
+ // IE6-8 do not support the defaultView property so parent will be undefined
+ if ( parent && parent !== parent.top ) {
+ // IE11 does not have attachEvent, so all must suffer
+ if ( parent.addEventListener ) {
+ parent.addEventListener( "unload", function() {
+ setDocument();
+ }, false );
+ } else if ( parent.attachEvent ) {
+ parent.attachEvent( "onunload", function() {
+ setDocument();
+ });
+ }
+ }
+
+ /* Attributes
+ ---------------------------------------------------------------------- */
+
+ // Support: IE<8
+ // Verify that getAttribute really returns attributes and not properties (excepting IE8 booleans)
+ support.attributes = assert(function( div ) {
+ div.className = "i";
+ return !div.getAttribute("className");
+ });
+
+ /* getElement(s)By*
+ ---------------------------------------------------------------------- */
+
+ // Check if getElementsByTagName("*") returns only elements
+ support.getElementsByTagName = assert(function( div ) {
+ div.appendChild( doc.createComment("") );
+ return !div.getElementsByTagName("*").length;
+ });
+
+ // Check if getElementsByClassName can be trusted
+ support.getElementsByClassName = rnative.test( doc.getElementsByClassName ) && assert(function( div ) {
+ div.innerHTML = "<div class='a'></div><div class='a i'></div>";
+
+ // Support: Safari<4
+ // Catch class over-caching
+ div.firstChild.className = "i";
+ // Support: Opera<10
+ // Catch gEBCN failure to find non-leading classes
+ return div.getElementsByClassName("i").length === 2;
+ });
+
+ // Support: IE<10
+ // Check if getElementById returns elements by name
+ // The broken getElementById methods don't pick up programatically-set names,
+ // so use a roundabout getElementsByName test
+ support.getById = assert(function( div ) {
+ docElem.appendChild( div ).id = expando;
+ return !doc.getElementsByName || !doc.getElementsByName( expando ).length;
+ });
+
+ // ID find and filter
+ if ( support.getById ) {
+ Expr.find["ID"] = function( id, context ) {
+ if ( typeof context.getElementById !== strundefined && documentIsHTML ) {
+ var m = context.getElementById( id );
+ // Check parentNode to catch when Blackberry 4.6 returns
+ // nodes that are no longer in the document #6963
+ return m && m.parentNode ? [ m ] : [];
+ }
+ };
+ Expr.filter["ID"] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ return elem.getAttribute("id") === attrId;
+ };
+ };
+ } else {
+ // Support: IE6/7
+ // getElementById is not reliable as a find shortcut
+ delete Expr.find["ID"];
+
+ Expr.filter["ID"] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ var node = typeof elem.getAttributeNode !== strundefined && elem.getAttributeNode("id");
+ return node && node.value === attrId;
+ };
+ };
+ }
+
+ // Tag
+ Expr.find["TAG"] = support.getElementsByTagName ?
+ function( tag, context ) {
+ if ( typeof context.getElementsByTagName !== strundefined ) {
+ return context.getElementsByTagName( tag );
+ }
+ } :
+ function( tag, context ) {
+ var elem,
+ tmp = [],
+ i = 0,
+ results = context.getElementsByTagName( tag );
+
+ // Filter out possible comments
+ if ( tag === "*" ) {
+ while ( (elem = results[i++]) ) {
+ if ( elem.nodeType === 1 ) {
+ tmp.push( elem );
+ }
+ }
+
+ return tmp;
+ }
+ return results;
+ };
+
+ // Class
+ Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) {
+ if ( typeof context.getElementsByClassName !== strundefined && documentIsHTML ) {
+ return context.getElementsByClassName( className );
+ }
+ };
+
+ /* QSA/matchesSelector
+ ---------------------------------------------------------------------- */
+
+ // QSA and matchesSelector support
+
+ // matchesSelector(:active) reports false when true (IE9/Opera 11.5)
+ rbuggyMatches = [];
+
+ // qSa(:focus) reports false when true (Chrome 21)
+ // We allow this because of a bug in IE8/9 that throws an error
+ // whenever `document.activeElement` is accessed on an iframe
+ // So, we allow :focus to pass through QSA all the time to avoid the IE error
+ // See http://bugs.jquery.com/ticket/13378
+ rbuggyQSA = [];
+
+ if ( (support.qsa = rnative.test( doc.querySelectorAll )) ) {
+ // Build QSA regex
+ // Regex strategy adopted from Diego Perini
+ assert(function( div ) {
+ // Select is set to empty string on purpose
+ // This is to test IE's treatment of not explicitly
+ // setting a boolean content attribute,
+ // since its presence should be enough
+ // http://bugs.jquery.com/ticket/12359
+ div.innerHTML = "<select msallowclip=''><option selected=''></option></select>";
+
+ // Support: IE8, Opera 11-12.16
+ // Nothing should be selected when empty strings follow ^= or $= or *=
+ // The test attribute must be unknown in Opera but "safe" for WinRT
+ // http://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section
+ if ( div.querySelectorAll("[msallowclip^='']").length ) {
+ rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" );
+ }
+
+ // Support: IE8
+ // Boolean attributes and "value" are not treated correctly
+ if ( !div.querySelectorAll("[selected]").length ) {
+ rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" );
+ }
+
+ // Webkit/Opera - :checked should return selected option elements
+ // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
+ // IE8 throws error here and will not see later tests
+ if ( !div.querySelectorAll(":checked").length ) {
+ rbuggyQSA.push(":checked");
+ }
+ });
+
+ assert(function( div ) {
+ // Support: Windows 8 Native Apps
+ // The type and name attributes are restricted during .innerHTML assignment
+ var input = doc.createElement("input");
+ input.setAttribute( "type", "hidden" );
+ div.appendChild( input ).setAttribute( "name", "D" );
+
+ // Support: IE8
+ // Enforce case-sensitivity of name attribute
+ if ( div.querySelectorAll("[name=d]").length ) {
+ rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" );
+ }
+
+ // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled)
+ // IE8 throws error here and will not see later tests
+ if ( !div.querySelectorAll(":enabled").length ) {
+ rbuggyQSA.push( ":enabled", ":disabled" );
+ }
+
+ // Opera 10-11 does not throw on post-comma invalid pseudos
+ div.querySelectorAll("*,:x");
+ rbuggyQSA.push(",.*:");
+ });
+ }
+
+ if ( (support.matchesSelector = rnative.test( (matches = docElem.matches ||
+ docElem.webkitMatchesSelector ||
+ docElem.mozMatchesSelector ||
+ docElem.oMatchesSelector ||
+ docElem.msMatchesSelector) )) ) {
+
+ assert(function( div ) {
+ // Check to see if it's possible to do matchesSelector
+ // on a disconnected node (IE 9)
+ support.disconnectedMatch = matches.call( div, "div" );
+
+ // This should fail with an exception
+ // Gecko does not error, returns false instead
+ matches.call( div, "[s!='']:x" );
+ rbuggyMatches.push( "!=", pseudos );
+ });
+ }
+
+ rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") );
+ rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") );
+
+ /* Contains
+ ---------------------------------------------------------------------- */
+ hasCompare = rnative.test( docElem.compareDocumentPosition );
+
+ // Element contains another
+ // Purposefully does not implement inclusive descendent
+ // As in, an element does not contain itself
+ contains = hasCompare || rnative.test( docElem.contains ) ?
+ function( a, b ) {
+ var adown = a.nodeType === 9 ? a.documentElement : a,
+ bup = b && b.parentNode;
+ return a === bup || !!( bup && bup.nodeType === 1 && (
+ adown.contains ?
+ adown.contains( bup ) :
+ a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16
+ ));
+ } :
+ function( a, b ) {
+ if ( b ) {
+ while ( (b = b.parentNode) ) {
+ if ( b === a ) {
+ return true;
+ }
+ }
+ }
+ return false;
+ };
+
+ /* Sorting
+ ---------------------------------------------------------------------- */
+
+ // Document order sorting
+ sortOrder = hasCompare ?
+ function( a, b ) {
+
+ // Flag for duplicate removal
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+ }
+
+ // Sort on method existence if only one input has compareDocumentPosition
+ var compare = !a.compareDocumentPosition - !b.compareDocumentPosition;
+ if ( compare ) {
+ return compare;
+ }
+
+ // Calculate position if both inputs belong to the same document
+ compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ?
+ a.compareDocumentPosition( b ) :
+
+ // Otherwise we know they are disconnected
+ 1;
+
+ // Disconnected nodes
+ if ( compare & 1 ||
+ (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) {
+
+ // Choose the first element that is related to our preferred document
+ if ( a === doc || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) {
+ return -1;
+ }
+ if ( b === doc || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) {
+ return 1;
+ }
+
+ // Maintain original order
+ return sortInput ?
+ ( indexOf.call( sortInput, a ) - indexOf.call( sortInput, b ) ) :
+ 0;
+ }
+
+ return compare & 4 ? -1 : 1;
+ } :
+ function( a, b ) {
+ // Exit early if the nodes are identical
+ if ( a === b ) {
+ hasDuplicate = true;
+ return 0;
+ }
+
+ var cur,
+ i = 0,
+ aup = a.parentNode,
+ bup = b.parentNode,
+ ap = [ a ],
+ bp = [ b ];
+
+ // Parentless nodes are either documents or disconnected
+ if ( !aup || !bup ) {
+ return a === doc ? -1 :
+ b === doc ? 1 :
+ aup ? -1 :
+ bup ? 1 :
+ sortInput ?
+ ( indexOf.call( sortInput, a ) - indexOf.call( sortInput, b ) ) :
+ 0;
+
+ // If the nodes are siblings, we can do a quick check
+ } else if ( aup === bup ) {
+ return siblingCheck( a, b );
+ }
+
+ // Otherwise we need full lists of their ancestors for comparison
+ cur = a;
+ while ( (cur = cur.parentNode) ) {
+ ap.unshift( cur );
+ }
+ cur = b;
+ while ( (cur = cur.parentNode) ) {
+ bp.unshift( cur );
+ }
+
+ // Walk down the tree looking for a discrepancy
+ while ( ap[i] === bp[i] ) {
+ i++;
+ }
+
+ return i ?
+ // Do a sibling check if the nodes have a common ancestor
+ siblingCheck( ap[i], bp[i] ) :
+
+ // Otherwise nodes in our document sort first
+ ap[i] === preferredDoc ? -1 :
+ bp[i] === preferredDoc ? 1 :
+ 0;
+ };
+
+ return doc;
+};
+
+Sizzle.matches = function( expr, elements ) {
+ return Sizzle( expr, null, null, elements );
+};
+
+Sizzle.matchesSelector = function( elem, expr ) {
+ // Set document vars if needed
+ if ( ( elem.ownerDocument || elem ) !== document ) {
+ setDocument( elem );
+ }
+
+ // Make sure that attribute selectors are quoted
+ expr = expr.replace( rattributeQuotes, "='$1']" );
+
+ if ( support.matchesSelector && documentIsHTML &&
+ ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) &&
+ ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) {
+
+ try {
+ var ret = matches.call( elem, expr );
+
+ // IE 9's matchesSelector returns false on disconnected nodes
+ if ( ret || support.disconnectedMatch ||
+ // As well, disconnected nodes are said to be in a document
+ // fragment in IE 9
+ elem.document && elem.document.nodeType !== 11 ) {
+ return ret;
+ }
+ } catch(e) {}
+ }
+
+ return Sizzle( expr, document, null, [ elem ] ).length > 0;
+};
+
+Sizzle.contains = function( context, elem ) {
+ // Set document vars if needed
+ if ( ( context.ownerDocument || context ) !== document ) {
+ setDocument( context );
+ }
+ return contains( context, elem );
+};
+
+Sizzle.attr = function( elem, name ) {
+ // Set document vars if needed
+ if ( ( elem.ownerDocument || elem ) !== document ) {
+ setDocument( elem );
+ }
+
+ var fn = Expr.attrHandle[ name.toLowerCase() ],
+ // Don't get fooled by Object.prototype properties (jQuery #13807)
+ val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ?
+ fn( elem, name, !documentIsHTML ) :
+ undefined;
+
+ return val !== undefined ?
+ val :
+ support.attributes || !documentIsHTML ?
+ elem.getAttribute( name ) :
+ (val = elem.getAttributeNode(name)) && val.specified ?
+ val.value :
+ null;
+};
+
+Sizzle.error = function( msg ) {
+ throw new Error( "Syntax error, unrecognized expression: " + msg );
+};
+
+/**
+ * Document sorting and removing duplicates
+ * @param {ArrayLike} results
+ */
+Sizzle.uniqueSort = function( results ) {
+ var elem,
+ duplicates = [],
+ j = 0,
+ i = 0;
+
+ // Unless we *know* we can detect duplicates, assume their presence
+ hasDuplicate = !support.detectDuplicates;
+ sortInput = !support.sortStable && results.slice( 0 );
+ results.sort( sortOrder );
+
+ if ( hasDuplicate ) {
+ while ( (elem = results[i++]) ) {
+ if ( elem === results[ i ] ) {
+ j = duplicates.push( i );
+ }
+ }
+ while ( j-- ) {
+ results.splice( duplicates[ j ], 1 );
+ }
+ }
+
+ // Clear input after sorting to release objects
+ // See https://github.com/jquery/sizzle/pull/225
+ sortInput = null;
+
+ return results;
+};
+
+/**
+ * Utility function for retrieving the text value of an array of DOM nodes
+ * @param {Array|Element} elem
+ */
+getText = Sizzle.getText = function( elem ) {
+ var node,
+ ret = "",
+ i = 0,
+ nodeType = elem.nodeType;
+
+ if ( !nodeType ) {
+ // If no nodeType, this is expected to be an array
+ while ( (node = elem[i++]) ) {
+ // Do not traverse comment nodes
+ ret += getText( node );
+ }
+ } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) {
+ // Use textContent for elements
+ // innerText usage removed for consistency of new lines (jQuery #11153)
+ if ( typeof elem.textContent === "string" ) {
+ return elem.textContent;
+ } else {
+ // Traverse its children
+ for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
+ ret += getText( elem );
+ }
+ }
+ } else if ( nodeType === 3 || nodeType === 4 ) {
+ return elem.nodeValue;
+ }
+ // Do not include comment or processing instruction nodes
+
+ return ret;
+};
+
+Expr = Sizzle.selectors = {
+
+ // Can be adjusted by the user
+ cacheLength: 50,
+
+ createPseudo: markFunction,
+
+ match: matchExpr,
+
+ attrHandle: {},
+
+ find: {},
+
+ relative: {
+ ">": { dir: "parentNode", first: true },
+ " ": { dir: "parentNode" },
+ "+": { dir: "previousSibling", first: true },
+ "~": { dir: "previousSibling" }
+ },
+
+ preFilter: {
+ "ATTR": function( match ) {
+ match[1] = match[1].replace( runescape, funescape );
+
+ // Move the given value to match[3] whether quoted or unquoted
+ match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape );
+
+ if ( match[2] === "~=" ) {
+ match[3] = " " + match[3] + " ";
+ }
+
+ return match.slice( 0, 4 );
+ },
+
+ "CHILD": function( match ) {
+ /* matches from matchExpr["CHILD"]
+ 1 type (only|nth|...)
+ 2 what (child|of-type)
+ 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...)
+ 4 xn-component of xn+y argument ([+-]?\d*n|)
+ 5 sign of xn-component
+ 6 x of xn-component
+ 7 sign of y-component
+ 8 y of y-component
+ */
+ match[1] = match[1].toLowerCase();
+
+ if ( match[1].slice( 0, 3 ) === "nth" ) {
+ // nth-* requires argument
+ if ( !match[3] ) {
+ Sizzle.error( match[0] );
+ }
+
+ // numeric x and y parameters for Expr.filter.CHILD
+ // remember that false/true cast respectively to 0/1
+ match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) );
+ match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" );
+
+ // other types prohibit arguments
+ } else if ( match[3] ) {
+ Sizzle.error( match[0] );
+ }
+
+ return match;
+ },
+
+ "PSEUDO": function( match ) {
+ var excess,
+ unquoted = !match[6] && match[2];
+
+ if ( matchExpr["CHILD"].test( match[0] ) ) {
+ return null;
+ }
+
+ // Accept quoted arguments as-is
+ if ( match[3] ) {
+ match[2] = match[4] || match[5] || "";
+
+ // Strip excess characters from unquoted arguments
+ } else if ( unquoted && rpseudo.test( unquoted ) &&
+ // Get excess from tokenize (recursively)
+ (excess = tokenize( unquoted, true )) &&
+ // advance to the next closing parenthesis
+ (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) {
+
+ // excess is a negative index
+ match[0] = match[0].slice( 0, excess );
+ match[2] = unquoted.slice( 0, excess );
+ }
+
+ // Return only captures needed by the pseudo filter method (type and argument)
+ return match.slice( 0, 3 );
+ }
+ },
+
+ filter: {
+
+ "TAG": function( nodeNameSelector ) {
+ var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase();
+ return nodeNameSelector === "*" ?
+ function() { return true; } :
+ function( elem ) {
+ return elem.nodeName && elem.nodeName.toLowerCase() === nodeName;
+ };
+ },
+
+ "CLASS": function( className ) {
+ var pattern = classCache[ className + " " ];
+
+ return pattern ||
+ (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) &&
+ classCache( className, function( elem ) {
+ return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== strundefined && elem.getAttribute("class") || "" );
+ });
+ },
+
+ "ATTR": function( name, operator, check ) {
+ return function( elem ) {
+ var result = Sizzle.attr( elem, name );
+
+ if ( result == null ) {
+ return operator === "!=";
+ }
+ if ( !operator ) {
+ return true;
+ }
+
+ result += "";
+
+ return operator === "=" ? result === check :
+ operator === "!=" ? result !== check :
+ operator === "^=" ? check && result.indexOf( check ) === 0 :
+ operator === "*=" ? check && result.indexOf( check ) > -1 :
+ operator === "$=" ? check && result.slice( -check.length ) === check :
+ operator === "~=" ? ( " " + result + " " ).indexOf( check ) > -1 :
+ operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" :
+ false;
+ };
+ },
+
+ "CHILD": function( type, what, argument, first, last ) {
+ var simple = type.slice( 0, 3 ) !== "nth",
+ forward = type.slice( -4 ) !== "last",
+ ofType = what === "of-type";
+
+ return first === 1 && last === 0 ?
+
+ // Shortcut for :nth-*(n)
+ function( elem ) {
+ return !!elem.parentNode;
+ } :
+
+ function( elem, context, xml ) {
+ var cache, outerCache, node, diff, nodeIndex, start,
+ dir = simple !== forward ? "nextSibling" : "previousSibling",
+ parent = elem.parentNode,
+ name = ofType && elem.nodeName.toLowerCase(),
+ useCache = !xml && !ofType;
+
+ if ( parent ) {
+
+ // :(first|last|only)-(child|of-type)
+ if ( simple ) {
+ while ( dir ) {
+ node = elem;
+ while ( (node = node[ dir ]) ) {
+ if ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) {
+ return false;
+ }
+ }
+ // Reverse direction for :only-* (if we haven't yet done so)
+ start = dir = type === "only" && !start && "nextSibling";
+ }
+ return true;
+ }
+
+ start = [ forward ? parent.firstChild : parent.lastChild ];
+
+ // non-xml :nth-child(...) stores cache data on `parent`
+ if ( forward && useCache ) {
+ // Seek `elem` from a previously-cached index
+ outerCache = parent[ expando ] || (parent[ expando ] = {});
+ cache = outerCache[ type ] || [];
+ nodeIndex = cache[0] === dirruns && cache[1];
+ diff = cache[0] === dirruns && cache[2];
+ node = nodeIndex && parent.childNodes[ nodeIndex ];
+
+ while ( (node = ++nodeIndex && node && node[ dir ] ||
+
+ // Fallback to seeking `elem` from the start
+ (diff = nodeIndex = 0) || start.pop()) ) {
+
+ // When found, cache indexes on `parent` and break
+ if ( node.nodeType === 1 && ++diff && node === elem ) {
+ outerCache[ type ] = [ dirruns, nodeIndex, diff ];
+ break;
+ }
+ }
+
+ // Use previously-cached element index if available
+ } else if ( useCache && (cache = (elem[ expando ] || (elem[ expando ] = {}))[ type ]) && cache[0] === dirruns ) {
+ diff = cache[1];
+
+ // xml :nth-child(...) or :nth-last-child(...) or :nth(-last)?-of-type(...)
+ } else {
+ // Use the same loop as above to seek `elem` from the start
+ while ( (node = ++nodeIndex && node && node[ dir ] ||
+ (diff = nodeIndex = 0) || start.pop()) ) {
+
+ if ( ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) && ++diff ) {
+ // Cache the index of each encountered element
+ if ( useCache ) {
+ (node[ expando ] || (node[ expando ] = {}))[ type ] = [ dirruns, diff ];
+ }
+
+ if ( node === elem ) {
+ break;
+ }
+ }
+ }
+ }
+
+ // Incorporate the offset, then check against cycle size
+ diff -= last;
+ return diff === first || ( diff % first === 0 && diff / first >= 0 );
+ }
+ };
+ },
+
+ "PSEUDO": function( pseudo, argument ) {
+ // pseudo-class names are case-insensitive
+ // http://www.w3.org/TR/selectors/#pseudo-classes
+ // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters
+ // Remember that setFilters inherits from pseudos
+ var args,
+ fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] ||
+ Sizzle.error( "unsupported pseudo: " + pseudo );
+
+ // The user may use createPseudo to indicate that
+ // arguments are needed to create the filter function
+ // just as Sizzle does
+ if ( fn[ expando ] ) {
+ return fn( argument );
+ }
+
+ // But maintain support for old signatures
+ if ( fn.length > 1 ) {
+ args = [ pseudo, pseudo, "", argument ];
+ return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ?
+ markFunction(function( seed, matches ) {
+ var idx,
+ matched = fn( seed, argument ),
+ i = matched.length;
+ while ( i-- ) {
+ idx = indexOf.call( seed, matched[i] );
+ seed[ idx ] = !( matches[ idx ] = matched[i] );
+ }
+ }) :
+ function( elem ) {
+ return fn( elem, 0, args );
+ };
+ }
+
+ return fn;
+ }
+ },
+
+ pseudos: {
+ // Potentially complex pseudos
+ "not": markFunction(function( selector ) {
+ // Trim the selector passed to compile
+ // to avoid treating leading and trailing
+ // spaces as combinators
+ var input = [],
+ results = [],
+ matcher = compile( selector.replace( rtrim, "$1" ) );
+
+ return matcher[ expando ] ?
+ markFunction(function( seed, matches, context, xml ) {
+ var elem,
+ unmatched = matcher( seed, null, xml, [] ),
+ i = seed.length;
+
+ // Match elements unmatched by `matcher`
+ while ( i-- ) {
+ if ( (elem = unmatched[i]) ) {
+ seed[i] = !(matches[i] = elem);
+ }
+ }
+ }) :
+ function( elem, context, xml ) {
+ input[0] = elem;
+ matcher( input, null, xml, results );
+ return !results.pop();
+ };
+ }),
+
+ "has": markFunction(function( selector ) {
+ return function( elem ) {
+ return Sizzle( selector, elem ).length > 0;
+ };
+ }),
+
+ "contains": markFunction(function( text ) {
+ return function( elem ) {
+ return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1;
+ };
+ }),
+
+ // "Whether an element is represented by a :lang() selector
+ // is based solely on the element's language value
+ // being equal to the identifier C,
+ // or beginning with the identifier C immediately followed by "-".
+ // The matching of C against the element's language value is performed case-insensitively.
+ // The identifier C does not have to be a valid language name."
+ // http://www.w3.org/TR/selectors/#lang-pseudo
+ "lang": markFunction( function( lang ) {
+ // lang value must be a valid identifier
+ if ( !ridentifier.test(lang || "") ) {
+ Sizzle.error( "unsupported lang: " + lang );
+ }
+ lang = lang.replace( runescape, funescape ).toLowerCase();
+ return function( elem ) {
+ var elemLang;
+ do {
+ if ( (elemLang = documentIsHTML ?
+ elem.lang :
+ elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) {
+
+ elemLang = elemLang.toLowerCase();
+ return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0;
+ }
+ } while ( (elem = elem.parentNode) && elem.nodeType === 1 );
+ return false;
+ };
+ }),
+
+ // Miscellaneous
+ "target": function( elem ) {
+ var hash = window.location && window.location.hash;
+ return hash && hash.slice( 1 ) === elem.id;
+ },
+
+ "root": function( elem ) {
+ return elem === docElem;
+ },
+
+ "focus": function( elem ) {
+ return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex);
+ },
+
+ // Boolean properties
+ "enabled": function( elem ) {
+ return elem.disabled === false;
+ },
+
+ "disabled": function( elem ) {
+ return elem.disabled === true;
+ },
+
+ "checked": function( elem ) {
+ // In CSS3, :checked should return both checked and selected elements
+ // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
+ var nodeName = elem.nodeName.toLowerCase();
+ return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected);
+ },
+
+ "selected": function( elem ) {
+ // Accessing this property makes selected-by-default
+ // options in Safari work properly
+ if ( elem.parentNode ) {
+ elem.parentNode.selectedIndex;
+ }
+
+ return elem.selected === true;
+ },
+
+ // Contents
+ "empty": function( elem ) {
+ // http://www.w3.org/TR/selectors/#empty-pseudo
+ // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5),
+ // but not by others (comment: 8; processing instruction: 7; etc.)
+ // nodeType < 6 works because attributes (2) do not appear as children
+ for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) {
+ if ( elem.nodeType < 6 ) {
+ return false;
+ }
+ }
+ return true;
+ },
+
+ "parent": function( elem ) {
+ return !Expr.pseudos["empty"]( elem );
+ },
+
+ // Element/input types
+ "header": function( elem ) {
+ return rheader.test( elem.nodeName );
+ },
+
+ "input": function( elem ) {
+ return rinputs.test( elem.nodeName );
+ },
+
+ "button": function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === "button" || name === "button";
+ },
+
+ "text": function( elem ) {
+ var attr;
+ return elem.nodeName.toLowerCase() === "input" &&
+ elem.type === "text" &&
+
+ // Support: IE<8
+ // New HTML5 attribute values (e.g., "search") appear with elem.type === "text"
+ ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" );
+ },
+
+ // Position-in-collection
+ "first": createPositionalPseudo(function() {
+ return [ 0 ];
+ }),
+
+ "last": createPositionalPseudo(function( matchIndexes, length ) {
+ return [ length - 1 ];
+ }),
+
+ "eq": createPositionalPseudo(function( matchIndexes, length, argument ) {
+ return [ argument < 0 ? argument + length : argument ];
+ }),
+
+ "even": createPositionalPseudo(function( matchIndexes, length ) {
+ var i = 0;
+ for ( ; i < length; i += 2 ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ }),
+
+ "odd": createPositionalPseudo(function( matchIndexes, length ) {
+ var i = 1;
+ for ( ; i < length; i += 2 ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ }),
+
+ "lt": createPositionalPseudo(function( matchIndexes, length, argument ) {
+ var i = argument < 0 ? argument + length : argument;
+ for ( ; --i >= 0; ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ }),
+
+ "gt": createPositionalPseudo(function( matchIndexes, length, argument ) {
+ var i = argument < 0 ? argument + length : argument;
+ for ( ; ++i < length; ) {
+ matchIndexes.push( i );
+ }
+ return matchIndexes;
+ })
+ }
+};
+
+Expr.pseudos["nth"] = Expr.pseudos["eq"];
+
+// Add button/input type pseudos
+for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) {
+ Expr.pseudos[ i ] = createInputPseudo( i );
+}
+for ( i in { submit: true, reset: true } ) {
+ Expr.pseudos[ i ] = createButtonPseudo( i );
+}
+
+// Easy API for creating new setFilters
+function setFilters() {}
+setFilters.prototype = Expr.filters = Expr.pseudos;
+Expr.setFilters = new setFilters();
+
+tokenize = Sizzle.tokenize = function( selector, parseOnly ) {
+ var matched, match, tokens, type,
+ soFar, groups, preFilters,
+ cached = tokenCache[ selector + " " ];
+
+ if ( cached ) {
+ return parseOnly ? 0 : cached.slice( 0 );
+ }
+
+ soFar = selector;
+ groups = [];
+ preFilters = Expr.preFilter;
+
+ while ( soFar ) {
+
+ // Comma and first run
+ if ( !matched || (match = rcomma.exec( soFar )) ) {
+ if ( match ) {
+ // Don't consume trailing commas as valid
+ soFar = soFar.slice( match[0].length ) || soFar;
+ }
+ groups.push( (tokens = []) );
+ }
+
+ matched = false;
+
+ // Combinators
+ if ( (match = rcombinators.exec( soFar )) ) {
+ matched = match.shift();
+ tokens.push({
+ value: matched,
+ // Cast descendant combinators to space
+ type: match[0].replace( rtrim, " " )
+ });
+ soFar = soFar.slice( matched.length );
+ }
+
+ // Filters
+ for ( type in Expr.filter ) {
+ if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] ||
+ (match = preFilters[ type ]( match ))) ) {
+ matched = match.shift();
+ tokens.push({
+ value: matched,
+ type: type,
+ matches: match
+ });
+ soFar = soFar.slice( matched.length );
+ }
+ }
+
+ if ( !matched ) {
+ break;
+ }
+ }
+
+ // Return the length of the invalid excess
+ // if we're just parsing
+ // Otherwise, throw an error or return tokens
+ return parseOnly ?
+ soFar.length :
+ soFar ?
+ Sizzle.error( selector ) :
+ // Cache the tokens
+ tokenCache( selector, groups ).slice( 0 );
+};
+
+function toSelector( tokens ) {
+ var i = 0,
+ len = tokens.length,
+ selector = "";
+ for ( ; i < len; i++ ) {
+ selector += tokens[i].value;
+ }
+ return selector;
+}
+
+function addCombinator( matcher, combinator, base ) {
+ var dir = combinator.dir,
+ checkNonElements = base && dir === "parentNode",
+ doneName = done++;
+
+ return combinator.first ?
+ // Check against closest ancestor/preceding element
+ function( elem, context, xml ) {
+ while ( (elem = elem[ dir ]) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ return matcher( elem, context, xml );
+ }
+ }
+ } :
+
+ // Check against all ancestor/preceding elements
+ function( elem, context, xml ) {
+ var oldCache, outerCache,
+ newCache = [ dirruns, doneName ];
+
+ // We can't set arbitrary data on XML nodes, so they don't benefit from dir caching
+ if ( xml ) {
+ while ( (elem = elem[ dir ]) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ if ( matcher( elem, context, xml ) ) {
+ return true;
+ }
+ }
+ }
+ } else {
+ while ( (elem = elem[ dir ]) ) {
+ if ( elem.nodeType === 1 || checkNonElements ) {
+ outerCache = elem[ expando ] || (elem[ expando ] = {});
+ if ( (oldCache = outerCache[ dir ]) &&
+ oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) {
+
+ // Assign to newCache so results back-propagate to previous elements
+ return (newCache[ 2 ] = oldCache[ 2 ]);
+ } else {
+ // Reuse newcache so results back-propagate to previous elements
+ outerCache[ dir ] = newCache;
+
+ // A match means we're done; a fail means we have to keep checking
+ if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) {
+ return true;
+ }
+ }
+ }
+ }
+ }
+ };
+}
+
+function elementMatcher( matchers ) {
+ return matchers.length > 1 ?
+ function( elem, context, xml ) {
+ var i = matchers.length;
+ while ( i-- ) {
+ if ( !matchers[i]( elem, context, xml ) ) {
+ return false;
+ }
+ }
+ return true;
+ } :
+ matchers[0];
+}
+
+function multipleContexts( selector, contexts, results ) {
+ var i = 0,
+ len = contexts.length;
+ for ( ; i < len; i++ ) {
+ Sizzle( selector, contexts[i], results );
+ }
+ return results;
+}
+
+function condense( unmatched, map, filter, context, xml ) {
+ var elem,
+ newUnmatched = [],
+ i = 0,
+ len = unmatched.length,
+ mapped = map != null;
+
+ for ( ; i < len; i++ ) {
+ if ( (elem = unmatched[i]) ) {
+ if ( !filter || filter( elem, context, xml ) ) {
+ newUnmatched.push( elem );
+ if ( mapped ) {
+ map.push( i );
+ }
+ }
+ }
+ }
+
+ return newUnmatched;
+}
+
+function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) {
+ if ( postFilter && !postFilter[ expando ] ) {
+ postFilter = setMatcher( postFilter );
+ }
+ if ( postFinder && !postFinder[ expando ] ) {
+ postFinder = setMatcher( postFinder, postSelector );
+ }
+ return markFunction(function( seed, results, context, xml ) {
+ var temp, i, elem,
+ preMap = [],
+ postMap = [],
+ preexisting = results.length,
+
+ // Get initial elements from seed or context
+ elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ),
+
+ // Prefilter to get matcher input, preserving a map for seed-results synchronization
+ matcherIn = preFilter && ( seed || !selector ) ?
+ condense( elems, preMap, preFilter, context, xml ) :
+ elems,
+
+ matcherOut = matcher ?
+ // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results,
+ postFinder || ( seed ? preFilter : preexisting || postFilter ) ?
+
+ // ...intermediate processing is necessary
+ [] :
+
+ // ...otherwise use results directly
+ results :
+ matcherIn;
+
+ // Find primary matches
+ if ( matcher ) {
+ matcher( matcherIn, matcherOut, context, xml );
+ }
+
+ // Apply postFilter
+ if ( postFilter ) {
+ temp = condense( matcherOut, postMap );
+ postFilter( temp, [], context, xml );
+
+ // Un-match failing elements by moving them back to matcherIn
+ i = temp.length;
+ while ( i-- ) {
+ if ( (elem = temp[i]) ) {
+ matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem);
+ }
+ }
+ }
+
+ if ( seed ) {
+ if ( postFinder || preFilter ) {
+ if ( postFinder ) {
+ // Get the final matcherOut by condensing this intermediate into postFinder contexts
+ temp = [];
+ i = matcherOut.length;
+ while ( i-- ) {
+ if ( (elem = matcherOut[i]) ) {
+ // Restore matcherIn since elem is not yet a final match
+ temp.push( (matcherIn[i] = elem) );
+ }
+ }
+ postFinder( null, (matcherOut = []), temp, xml );
+ }
+
+ // Move matched elements from seed to results to keep them synchronized
+ i = matcherOut.length;
+ while ( i-- ) {
+ if ( (elem = matcherOut[i]) &&
+ (temp = postFinder ? indexOf.call( seed, elem ) : preMap[i]) > -1 ) {
+
+ seed[temp] = !(results[temp] = elem);
+ }
+ }
+ }
+
+ // Add elements to results, through postFinder if defined
+ } else {
+ matcherOut = condense(
+ matcherOut === results ?
+ matcherOut.splice( preexisting, matcherOut.length ) :
+ matcherOut
+ );
+ if ( postFinder ) {
+ postFinder( null, results, matcherOut, xml );
+ } else {
+ push.apply( results, matcherOut );
+ }
+ }
+ });
+}
+
+function matcherFromTokens( tokens ) {
+ var checkContext, matcher, j,
+ len = tokens.length,
+ leadingRelative = Expr.relative[ tokens[0].type ],
+ implicitRelative = leadingRelative || Expr.relative[" "],
+ i = leadingRelative ? 1 : 0,
+
+ // The foundational matcher ensures that elements are reachable from top-level context(s)
+ matchContext = addCombinator( function( elem ) {
+ return elem === checkContext;
+ }, implicitRelative, true ),
+ matchAnyContext = addCombinator( function( elem ) {
+ return indexOf.call( checkContext, elem ) > -1;
+ }, implicitRelative, true ),
+ matchers = [ function( elem, context, xml ) {
+ return ( !leadingRelative && ( xml || context !== outermostContext ) ) || (
+ (checkContext = context).nodeType ?
+ matchContext( elem, context, xml ) :
+ matchAnyContext( elem, context, xml ) );
+ } ];
+
+ for ( ; i < len; i++ ) {
+ if ( (matcher = Expr.relative[ tokens[i].type ]) ) {
+ matchers = [ addCombinator(elementMatcher( matchers ), matcher) ];
+ } else {
+ matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches );
+
+ // Return special upon seeing a positional matcher
+ if ( matcher[ expando ] ) {
+ // Find the next relative operator (if any) for proper handling
+ j = ++i;
+ for ( ; j < len; j++ ) {
+ if ( Expr.relative[ tokens[j].type ] ) {
+ break;
+ }
+ }
+ return setMatcher(
+ i > 1 && elementMatcher( matchers ),
+ i > 1 && toSelector(
+ // If the preceding token was a descendant combinator, insert an implicit any-element `*`
+ tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" })
+ ).replace( rtrim, "$1" ),
+ matcher,
+ i < j && matcherFromTokens( tokens.slice( i, j ) ),
+ j < len && matcherFromTokens( (tokens = tokens.slice( j )) ),
+ j < len && toSelector( tokens )
+ );
+ }
+ matchers.push( matcher );
+ }
+ }
+
+ return elementMatcher( matchers );
+}
+
+function matcherFromGroupMatchers( elementMatchers, setMatchers ) {
+ var bySet = setMatchers.length > 0,
+ byElement = elementMatchers.length > 0,
+ superMatcher = function( seed, context, xml, results, outermost ) {
+ var elem, j, matcher,
+ matchedCount = 0,
+ i = "0",
+ unmatched = seed && [],
+ setMatched = [],
+ contextBackup = outermostContext,
+ // We must always have either seed elements or outermost context
+ elems = seed || byElement && Expr.find["TAG"]( "*", outermost ),
+ // Use integer dirruns iff this is the outermost matcher
+ dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1),
+ len = elems.length;
+
+ if ( outermost ) {
+ outermostContext = context !== document && context;
+ }
+
+ // Add elements passing elementMatchers directly to results
+ // Keep `i` a string if there are no elements so `matchedCount` will be "00" below
+ // Support: IE<9, Safari
+ // Tolerate NodeList properties (IE: "length"; Safari: <number>) matching elements by id
+ for ( ; i !== len && (elem = elems[i]) != null; i++ ) {
+ if ( byElement && elem ) {
+ j = 0;
+ while ( (matcher = elementMatchers[j++]) ) {
+ if ( matcher( elem, context, xml ) ) {
+ results.push( elem );
+ break;
+ }
+ }
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ }
+ }
+
+ // Track unmatched elements for set filters
+ if ( bySet ) {
+ // They will have gone through all possible matchers
+ if ( (elem = !matcher && elem) ) {
+ matchedCount--;
+ }
+
+ // Lengthen the array for every element, matched or not
+ if ( seed ) {
+ unmatched.push( elem );
+ }
+ }
+ }
+
+ // Apply set filters to unmatched elements
+ matchedCount += i;
+ if ( bySet && i !== matchedCount ) {
+ j = 0;
+ while ( (matcher = setMatchers[j++]) ) {
+ matcher( unmatched, setMatched, context, xml );
+ }
+
+ if ( seed ) {
+ // Reintegrate element matches to eliminate the need for sorting
+ if ( matchedCount > 0 ) {
+ while ( i-- ) {
+ if ( !(unmatched[i] || setMatched[i]) ) {
+ setMatched[i] = pop.call( results );
+ }
+ }
+ }
+
+ // Discard index placeholder values to get only actual matches
+ setMatched = condense( setMatched );
+ }
+
+ // Add matches to results
+ push.apply( results, setMatched );
+
+ // Seedless set matches succeeding multiple successful matchers stipulate sorting
+ if ( outermost && !seed && setMatched.length > 0 &&
+ ( matchedCount + setMatchers.length ) > 1 ) {
+
+ Sizzle.uniqueSort( results );
+ }
+ }
+
+ // Override manipulation of globals by nested matchers
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ outermostContext = contextBackup;
+ }
+
+ return unmatched;
+ };
+
+ return bySet ?
+ markFunction( superMatcher ) :
+ superMatcher;
+}
+
+compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) {
+ var i,
+ setMatchers = [],
+ elementMatchers = [],
+ cached = compilerCache[ selector + " " ];
+
+ if ( !cached ) {
+ // Generate a function of recursive functions that can be used to check each element
+ if ( !match ) {
+ match = tokenize( selector );
+ }
+ i = match.length;
+ while ( i-- ) {
+ cached = matcherFromTokens( match[i] );
+ if ( cached[ expando ] ) {
+ setMatchers.push( cached );
+ } else {
+ elementMatchers.push( cached );
+ }
+ }
+
+ // Cache the compiled function
+ cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) );
+
+ // Save selector and tokenization
+ cached.selector = selector;
+ }
+ return cached;
+};
+
+/**
+ * A low-level selection function that works with Sizzle's compiled
+ * selector functions
+ * @param {String|Function} selector A selector or a pre-compiled
+ * selector function built with Sizzle.compile
+ * @param {Element} context
+ * @param {Array} [results]
+ * @param {Array} [seed] A set of elements to match against
+ */
+select = Sizzle.select = function( selector, context, results, seed ) {
+ var i, tokens, token, type, find,
+ compiled = typeof selector === "function" && selector,
+ match = !seed && tokenize( (selector = compiled.selector || selector) );
+
+ results = results || [];
+
+ // Try to minimize operations if there is no seed and only one group
+ if ( match.length === 1 ) {
+
+ // Take a shortcut and set the context if the root selector is an ID
+ tokens = match[0] = match[0].slice( 0 );
+ if ( tokens.length > 2 && (token = tokens[0]).type === "ID" &&
+ support.getById && context.nodeType === 9 && documentIsHTML &&
+ Expr.relative[ tokens[1].type ] ) {
+
+ context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0];
+ if ( !context ) {
+ return results;
+
+ // Precompiled matchers will still verify ancestry, so step up a level
+ } else if ( compiled ) {
+ context = context.parentNode;
+ }
+
+ selector = selector.slice( tokens.shift().value.length );
+ }
+
+ // Fetch a seed set for right-to-left matching
+ i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length;
+ while ( i-- ) {
+ token = tokens[i];
+
+ // Abort if we hit a combinator
+ if ( Expr.relative[ (type = token.type) ] ) {
+ break;
+ }
+ if ( (find = Expr.find[ type ]) ) {
+ // Search, expanding context for leading sibling combinators
+ if ( (seed = find(
+ token.matches[0].replace( runescape, funescape ),
+ rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context
+ )) ) {
+
+ // If seed is empty or no tokens remain, we can return early
+ tokens.splice( i, 1 );
+ selector = seed.length && toSelector( tokens );
+ if ( !selector ) {
+ push.apply( results, seed );
+ return results;
+ }
+
+ break;
+ }
+ }
+ }
+ }
+
+ // Compile and execute a filtering function if one is not provided
+ // Provide `match` to avoid retokenization if we modified the selector above
+ ( compiled || compile( selector, match ) )(
+ seed,
+ context,
+ !documentIsHTML,
+ results,
+ rsibling.test( selector ) && testContext( context.parentNode ) || context
+ );
+ return results;
+};
+
+// One-time assignments
+
+// Sort stability
+support.sortStable = expando.split("").sort( sortOrder ).join("") === expando;
+
+// Support: Chrome<14
+// Always assume duplicates if they aren't passed to the comparison function
+support.detectDuplicates = !!hasDuplicate;
+
+// Initialize against the default document
+setDocument();
+
+// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27)
+// Detached nodes confoundingly follow *each other*
+support.sortDetached = assert(function( div1 ) {
+ // Should return 1, but returns 4 (following)
+ return div1.compareDocumentPosition( document.createElement("div") ) & 1;
+});
+
+// Support: IE<8
+// Prevent attribute/property "interpolation"
+// http://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx
+if ( !assert(function( div ) {
+ div.innerHTML = "<a href='#'></a>";
+ return div.firstChild.getAttribute("href") === "#" ;
+}) ) {
+ addHandle( "type|href|height|width", function( elem, name, isXML ) {
+ if ( !isXML ) {
+ return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 );
+ }
+ });
+}
+
+// Support: IE<9
+// Use defaultValue in place of getAttribute("value")
+if ( !support.attributes || !assert(function( div ) {
+ div.innerHTML = "<input/>";
+ div.firstChild.setAttribute( "value", "" );
+ return div.firstChild.getAttribute( "value" ) === "";
+}) ) {
+ addHandle( "value", function( elem, name, isXML ) {
+ if ( !isXML && elem.nodeName.toLowerCase() === "input" ) {
+ return elem.defaultValue;
+ }
+ });
+}
+
+// Support: IE<9
+// Use getAttributeNode to fetch booleans when getAttribute lies
+if ( !assert(function( div ) {
+ return div.getAttribute("disabled") == null;
+}) ) {
+ addHandle( booleans, function( elem, name, isXML ) {
+ var val;
+ if ( !isXML ) {
+ return elem[ name ] === true ? name.toLowerCase() :
+ (val = elem.getAttributeNode( name )) && val.specified ?
+ val.value :
+ null;
+ }
+ });
+}
+
+return Sizzle;
+
+})( window );
+
+
+
+jQuery.find = Sizzle;
+jQuery.expr = Sizzle.selectors;
+jQuery.expr[":"] = jQuery.expr.pseudos;
+jQuery.unique = Sizzle.uniqueSort;
+jQuery.text = Sizzle.getText;
+jQuery.isXMLDoc = Sizzle.isXML;
+jQuery.contains = Sizzle.contains;
+
+
+
+var rneedsContext = jQuery.expr.match.needsContext;
+
+var rsingleTag = (/^<(\w+)\s*\/?>(?:<\/\1>|)$/);
+
+
+
+var risSimple = /^.[^:#\[\.,]*$/;
+
+// Implement the identical functionality for filter and not
+function winnow( elements, qualifier, not ) {
+ if ( jQuery.isFunction( qualifier ) ) {
+ return jQuery.grep( elements, function( elem, i ) {
+ /* jshint -W018 */
+ return !!qualifier.call( elem, i, elem ) !== not;
+ });
+
+ }
+
+ if ( qualifier.nodeType ) {
+ return jQuery.grep( elements, function( elem ) {
+ return ( elem === qualifier ) !== not;
+ });
+
+ }
+
+ if ( typeof qualifier === "string" ) {
+ if ( risSimple.test( qualifier ) ) {
+ return jQuery.filter( qualifier, elements, not );
+ }
+
+ qualifier = jQuery.filter( qualifier, elements );
+ }
+
+ return jQuery.grep( elements, function( elem ) {
+ return ( jQuery.inArray( elem, qualifier ) >= 0 ) !== not;
+ });
+}
+
+jQuery.filter = function( expr, elems, not ) {
+ var elem = elems[ 0 ];
+
+ if ( not ) {
+ expr = ":not(" + expr + ")";
+ }
+
+ return elems.length === 1 && elem.nodeType === 1 ?
+ jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [] :
+ jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) {
+ return elem.nodeType === 1;
+ }));
+};
+
+jQuery.fn.extend({
+ find: function( selector ) {
+ var i,
+ ret = [],
+ self = this,
+ len = self.length;
+
+ if ( typeof selector !== "string" ) {
+ return this.pushStack( jQuery( selector ).filter(function() {
+ for ( i = 0; i < len; i++ ) {
+ if ( jQuery.contains( self[ i ], this ) ) {
+ return true;
+ }
+ }
+ }) );
+ }
+
+ for ( i = 0; i < len; i++ ) {
+ jQuery.find( selector, self[ i ], ret );
+ }
+
+ // Needed because $( selector, context ) becomes $( context ).find( selector )
+ ret = this.pushStack( len > 1 ? jQuery.unique( ret ) : ret );
+ ret.selector = this.selector ? this.selector + " " + selector : selector;
+ return ret;
+ },
+ filter: function( selector ) {
+ return this.pushStack( winnow(this, selector || [], false) );
+ },
+ not: function( selector ) {
+ return this.pushStack( winnow(this, selector || [], true) );
+ },
+ is: function( selector ) {
+ return !!winnow(
+ this,
+
+ // If this is a positional/relative selector, check membership in the returned set
+ // so $("p:first").is("p:last") won't return true for a doc with two "p".
+ typeof selector === "string" && rneedsContext.test( selector ) ?
+ jQuery( selector ) :
+ selector || [],
+ false
+ ).length;
+ }
+});
+
+
+// Initialize a jQuery object
+
+
+// A central reference to the root jQuery(document)
+var rootjQuery,
+
+ // Use the correct document accordingly with window argument (sandbox)
+ document = window.document,
+
+ // A simple way to check for HTML strings
+ // Prioritize #id over <tag> to avoid XSS via location.hash (#9521)
+ // Strict HTML recognition (#11290: must start with <)
+ rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,
+
+ init = jQuery.fn.init = function( selector, context ) {
+ var match, elem;
+
+ // HANDLE: $(""), $(null), $(undefined), $(false)
+ if ( !selector ) {
+ return this;
+ }
+
+ // Handle HTML strings
+ if ( typeof selector === "string" ) {
+ if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) {
+ // Assume that strings that start and end with <> are HTML and skip the regex check
+ match = [ null, selector, null ];
+
+ } else {
+ match = rquickExpr.exec( selector );
+ }
+
+ // Match html or make sure no context is specified for #id
+ if ( match && (match[1] || !context) ) {
+
+ // HANDLE: $(html) -> $(array)
+ if ( match[1] ) {
+ context = context instanceof jQuery ? context[0] : context;
+
+ // scripts is true for back-compat
+ // Intentionally let the error be thrown if parseHTML is not present
+ jQuery.merge( this, jQuery.parseHTML(
+ match[1],
+ context && context.nodeType ? context.ownerDocument || context : document,
+ true
+ ) );
+
+ // HANDLE: $(html, props)
+ if ( rsingleTag.test( match[1] ) && jQuery.isPlainObject( context ) ) {
+ for ( match in context ) {
+ // Properties of context are called as methods if possible
+ if ( jQuery.isFunction( this[ match ] ) ) {
+ this[ match ]( context[ match ] );
+
+ // ...and otherwise set as attributes
+ } else {
+ this.attr( match, context[ match ] );
+ }
+ }
+ }
+
+ return this;
+
+ // HANDLE: $(#id)
+ } else {
+ elem = document.getElementById( match[2] );
+
+ // Check parentNode to catch when Blackberry 4.6 returns
+ // nodes that are no longer in the document #6963
+ if ( elem && elem.parentNode ) {
+ // Handle the case where IE and Opera return items
+ // by name instead of ID
+ if ( elem.id !== match[2] ) {
+ return rootjQuery.find( selector );
+ }
+
+ // Otherwise, we inject the element directly into the jQuery object
+ this.length = 1;
+ this[0] = elem;
+ }
+
+ this.context = document;
+ this.selector = selector;
+ return this;
+ }
+
+ // HANDLE: $(expr, $(...))
+ } else if ( !context || context.jquery ) {
+ return ( context || rootjQuery ).find( selector );
+
+ // HANDLE: $(expr, context)
+ // (which is just equivalent to: $(context).find(expr)
+ } else {
+ return this.constructor( context ).find( selector );
+ }
+
+ // HANDLE: $(DOMElement)
+ } else if ( selector.nodeType ) {
+ this.context = this[0] = selector;
+ this.length = 1;
+ return this;
+
+ // HANDLE: $(function)
+ // Shortcut for document ready
+ } else if ( jQuery.isFunction( selector ) ) {
+ return typeof rootjQuery.ready !== "undefined" ?
+ rootjQuery.ready( selector ) :
+ // Execute immediately if ready is not present
+ selector( jQuery );
+ }
+
+ if ( selector.selector !== undefined ) {
+ this.selector = selector.selector;
+ this.context = selector.context;
+ }
+
+ return jQuery.makeArray( selector, this );
+ };
+
+// Give the init function the jQuery prototype for later instantiation
+init.prototype = jQuery.fn;
+
+// Initialize central reference
+rootjQuery = jQuery( document );
+
+
+var rparentsprev = /^(?:parents|prev(?:Until|All))/,
+ // methods guaranteed to produce a unique set when starting from a unique set
+ guaranteedUnique = {
+ children: true,
+ contents: true,
+ next: true,
+ prev: true
+ };
+
+jQuery.extend({
+ dir: function( elem, dir, until ) {
+ var matched = [],
+ cur = elem[ dir ];
+
+ while ( cur && cur.nodeType !== 9 && (until === undefined || cur.nodeType !== 1 || !jQuery( cur ).is( until )) ) {
+ if ( cur.nodeType === 1 ) {
+ matched.push( cur );
+ }
+ cur = cur[dir];
+ }
+ return matched;
+ },
+
+ sibling: function( n, elem ) {
+ var r = [];
+
+ for ( ; n; n = n.nextSibling ) {
+ if ( n.nodeType === 1 && n !== elem ) {
+ r.push( n );
+ }
+ }
+
+ return r;
+ }
+});
+
+jQuery.fn.extend({
+ has: function( target ) {
+ var i,
+ targets = jQuery( target, this ),
+ len = targets.length;
+
+ return this.filter(function() {
+ for ( i = 0; i < len; i++ ) {
+ if ( jQuery.contains( this, targets[i] ) ) {
+ return true;
+ }
+ }
+ });
+ },
+
+ closest: function( selectors, context ) {
+ var cur,
+ i = 0,
+ l = this.length,
+ matched = [],
+ pos = rneedsContext.test( selectors ) || typeof selectors !== "string" ?
+ jQuery( selectors, context || this.context ) :
+ 0;
+
+ for ( ; i < l; i++ ) {
+ for ( cur = this[i]; cur && cur !== context; cur = cur.parentNode ) {
+ // Always skip document fragments
+ if ( cur.nodeType < 11 && (pos ?
+ pos.index(cur) > -1 :
+
+ // Don't pass non-elements to Sizzle
+ cur.nodeType === 1 &&
+ jQuery.find.matchesSelector(cur, selectors)) ) {
+
+ matched.push( cur );
+ break;
+ }
+ }
+ }
+
+ return this.pushStack( matched.length > 1 ? jQuery.unique( matched ) : matched );
+ },
+
+ // Determine the position of an element within
+ // the matched set of elements
+ index: function( elem ) {
+
+ // No argument, return index in parent
+ if ( !elem ) {
+ return ( this[0] && this[0].parentNode ) ? this.first().prevAll().length : -1;
+ }
+
+ // index in selector
+ if ( typeof elem === "string" ) {
+ return jQuery.inArray( this[0], jQuery( elem ) );
+ }
+
+ // Locate the position of the desired element
+ return jQuery.inArray(
+ // If it receives a jQuery object, the first element is used
+ elem.jquery ? elem[0] : elem, this );
+ },
+
+ add: function( selector, context ) {
+ return this.pushStack(
+ jQuery.unique(
+ jQuery.merge( this.get(), jQuery( selector, context ) )
+ )
+ );
+ },
+
+ addBack: function( selector ) {
+ return this.add( selector == null ?
+ this.prevObject : this.prevObject.filter(selector)
+ );
+ }
+});
+
+function sibling( cur, dir ) {
+ do {
+ cur = cur[ dir ];
+ } while ( cur && cur.nodeType !== 1 );
+
+ return cur;
+}
+
+jQuery.each({
+ parent: function( elem ) {
+ var parent = elem.parentNode;
+ return parent && parent.nodeType !== 11 ? parent : null;
+ },
+ parents: function( elem ) {
+ return jQuery.dir( elem, "parentNode" );
+ },
+ parentsUntil: function( elem, i, until ) {
+ return jQuery.dir( elem, "parentNode", until );
+ },
+ next: function( elem ) {
+ return sibling( elem, "nextSibling" );
+ },
+ prev: function( elem ) {
+ return sibling( elem, "previousSibling" );
+ },
+ nextAll: function( elem ) {
+ return jQuery.dir( elem, "nextSibling" );
+ },
+ prevAll: function( elem ) {
+ return jQuery.dir( elem, "previousSibling" );
+ },
+ nextUntil: function( elem, i, until ) {
+ return jQuery.dir( elem, "nextSibling", until );
+ },
+ prevUntil: function( elem, i, until ) {
+ return jQuery.dir( elem, "previousSibling", until );
+ },
+ siblings: function( elem ) {
+ return jQuery.sibling( ( elem.parentNode || {} ).firstChild, elem );
+ },
+ children: function( elem ) {
+ return jQuery.sibling( elem.firstChild );
+ },
+ contents: function( elem ) {
+ return jQuery.nodeName( elem, "iframe" ) ?
+ elem.contentDocument || elem.contentWindow.document :
+ jQuery.merge( [], elem.childNodes );
+ }
+}, function( name, fn ) {
+ jQuery.fn[ name ] = function( until, selector ) {
+ var ret = jQuery.map( this, fn, until );
+
+ if ( name.slice( -5 ) !== "Until" ) {
+ selector = until;
+ }
+
+ if ( selector && typeof selector === "string" ) {
+ ret = jQuery.filter( selector, ret );
+ }
+
+ if ( this.length > 1 ) {
+ // Remove duplicates
+ if ( !guaranteedUnique[ name ] ) {
+ ret = jQuery.unique( ret );
+ }
+
+ // Reverse order for parents* and prev-derivatives
+ if ( rparentsprev.test( name ) ) {
+ ret = ret.reverse();
+ }
+ }
+
+ return this.pushStack( ret );
+ };
+});
+var rnotwhite = (/\S+/g);
+
+
+
+// String to Object options format cache
+var optionsCache = {};
+
+// Convert String-formatted options into Object-formatted ones and store in cache
+function createOptions( options ) {
+ var object = optionsCache[ options ] = {};
+ jQuery.each( options.match( rnotwhite ) || [], function( _, flag ) {
+ object[ flag ] = true;
+ });
+ return object;
+}
+
+/*
+ * Create a callback list using the following parameters:
+ *
+ * options: an optional list of space-separated options that will change how
+ * the callback list behaves or a more traditional option object
+ *
+ * By default a callback list will act like an event callback list and can be
+ * "fired" multiple times.
+ *
+ * Possible options:
+ *
+ * once: will ensure the callback list can only be fired once (like a Deferred)
+ *
+ * memory: will keep track of previous values and will call any callback added
+ * after the list has been fired right away with the latest "memorized"
+ * values (like a Deferred)
+ *
+ * unique: will ensure a callback can only be added once (no duplicate in the list)
+ *
+ * stopOnFalse: interrupt callings when a callback returns false
+ *
+ */
+jQuery.Callbacks = function( options ) {
+
+ // Convert options from String-formatted to Object-formatted if needed
+ // (we check in cache first)
+ options = typeof options === "string" ?
+ ( optionsCache[ options ] || createOptions( options ) ) :
+ jQuery.extend( {}, options );
+
+ var // Flag to know if list is currently firing
+ firing,
+ // Last fire value (for non-forgettable lists)
+ memory,
+ // Flag to know if list was already fired
+ fired,
+ // End of the loop when firing
+ firingLength,
+ // Index of currently firing callback (modified by remove if needed)
+ firingIndex,
+ // First callback to fire (used internally by add and fireWith)
+ firingStart,
+ // Actual callback list
+ list = [],
+ // Stack of fire calls for repeatable lists
+ stack = !options.once && [],
+ // Fire callbacks
+ fire = function( data ) {
+ memory = options.memory && data;
+ fired = true;
+ firingIndex = firingStart || 0;
+ firingStart = 0;
+ firingLength = list.length;
+ firing = true;
+ for ( ; list && firingIndex < firingLength; firingIndex++ ) {
+ if ( list[ firingIndex ].apply( data[ 0 ], data[ 1 ] ) === false && options.stopOnFalse ) {
+ memory = false; // To prevent further calls using add
+ break;
+ }
+ }
+ firing = false;
+ if ( list ) {
+ if ( stack ) {
+ if ( stack.length ) {
+ fire( stack.shift() );
+ }
+ } else if ( memory ) {
+ list = [];
+ } else {
+ self.disable();
+ }
+ }
+ },
+ // Actual Callbacks object
+ self = {
+ // Add a callback or a collection of callbacks to the list
+ add: function() {
+ if ( list ) {
+ // First, we save the current length
+ var start = list.length;
+ (function add( args ) {
+ jQuery.each( args, function( _, arg ) {
+ var type = jQuery.type( arg );
+ if ( type === "function" ) {
+ if ( !options.unique || !self.has( arg ) ) {
+ list.push( arg );
+ }
+ } else if ( arg && arg.length && type
<TRUNCATED>
[50/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_monitor.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_monitor.rst.txt b/docs/latest/_sources/admin/traffic_monitor.rst.txt
deleted file mode 100644
index 3a06e78..0000000
--- a/docs/latest/_sources/admin/traffic_monitor.rst.txt
+++ /dev/null
@@ -1,142 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-******************************
-Traffic Monitor Administration
-******************************
-Installing Traffic Monitor
-==========================
-The following are requirements to ensure an accurate set up:
-
-* CentOS 6
-* 4 vCPUs
-* 8GB RAM
-* Successful install of Traffic Ops
-* Tomcat
-* Administrative access to the Traffic Ops
-* Physical address of the site
-* perl-JSON
-* perl-WWW-Curl
-
-1. Enter the Traffic Monitor server into Traffic Ops
-2. Make sure the FQDN of the Traffic Monitor is resolvable in DNS.
-3. Install Traffic Monitor and Perl mods: ``sudo yum -y install traffic_monitor perl-JSON perl-WWW-Curl``
-4. Take the config from Traffic Ops - run : ``sudo /opt/traffic_monitor/bin/traffic_monitor_config.pl``
-
- Sample output: ::
-
- traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
- DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
- DEBUG: traffic_ops login: admin:kl0tevax
- DEBUG: Config write mode: prompt
- DEBUG: Found profile from traffic_ops: RASCAL_CDN
- DEBUG: Found CDN name from traffic_ops: kabletown_cdn
- DEBUG: Found location for rascal-config.txt from traffic_ops: /opt/traffic_monitor/conf
- WARN: Param not in traffic_ops: allow.config.edit description: Allow the running configuration to be edited through the UI Using default value of: false
- WARN: Param not in traffic_ops: default.accessControlAllowOrigin description: The value for the header: Access-Control-Allow-Origin for published jsons... should be narrowed down to TMs Using default value of: *
- WARN: Param not in traffic_ops: default.connection.timeout description: Default connection time for all queries (cache, peers, TM) Using default value of: 2000
- WARN: Param not in traffic_ops: hack.forceSystemExit description: Call System.exit on shutdown Using default value of: false
- WARN: Param not in traffic_ops: hack.peerOptimistic description: The assumption of a caches availability when unknown by peers Using default value of: true
- WARN: Param not in traffic_ops: hack.publishDsStates description: If true, the delivery service states will be included in the CrStates.json Using default value of: true
- WARN: Param not in traffic_ops: health.ds.interval description: The polling frequency for calculating the deliveryService states Using default value of: 1000
- WARN: Param not in traffic_ops: health.ds.leniency description: The amount of time before the deliveryService disregards the last update from a non-responsive cache Using default value of: 30000
- WARN: Param not in traffic_ops: health.event-count description: The number of historical events that will be kept Using default value of: 200
- WARN: Param not in traffic_ops: health.polling.interval description: The polling frequency for getting the states from caches Using default value of: 5000
- WARN: Param not in traffic_ops: health.startupMinCycles description: The number of query cycles that must be completed before this Traffic Monitor will start reporting Using default value of: 2
- WARN: Param not in traffic_ops: health.timepad description: A delay between each separate cache query Using default value of: 10
- WARN: Param not in traffic_ops: peers.polling.interval description: Polling frequency for getting states from peer monitors Using default value of: 5000
- WARN: Param not in traffic_ops: peers.polling.url description: The url for current, unfiltered states from peer monitors Using default value of: http://${hostname}/publish/CrStates?raw
- WARN: Param not in traffic_ops: peers.threadPool description: The number of threads given to the pool for querying peers Using default value of: 1
- WARN: Param not in traffic_ops: tm.auth.url description: The url for the authentication form Using default value of: https://${tmHostname}/login
- WARN: Param not in traffic_ops: tm.crConfig.json.polling.url description: Url for the cr-config (json) Using default value of: https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json
- WARN: Param not in traffic_ops: tm.healthParams.polling.url description: The url for the heath params (json) Using default value of: https://${tmHostname}/health/${cdnName}
- WARN: Param not in traffic_ops: tm.polling.interval description: The polling frequency for getting updates from TM Using default value of: 10000
- DEBUG: allow.config.edit needed in config, but does not exist in config on disk.
- DEBUG: cdnName value on disk () does not match value needed in config (kabletown_cdn).
- DEBUG: default.accessControlAllowOrigin needed in config, but does not exist in config on disk.
- DEBUG: default.connection.timeout needed in config, but does not exist in config on disk.
- DEBUG: hack.forceSystemExit needed in config, but does not exist in config on disk.
- DEBUG: hack.peerOptimistic needed in config, but does not exist in config on disk.
- DEBUG: hack.publishDsStates needed in config, but does not exist in config on disk.
- DEBUG: health.ds.interval needed in config, but does not exist in config on disk.
- DEBUG: health.ds.leniency needed in config, but does not exist in config on disk.
- DEBUG: health.startupMinCycles needed in config, but does not exist in config on disk.
- DEBUG: health.timepad value on disk (20) does not match value needed in config (10).
- DEBUG: peers.polling.interval needed in config, but does not exist in config on disk.
- DEBUG: peers.threadPool needed in config, but does not exist in config on disk.
- DEBUG: tm.auth.password value on disk () does not match value needed in config (kl0tevax).
- DEBUG: tm.auth.username value on disk () does not match value needed in config (admin).
- DEBUG: tm.hostname value on disk () does not match value needed in config (traffic-ops.cdn.kabletown.net).
- DEBUG: Proposed traffic_monitor_config:
- {
- "traffic_monitor_config":{
- "default.accessControlAllowOrigin":"*",
- "health.startupMinCycles":"2",
- "tm.auth.password":"kl0tevax",
- "tm.auth.url":"https://${tmHostname}/login",
- "tm.healthParams.polling.url":"https://${tmHostname}/health/${cdnName}",
- "allow.config.edit":"false",
- "tm.crConfig.json.polling.url":"https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json",
- "tm.auth.username":"admin",
- "peers.polling.url":"http://${hostname}/publish/CrStates?raw",
- "health.timepad":"10",
- "hack.publishDsStates":"true",
- "default.connection.timeout":"2000",
- "health.ds.interval":"1000",
- "peers.polling.interval":"5000",
- "hack.forceSystemExit":"false",
- "health.ds.leniency":"30000",
- "cdnName":"kabletown_cdn",
- "peers.threadPool":"1",
- "tm.polling.interval":"10000",
- "health.polling.interval":"5000",
- "health.event-count":"200",
- "hack.peerOptimistic":"true",
- "tm.hostname":"traffic-ops.cdn.kabletown.net"
- }
- }
- ----------------------------------------------
- ----OK to write this config to disk? (Y/n) [n]y
- ----------------------------------------------
- ----------------------------------------------
- ----OK to write this config to disk? (Y/n) [n]Y
- ----------------------------------------------
- DEBUG: Writing /opt/traffic_monitor/conf/traffic_monitor_config.js
- traffic_mon #
-
-5. Start Tomcat: ``sudo service tomcat start`` ::
-
-
- Using CATALINA_BASE: /opt/tomcat
- Using CATALINA_HOME: /opt/tomcat
- Using CATALINA_TMPDIR: /opt/tomcat/temp
- Using JRE_HOME: /usr
- Using CLASSPATH:/opt/tomcat/bin/bootstrap.jar
- Using CATALINA_PID:/var/run/tomcat/tomcat.pid
- Starting tomcat [ OK ]
-
-6. Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host.
-
-Configuring Traffic Monitor
-===========================
-
-Configuration Overview
-----------------------
-Traffic Monitor is configured using its JSON configuration file, ``traffic_monitor_config.js``. Specify the URL, username, password, and CDN name for the instance of Traffic Ops for which this Traffic Monitor is a member, and start the software. Once started with the correct configuration, Traffic Monitor downloads its configuration from Traffic Ops and begins polling caches. Once a configurable number of polling cycles completes, health protocol state is available via RESTful JSON endpoints.
-
-
-Troubleshooting and log files
-=============================
-Traffic Monitor log files are in ``/opt/traffic_monitor/var/log/``, and tomcat log files are in ``/opt/tomcat/logs/``.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_monitor.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_monitor.txt b/docs/latest/_sources/admin/traffic_monitor.txt
new file mode 100644
index 0000000..3a06e78
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_monitor.txt
@@ -0,0 +1,142 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+******************************
+Traffic Monitor Administration
+******************************
+Installing Traffic Monitor
+==========================
+The following are requirements to ensure an accurate set up:
+
+* CentOS 6
+* 4 vCPUs
+* 8GB RAM
+* Successful install of Traffic Ops
+* Tomcat
+* Administrative access to the Traffic Ops
+* Physical address of the site
+* perl-JSON
+* perl-WWW-Curl
+
+1. Enter the Traffic Monitor server into Traffic Ops
+2. Make sure the FQDN of the Traffic Monitor is resolvable in DNS.
+3. Install Traffic Monitor and Perl mods: ``sudo yum -y install traffic_monitor perl-JSON perl-WWW-Curl``
+4. Take the config from Traffic Ops - run : ``sudo /opt/traffic_monitor/bin/traffic_monitor_config.pl``
+
+ Sample output: ::
+
+ traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
+ DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
+ DEBUG: traffic_ops login: admin:kl0tevax
+ DEBUG: Config write mode: prompt
+ DEBUG: Found profile from traffic_ops: RASCAL_CDN
+ DEBUG: Found CDN name from traffic_ops: kabletown_cdn
+ DEBUG: Found location for rascal-config.txt from traffic_ops: /opt/traffic_monitor/conf
+ WARN: Param not in traffic_ops: allow.config.edit description: Allow the running configuration to be edited through the UI Using default value of: false
+ WARN: Param not in traffic_ops: default.accessControlAllowOrigin description: The value for the header: Access-Control-Allow-Origin for published jsons... should be narrowed down to TMs Using default value of: *
+ WARN: Param not in traffic_ops: default.connection.timeout description: Default connection time for all queries (cache, peers, TM) Using default value of: 2000
+ WARN: Param not in traffic_ops: hack.forceSystemExit description: Call System.exit on shutdown Using default value of: false
+ WARN: Param not in traffic_ops: hack.peerOptimistic description: The assumption of a caches availability when unknown by peers Using default value of: true
+ WARN: Param not in traffic_ops: hack.publishDsStates description: If true, the delivery service states will be included in the CrStates.json Using default value of: true
+ WARN: Param not in traffic_ops: health.ds.interval description: The polling frequency for calculating the deliveryService states Using default value of: 1000
+ WARN: Param not in traffic_ops: health.ds.leniency description: The amount of time before the deliveryService disregards the last update from a non-responsive cache Using default value of: 30000
+ WARN: Param not in traffic_ops: health.event-count description: The number of historical events that will be kept Using default value of: 200
+ WARN: Param not in traffic_ops: health.polling.interval description: The polling frequency for getting the states from caches Using default value of: 5000
+ WARN: Param not in traffic_ops: health.startupMinCycles description: The number of query cycles that must be completed before this Traffic Monitor will start reporting Using default value of: 2
+ WARN: Param not in traffic_ops: health.timepad description: A delay between each separate cache query Using default value of: 10
+ WARN: Param not in traffic_ops: peers.polling.interval description: Polling frequency for getting states from peer monitors Using default value of: 5000
+ WARN: Param not in traffic_ops: peers.polling.url description: The url for current, unfiltered states from peer monitors Using default value of: http://${hostname}/publish/CrStates?raw
+ WARN: Param not in traffic_ops: peers.threadPool description: The number of threads given to the pool for querying peers Using default value of: 1
+ WARN: Param not in traffic_ops: tm.auth.url description: The url for the authentication form Using default value of: https://${tmHostname}/login
+ WARN: Param not in traffic_ops: tm.crConfig.json.polling.url description: Url for the cr-config (json) Using default value of: https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json
+ WARN: Param not in traffic_ops: tm.healthParams.polling.url description: The url for the heath params (json) Using default value of: https://${tmHostname}/health/${cdnName}
+ WARN: Param not in traffic_ops: tm.polling.interval description: The polling frequency for getting updates from TM Using default value of: 10000
+ DEBUG: allow.config.edit needed in config, but does not exist in config on disk.
+ DEBUG: cdnName value on disk () does not match value needed in config (kabletown_cdn).
+ DEBUG: default.accessControlAllowOrigin needed in config, but does not exist in config on disk.
+ DEBUG: default.connection.timeout needed in config, but does not exist in config on disk.
+ DEBUG: hack.forceSystemExit needed in config, but does not exist in config on disk.
+ DEBUG: hack.peerOptimistic needed in config, but does not exist in config on disk.
+ DEBUG: hack.publishDsStates needed in config, but does not exist in config on disk.
+ DEBUG: health.ds.interval needed in config, but does not exist in config on disk.
+ DEBUG: health.ds.leniency needed in config, but does not exist in config on disk.
+ DEBUG: health.startupMinCycles needed in config, but does not exist in config on disk.
+ DEBUG: health.timepad value on disk (20) does not match value needed in config (10).
+ DEBUG: peers.polling.interval needed in config, but does not exist in config on disk.
+ DEBUG: peers.threadPool needed in config, but does not exist in config on disk.
+ DEBUG: tm.auth.password value on disk () does not match value needed in config (kl0tevax).
+ DEBUG: tm.auth.username value on disk () does not match value needed in config (admin).
+ DEBUG: tm.hostname value on disk () does not match value needed in config (traffic-ops.cdn.kabletown.net).
+ DEBUG: Proposed traffic_monitor_config:
+ {
+ "traffic_monitor_config":{
+ "default.accessControlAllowOrigin":"*",
+ "health.startupMinCycles":"2",
+ "tm.auth.password":"kl0tevax",
+ "tm.auth.url":"https://${tmHostname}/login",
+ "tm.healthParams.polling.url":"https://${tmHostname}/health/${cdnName}",
+ "allow.config.edit":"false",
+ "tm.crConfig.json.polling.url":"https://${tmHostname}/CRConfig-Snapshots/${cdnName}/CRConfig.json",
+ "tm.auth.username":"admin",
+ "peers.polling.url":"http://${hostname}/publish/CrStates?raw",
+ "health.timepad":"10",
+ "hack.publishDsStates":"true",
+ "default.connection.timeout":"2000",
+ "health.ds.interval":"1000",
+ "peers.polling.interval":"5000",
+ "hack.forceSystemExit":"false",
+ "health.ds.leniency":"30000",
+ "cdnName":"kabletown_cdn",
+ "peers.threadPool":"1",
+ "tm.polling.interval":"10000",
+ "health.polling.interval":"5000",
+ "health.event-count":"200",
+ "hack.peerOptimistic":"true",
+ "tm.hostname":"traffic-ops.cdn.kabletown.net"
+ }
+ }
+ ----------------------------------------------
+ ----OK to write this config to disk? (Y/n) [n]y
+ ----------------------------------------------
+ ----------------------------------------------
+ ----OK to write this config to disk? (Y/n) [n]Y
+ ----------------------------------------------
+ DEBUG: Writing /opt/traffic_monitor/conf/traffic_monitor_config.js
+ traffic_mon #
+
+5. Start Tomcat: ``sudo service tomcat start`` ::
+
+
+ Using CATALINA_BASE: /opt/tomcat
+ Using CATALINA_HOME: /opt/tomcat
+ Using CATALINA_TMPDIR: /opt/tomcat/temp
+ Using JRE_HOME: /usr
+ Using CLASSPATH:/opt/tomcat/bin/bootstrap.jar
+ Using CATALINA_PID:/var/run/tomcat/tomcat.pid
+ Starting tomcat [ OK ]
+
+6. Verify Traffic Monitor is running by pointing your browser to port 80 on the Traffic Monitor host.
+
+Configuring Traffic Monitor
+===========================
+
+Configuration Overview
+----------------------
+Traffic Monitor is configured using its JSON configuration file, ``traffic_monitor_config.js``. Specify the URL, username, password, and CDN name for the instance of Traffic Ops for which this Traffic Monitor is a member, and start the software. Once started with the correct configuration, Traffic Monitor downloads its configuration from Traffic Ops and begins polling caches. Once a configurable number of polling cycles completes, health protocol state is available via RESTful JSON endpoints.
+
+
+Troubleshooting and log files
+=============================
+Traffic Monitor log files are in ``/opt/traffic_monitor/var/log/``, and tomcat log files are in ``/opt/tomcat/logs/``.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_ops_config.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_config.rst.txt b/docs/latest/_sources/admin/traffic_ops_config.rst.txt
deleted file mode 100644
index 0ca57da..0000000
--- a/docs/latest/_sources/admin/traffic_ops_config.rst.txt
+++ /dev/null
@@ -1,186 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Configuring Traffic Ops
-%%%%%%%%%%%%%%%%%%%%%%%
-
-Follow the steps below to configure the newly installed Traffic Ops Instance.
-
-Installing the SSL Cert
-=======================
-By default, Traffic Ops runs as an SSL web server, and a certificate needs to be installed. TBD.
-
-Content Delivery Networks
-=========================
-
-.. _rl-param-prof:
-
-Profile Parameters
-======================
-Many of the settings for the different servers in a Traffic Control CDN are controlled by parameters in the parameter view of Traffic Ops. Parameters are grouped in profiles and profiles are assigned to a server. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings. To make life easier, Traffic Ops allows for duplication, comparison, import and export of Profiles. Traffic Ops also has a "Global profile" - the parameters in this profile are going to be applied to all servers in the Traffic Ops instance, or apply to Traffic Ops themselves. These parameters are:
-
-
-.. index::
- Global Profile
-
-+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-| Name | Config file | Value |
-+==========================+===============+=======================================================================================================================================+
-| tm.url | global | The URL where this Traffic Ops instance is being served from. |
-+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-| tm.toolname | global | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated. |
-+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-| tm.infourl | global | This is the "for more information go here" URL, which is visible in the About page. |
-+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-| tm.logourl | global | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. |
-+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-| tm.instance_name | global | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. |
-+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-| tm.traffic_mon_fwd_proxy | global | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. |
-| | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
-| | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
-| | | set this parameter on a production system. |
-+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-| geolocation.polling.url | CRConfig.json | The location to get the GeoLiteCity database from. |
-+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-| geolocation6.polling.url | CRConfig.json | The location to get the IPv6 GeoLiteCity database from. |
-+--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
-
-These parameters should be set to reflect the local environment.
-
-
-After running the postinstall script, Traffic Ops has the following profiles pre-loaded:
-
-+----------+-------------------------------------------------------------------------------------------------+
-| Name | Description |
-+==========+=================================================================================================+
-| EDGE1 | The profile to be applied to the latest supported version of ATS, when running as an EDGE cache |
-+----------+-------------------------------------------------------------------------------------------------+
-| TR1 | The profile to be applied to the latest version of Traffic Router |
-+----------+-------------------------------------------------------------------------------------------------+
-| TM1 | The profile to be applied to the latest version of Traffic Monitor |
-+----------+-------------------------------------------------------------------------------------------------+
-| MID1 | The profile to be applied to the latest supported version of ATS, when running as an MID cache |
-+----------+-------------------------------------------------------------------------------------------------+
-| RIAK_ALL | Riak profile for all CDNs to be applied to the Traffic Vault servers |
-+----------+-------------------------------------------------------------------------------------------------+
-
-.. Note:: The Traffic Server profiles contain some information that is specific to the hardware being used (most notably the disk configuration), so some parameters will have to be changed to reflect your configuration. Future releases of Traffic Control will separate the hardware and software profiles so it is easier to "mix-and-match" different hardware configurations.
-
-Below is a list of cache parameters that are likely to need changes from the default profiles shipped with Traffic Ops:
-
-+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-| Name | Config file | Description |
-+==========================+===================+=========================================================================================================================+
-| allow_ip | astats.config | This is a comma separated list of IPv4 CIDR blocks that will have access to the astats statistics on the caches. |
-| | | The Traffic Monitor IP addresses have to be included in this, if they are using IPv4 to monitor the caches. |
-+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-| allow_ip6 | astats.config | This is a comma separated list of IPv6 CIDR blocks that will have access to the astats statistics on the caches. |
-| | | The Traffic Monitor IP addresses have to be included in this, if they are using IPv6 to monitor the caches. |
-+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-| Drive_Prefix | storage.config | JvD/Jeff to supply blurb |
-+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-| Drive_Letters | storage.config | JvD/Jeff to supply blurb |
-+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-| purge_allow_ip | ip_allow.config | The IP address range that is allowed to execute the PURGE method on the caches (not related to :ref:`rl-purge`) |
-+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-| health.threshold.loadavg | rascal.properties | The Unix load average at which Traffic Router will stop sending traffic to this cache |
-+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-| health.threshold.\\ | rascal.properties | The amount of bandwidth that Traffic Router will try to keep available on the cache. |
-| availableBandwidthInKbps | | For example: "">1500000" means stop sending new traffic to this cache when traffic is at 8.5Gbps on a 10Gbps interface. |
-+--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
-
-Below is a list of Traffic Server plugins that need to be configured in the parameter table:
-
-+------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
-| Name | Config file | Description | Details |
-+==================+===============+======================================================+============================================================================================================+
-| astats_over_http | package | The package version for the astats_over_http plugin. | `astats_over_http <http://trafficcontrol.apache.org/downloads/index.html>`_ |
-+------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
-| trafficserver | package | The package version for the trafficserver plugin. | `trafficserver <http://trafficcontrol.apache.org/downloads/index.html>`_ |
-+------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
-| regex_revalidate | plugin.config | The config to be used for regex_revalidate. | `regex_revalidate <https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html>`_ |
-| | | For example: --config regex_revalidate.config | |
-+------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
-| remap_stats | plugin.config | The config to be used for remap_stats. | `remap_stats <https://github.com/apache/trafficserver/tree/master/plugins/experimental/remap_stats>`_ |
-| | | Value is left blank. | |
-+------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
-
-
-Regions, Locations and Cache Groups
-===================================
-All servers have to have a `location`, which is their physical location. Each location is part of a `region`, and each region is part of a `division`. For Example, ``Denver`` could be a location in the ``Mile High`` region and that region could be part of the ``West`` division. Enter your divisions first in `Misc->Divisions`, then enter the regions in `Misc->Regions`, referencing the divisions entered, and finally, enter the physical locations in `Misc->Locations`, referencing the regions entered.
-
-All servers also have to be part of a `cache group`. A cache group is a logical grouping of caches, that don't have to be in the same physical location (in fact, usually a cache group is spread across minimally 2 physical Locations for redundancy purposes), but share geo coordinates for content routing purposes. JvD to add more.
-
-
-
-Configuring Content Purge
-=========================
-Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the `Regex Revalidate Plugin <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html>`_ to purge content from the system. We don't actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it's config file, and will pick up changes to it without a `traffic_line -x` signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the lower tiers with the content that should be purged from the highe
r tiers without hitting the origin. This is why the ort script (see :ref:`reference-traffic-ops-ort`) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the `regex_revalidate.config` file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the `regex_revalidate.config` file.
-
-Content Purge is controlled by the following parameters in the profile of the cache:
-
-+----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Name | Config file | Description | Details |
-+======================+=========================+==================================================+=========================================================================================================================================================+
-| location | regex_revalidate.config | What location the file should be in on the cache | The presence of this parameter tells ort to distribute this file; delete this parameter from the profile if this file is distributed using other means. |
-+----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
-| maxRevalDurationDays | regex_revalidate.config | The maximum time a purge can be active | To prevent a build up of many checks before each request, this is longest time the system will allow |
-+----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
-| regex_revalidate | plugin.config | The config to be used for regex_revalidate. | `regex_revalidate <https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html>`_ |
-| | | For example: --config regex_revalidate.config | |
-+----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-Note that the TTL the adminstrator enters in the purge request should be longer than the TTL of the content to ensure the bad content will not be used. If the CDN is serving content of unknown, or unlimited TTL, the administrator should consider using `proxy-config-http-cache-guaranteed-min-lifetime <https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html#proxy-config-http-cache-guaranteed-min-lifetime>`_ to limit the maximum time an object can be in the cache before it is considered stale, and set that to the same value as `maxRevalDurationDays` (Note that the former is in seconds and the latter is in days, so convert appropriately).
-
-
-
-.. _Creating-CentOS-Kickstart:
-
-Creating the CentOS Kickstart File
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-The kickstart file is a text file, containing a list of items, each identified by a keyword. You can create it by using the Kickstart Configurator application, or writing it from scratch. The Red Hat Enterprise Linux installation program also creates a sample kickstart file based on the options that you selected during installation. It is written to the file ``/root/anaconda-ks.cfg``. This file is editable using most text editors that can save files as ASCII text.
-
-To generate ISO, the CentOS Kickstart is necessary:
-
-1. Create a kickstart file.
-2. Create a boot media with the kickstart file or make the kickstart file available on the network.
-3. Make the installation tree available.
-4. Start the kickstart installation.
-
-Create a ks.src file in the root of the selection location. See the example below:
-
-::
-
-
- mkdir newdir
- cd newdir/
- cp -r ../centos65/* .
- vim ks.src
- vim isolinux/isolinux.cfg
- cd vim osversions.cfg
- vim osversions.cfg
-
-
-This is a standard kickstart formatted file that the generate ISO process uses to create the kickstart (ks.cfg) file for the install. The generate ISO process uses the ks.src, overwriting any information set in the Generate ISO tab in Traffic Ops, creating ks.cfg.
-
-.. Note:: Streamline your install folder for under 1GB, which assists in creating a CD.
-
-.. seealso:: For in-depth instructions, please see `Kickstart Installation <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Installation_Guide/s1-kickstart2-howuse.html>`_
-
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_ops_config.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_config.txt b/docs/latest/_sources/admin/traffic_ops_config.txt
new file mode 100644
index 0000000..0ca57da
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops_config.txt
@@ -0,0 +1,186 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Configuring Traffic Ops
+%%%%%%%%%%%%%%%%%%%%%%%
+
+Follow the steps below to configure the newly installed Traffic Ops Instance.
+
+Installing the SSL Cert
+=======================
+By default, Traffic Ops runs as an SSL web server, and a certificate needs to be installed. TBD.
+
+Content Delivery Networks
+=========================
+
+.. _rl-param-prof:
+
+Profile Parameters
+======================
+Many of the settings for the different servers in a Traffic Control CDN are controlled by parameters in the parameter view of Traffic Ops. Parameters are grouped in profiles and profiles are assigned to a server. For a typical cache there are hundreds of configuration settings to apply. The Traffic Ops parameter view contains the defined settings. To make life easier, Traffic Ops allows for duplication, comparison, import and export of Profiles. Traffic Ops also has a "Global profile" - the parameters in this profile are going to be applied to all servers in the Traffic Ops instance, or apply to Traffic Ops themselves. These parameters are:
+
+
+.. index::
+ Global Profile
+
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Config file | Value |
++==========================+===============+=======================================================================================================================================+
+| tm.url | global | The URL where this Traffic Ops instance is being served from. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.toolname | global | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.infourl | global | This is the "for more information go here" URL, which is visible in the About page. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.logourl | global | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.instance_name | global | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| tm.traffic_mon_fwd_proxy | global | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. |
+| | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+| | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
+| | | set this parameter on a production system. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| geolocation.polling.url | CRConfig.json | The location to get the GeoLiteCity database from. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+| geolocation6.polling.url | CRConfig.json | The location to get the IPv6 GeoLiteCity database from. |
++--------------------------+---------------+---------------------------------------------------------------------------------------------------------------------------------------+
+
+These parameters should be set to reflect the local environment.
+
+
+After running the postinstall script, Traffic Ops has the following profiles pre-loaded:
+
++----------+-------------------------------------------------------------------------------------------------+
+| Name | Description |
++==========+=================================================================================================+
+| EDGE1 | The profile to be applied to the latest supported version of ATS, when running as an EDGE cache |
++----------+-------------------------------------------------------------------------------------------------+
+| TR1 | The profile to be applied to the latest version of Traffic Router |
++----------+-------------------------------------------------------------------------------------------------+
+| TM1 | The profile to be applied to the latest version of Traffic Monitor |
++----------+-------------------------------------------------------------------------------------------------+
+| MID1 | The profile to be applied to the latest supported version of ATS, when running as an MID cache |
++----------+-------------------------------------------------------------------------------------------------+
+| RIAK_ALL | Riak profile for all CDNs to be applied to the Traffic Vault servers |
++----------+-------------------------------------------------------------------------------------------------+
+
+.. Note:: The Traffic Server profiles contain some information that is specific to the hardware being used (most notably the disk configuration), so some parameters will have to be changed to reflect your configuration. Future releases of Traffic Control will separate the hardware and software profiles so it is easier to "mix-and-match" different hardware configurations.
+
+Below is a list of cache parameters that are likely to need changes from the default profiles shipped with Traffic Ops:
+
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| Name | Config file | Description |
++==========================+===================+=========================================================================================================================+
+| allow_ip | astats.config | This is a comma separated list of IPv4 CIDR blocks that will have access to the astats statistics on the caches. |
+| | | The Traffic Monitor IP addresses have to be included in this, if they are using IPv4 to monitor the caches. |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| allow_ip6 | astats.config | This is a comma separated list of IPv6 CIDR blocks that will have access to the astats statistics on the caches. |
+| | | The Traffic Monitor IP addresses have to be included in this, if they are using IPv6 to monitor the caches. |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| Drive_Prefix | storage.config | JvD/Jeff to supply blurb |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| Drive_Letters | storage.config | JvD/Jeff to supply blurb |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| purge_allow_ip | ip_allow.config | The IP address range that is allowed to execute the PURGE method on the caches (not related to :ref:`rl-purge`) |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| health.threshold.loadavg | rascal.properties | The Unix load average at which Traffic Router will stop sending traffic to this cache |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+| health.threshold.\\ | rascal.properties | The amount of bandwidth that Traffic Router will try to keep available on the cache. |
+| availableBandwidthInKbps | | For example: "">1500000" means stop sending new traffic to this cache when traffic is at 8.5Gbps on a 10Gbps interface. |
++--------------------------+-------------------+-------------------------------------------------------------------------------------------------------------------------+
+
+Below is a list of Traffic Server plugins that need to be configured in the parameter table:
+
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| Name | Config file | Description | Details |
++==================+===============+======================================================+============================================================================================================+
+| astats_over_http | package | The package version for the astats_over_http plugin. | `astats_over_http <http://trafficcontrol.apache.org/downloads/index.html>`_ |
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| trafficserver | package | The package version for the trafficserver plugin. | `trafficserver <http://trafficcontrol.apache.org/downloads/index.html>`_ |
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| regex_revalidate | plugin.config | The config to be used for regex_revalidate. | `regex_revalidate <https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html>`_ |
+| | | For example: --config regex_revalidate.config | |
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+| remap_stats | plugin.config | The config to be used for remap_stats. | `remap_stats <https://github.com/apache/trafficserver/tree/master/plugins/experimental/remap_stats>`_ |
+| | | Value is left blank. | |
++------------------+---------------+------------------------------------------------------+------------------------------------------------------------------------------------------------------------+
+
+
+Regions, Locations and Cache Groups
+===================================
+All servers have to have a `location`, which is their physical location. Each location is part of a `region`, and each region is part of a `division`. For Example, ``Denver`` could be a location in the ``Mile High`` region and that region could be part of the ``West`` division. Enter your divisions first in `Misc->Divisions`, then enter the regions in `Misc->Regions`, referencing the divisions entered, and finally, enter the physical locations in `Misc->Locations`, referencing the regions entered.
+
+All servers also have to be part of a `cache group`. A cache group is a logical grouping of caches, that don't have to be in the same physical location (in fact, usually a cache group is spread across minimally 2 physical Locations for redundancy purposes), but share geo coordinates for content routing purposes. JvD to add more.
+
+
+
+Configuring Content Purge
+=========================
+Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the `Regex Revalidate Plugin <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html>`_ to purge content from the system. We don't actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it's config file, and will pick up changes to it without a `traffic_line -x` signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the lower tiers with the content that should be purged from the highe
r tiers without hitting the origin. This is why the ort script (see :ref:`reference-traffic-ops-ort`) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the `regex_revalidate.config` file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the `regex_revalidate.config` file.
+
+Content Purge is controlled by the following parameters in the profile of the cache:
+
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Config file | Description | Details |
++======================+=========================+==================================================+=========================================================================================================================================================+
+| location | regex_revalidate.config | What location the file should be in on the cache | The presence of this parameter tells ort to distribute this file; delete this parameter from the profile if this file is distributed using other means. |
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+| maxRevalDurationDays | regex_revalidate.config | The maximum time a purge can be active | To prevent a build up of many checks before each request, this is longest time the system will allow |
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+| regex_revalidate | plugin.config | The config to be used for regex_revalidate. | `regex_revalidate <https://docs.trafficserver.apache.org/en/5.3.x/reference/plugins/regex_remap.en.html>`_ |
+| | | For example: --config regex_revalidate.config | |
++----------------------+-------------------------+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+Note that the TTL the adminstrator enters in the purge request should be longer than the TTL of the content to ensure the bad content will not be used. If the CDN is serving content of unknown, or unlimited TTL, the administrator should consider using `proxy-config-http-cache-guaranteed-min-lifetime <https://docs.trafficserver.apache.org/en/latest/admin-guide/files/records.config.en.html#proxy-config-http-cache-guaranteed-min-lifetime>`_ to limit the maximum time an object can be in the cache before it is considered stale, and set that to the same value as `maxRevalDurationDays` (Note that the former is in seconds and the latter is in days, so convert appropriately).
+
+
+
+.. _Creating-CentOS-Kickstart:
+
+Creating the CentOS Kickstart File
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+The kickstart file is a text file, containing a list of items, each identified by a keyword. You can create it by using the Kickstart Configurator application, or writing it from scratch. The Red Hat Enterprise Linux installation program also creates a sample kickstart file based on the options that you selected during installation. It is written to the file ``/root/anaconda-ks.cfg``. This file is editable using most text editors that can save files as ASCII text.
+
+To generate ISO, the CentOS Kickstart is necessary:
+
+1. Create a kickstart file.
+2. Create a boot media with the kickstart file or make the kickstart file available on the network.
+3. Make the installation tree available.
+4. Start the kickstart installation.
+
+Create a ks.src file in the root of the selection location. See the example below:
+
+::
+
+
+ mkdir newdir
+ cd newdir/
+ cp -r ../centos65/* .
+ vim ks.src
+ vim isolinux/isolinux.cfg
+ cd vim osversions.cfg
+ vim osversions.cfg
+
+
+This is a standard kickstart formatted file that the generate ISO process uses to create the kickstart (ks.cfg) file for the install. The generate ISO process uses the ks.src, overwriting any information set in the Generate ISO tab in Traffic Ops, creating ks.cfg.
+
+.. Note:: Streamline your install folder for under 1GB, which assists in creating a CD.
+
+.. seealso:: For in-depth instructions, please see `Kickstart Installation <https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Linux/6/html/Installation_Guide/s1-kickstart2-howuse.html>`_
+
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_ops_extensions.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_extensions.rst.txt b/docs/latest/_sources/admin/traffic_ops_extensions.rst.txt
deleted file mode 100644
index 4aceebb..0000000
--- a/docs/latest/_sources/admin/traffic_ops_extensions.rst.txt
+++ /dev/null
@@ -1,88 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _admin-to-ext-script:
-
-Managing Traffic Ops Extensions
-*******************************
-
-Each script is a separate bash script located in ``$TO_HOME/bin/checks/``.
-
-The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running ``/opt/traffic_ops/app/bin/extensions -a``.
-
-The below extensions are automatically registered with the Traffic Ops database (``to_extension`` table) at install time (see ``traffic_ops/app/db/seeds.sql``). However, cron must still be configured to run these checks periodically.
-
-The scripts are called as follows: ::
-
-
- $TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
- where:
-
- <name> is the type of check script
- <traffic_ops_ip> is the IP address of the Traffic Ops Server
- <check_name> is the name of the check. For example: CDU, CHR, DSCP, MTU, etc...
- <log_level> is between 1 and 4, with 4 being the most verbose. This field is optional
-
-
-Example Cron File
-=================
-Edit with ``crontab -e``. You may need to adjust the path to your $TO_HOME to match your system.
-
-::
-
-
- PERL5LIB=/opt/traffic_ops/app/local/lib/perl5:/opt/traffic_ops/app/lib
-
- # IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.
- */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": [\"hostName\",\"domainName\"]}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
- */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
- */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"name\": \"IPv4 Ping\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
- # IPv6 ping examples
- */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"name\": \"IPv6 Ping\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
- */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-
- # iLO ping
- 18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"select\": \"iloIpAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
- 18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"name\": \"ILO ping\", \"select\": \"iloIpAddress\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
-
- # MTU ping
- 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
- 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
- 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
- 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
- # FQDN
- 27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\"" >> /var/log/traffic_ops/extensionCheck.log 2>&1
- 27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\", \"name\": \"DNS Lookup\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
- # DSCP
- 36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"cms_interface\": \"eth0\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
- 36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"name\": \"Delivery Service\", \"cms_interface\": \"eth0\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
- # RTR
- 10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
- 10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\", \"name\": \"Content Router Check\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
- # CHR
- */15 * * * * root /opt/traffic_ops/app/bin/checks/ToCHRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CHR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-
- # CDU
- 20 * * * * root /opt/traffic_ops/app/bin/checks/ToCDUCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CDU\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-
- # ORT
- 40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
- 40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\", \"name\": \"Operational Readiness Test\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_ops_extensions.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_extensions.txt b/docs/latest/_sources/admin/traffic_ops_extensions.txt
new file mode 100644
index 0000000..4aceebb
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops_extensions.txt
@@ -0,0 +1,88 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _admin-to-ext-script:
+
+Managing Traffic Ops Extensions
+*******************************
+
+Each script is a separate bash script located in ``$TO_HOME/bin/checks/``.
+
+The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running ``/opt/traffic_ops/app/bin/extensions -a``.
+
+The below extensions are automatically registered with the Traffic Ops database (``to_extension`` table) at install time (see ``traffic_ops/app/db/seeds.sql``). However, cron must still be configured to run these checks periodically.
+
+The scripts are called as follows: ::
+
+
+ $TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
+ where:
+
+ <name> is the type of check script
+ <traffic_ops_ip> is the IP address of the Traffic Ops Server
+ <check_name> is the name of the check. For example: CDU, CHR, DSCP, MTU, etc...
+ <log_level> is between 1 and 4, with 4 being the most verbose. This field is optional
+
+
+Example Cron File
+=================
+Edit with ``crontab -e``. You may need to adjust the path to your $TO_HOME to match your system.
+
+::
+
+
+ PERL5LIB=/opt/traffic_ops/app/local/lib/perl5:/opt/traffic_ops/app/lib
+
+ # IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": [\"hostName\",\"domainName\"]}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"name\": \"IPv4 Ping\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # IPv6 ping examples
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"name\": \"IPv6 Ping\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+
+ # iLO ping
+ 18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"select\": \"iloIpAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"name\": \"ILO ping\", \"select\": \"iloIpAddress\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
+
+ # MTU ping
+ 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+ 45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # FQDN
+ 27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\"" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\", \"name\": \"DNS Lookup\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # DSCP
+ 36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"cms_interface\": \"eth0\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"name\": \"Delivery Service\", \"cms_interface\": \"eth0\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # RTR
+ 10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\", \"name\": \"Content Router Check\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
+ # CHR
+ */15 * * * * root /opt/traffic_ops/app/bin/checks/ToCHRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CHR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+
+ # CDU
+ 20 * * * * root /opt/traffic_ops/app/bin/checks/ToCDUCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CDU\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+
+ # ORT
+ 40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+ 40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\", \"name\": \"Operational Readiness Test\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+
[21/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/user.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/user.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/user.rst.txt
deleted file mode 100644
index bbe0278..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/user.rst.txt
+++ /dev/null
@@ -1,784 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-users:
-
-Users
-=====
-
-.. _to-api-v12-users-route:
-
-/api/1.2/users
-++++++++++++++
-
-**GET /api/1.2/users**
-
- Retrieves all users.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | hash | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``publicSshKey`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``registrationSent`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``roleName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "addressLine1": "",
- "addressLine2": "",
- "city": "",
- "company": "",
- "country": "",
- "email": "email1@email.com",
- "fullName": "Tom Simpson",
- "gid": "0",
- "id": "53",
- "lastUpdated": "2016-01-26 10:22:07",
- "newUser": true,
- "phoneNumber": "",
- "postalCode": "",
- "publicSshKey": "xxx",
- "registrationSent": true,
- "role": "6",
- "rolename": "admin",
- "stateOrProvince": "",
- "uid": "0",
- "username": "tsimpson"
- },
- {
- ... more users
- },
- ]
- }
-
-|
-
-
-**GET /api/1.2/users/:id**
-
- Retrieves user by ID.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | User id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | hash | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``publicSshKey`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``registrationSent`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``roleName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "addressLine1": "",
- "addressLine2": "",
- "city": "",
- "company": "",
- "country": "",
- "email": "email1@email.com",
- "fullName": "Tom Simpson",
- "gid": "0",
- "id": "53",
- "lastUpdated": "2016-01-26 10:22:07",
- "newUser": true,
- "phoneNumber": "",
- "postalCode": "",
- "publicSshKey": "xxx",
- "registrationSent": true,
- "role": "6",
- "rolename": "admin",
- "stateOrProvince": "",
- "uid": "0",
- "username": "tsimpson"
- },
- {
- ... more users
- },
- ]
- }
-
-|
-
-
-**GET /api/1.2/user/current.json**
-
- Retrieves the profile for the authenticated user.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+---------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+=========+================================================+
- |``email`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``localUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``newUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine1`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+---------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "email": "email@email.com",
- "city": "",
- "id": "50",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "Tom Callahan",
- "localUser": true,
- "uid": "0",
- "stateOrProvince": "",
- "username": "tommyboy",
- "newUser": false,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "gid": "0",
- "postalCode": ""
- },
- }
-
-|
-
-**POST /api/1.2/user/current/update**
-
- Updates the date for the authenticated user.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+---------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+=========+================================================+
- |``email`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``localUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``newUser`` | boolean | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``addressLine1`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+---------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+---------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "user": {
- "email": "",
- "city": "",
- "id": "",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "",
- "localUser": true,
- "uid": "0",
- "stateOrProvince": "",
- "username": "tommyboy",
- "newUser": false,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "gid": "0",
- "postalCode": ""
- }
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "UserProfile was successfully updated."
- }
- ],
- }
-
-|
-
-**GET /api/1.2/user/current/jobs.json**
-
- Retrieves the user's list of jobs.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +--------------+----------+----------------------------------------+
- | Name | Required | Description |
- +==============+==========+========================================+
- | ``keyword`` | no | PURGE |
- +--------------+----------+----------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``keyword`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``objectName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``assetUrl`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``assetType`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``status`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``dsId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``dsXmlId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``parameters`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``enteredTime`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``objectType`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``agent`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``startTime`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``version`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example**
- ::
-
- {
- "response": [
- {
- "id": "1",
- "keyword": "PURGE",
- "objectName": null,
- "assetUrl": "",
- "assetType": "file",
- "status": "PENDING",
- "dsId": "9999",
- "dsXmlId": "ds-xml-id",
- "username": "peewee",
- "parameters": "TTL:56h",
- "enteredTime": "2015-01-21 18:00:16",
- "objectType": null,
- "agent": "",
- "startTime": "2015-01-21 10:45:38"
- }
- ],
- }
-
-|
-
-**POST/api/1.2/user/current/jobs**
-
-Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
-
-.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
-
-Authentication Required: Yes
-
-Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``dsId`` | string | Unique Delivery Service ID |
- +----------------------+--------+------------------------------------------------+
- |``regex`` | string | Path Regex this should be a |
- | | | `PCRE <http://www.pcre.org/>`_ compatible |
- | | | regular expression for the path to match for |
- | | | forcing the revalidation. Be careful to only |
- | | | match on the content you need to remove - |
- | | | revalidation is an expensive operation for |
- | | | many origins, and a simple ``/.*`` can cause |
- | | | an overload condition of the origin. |
- +----------------------+--------+------------------------------------------------+
- |``startTime`` | string | Start Time is the time when the revalidation |
- | | | rule will be made active. Populate |
- | | | with the current time to schedule ASAP. This |
- | | | value cannot be more than 2 days before now. |
- +----------------------+--------+------------------------------------------------+
- |``ttl`` | int | Time To Live is how long the revalidation rule |
- | | | will be active for in hours. It usually makes |
- | | | sense to make this the same as the |
- | | | ``Cache-Control`` header from the origin which |
- | | | sets the object time to live in cache |
- | | | (by ``max-age`` or ``Expires``). Entering a |
- | | | longer TTL here will make the caches do |
- | | | unnecessary work. |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "dsId": "9999",
- "regex": "/path/to/content.jpg",
- "startTime": "2015-01-27 11:08:37",
- "ttl": 54
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts":
- [
- {
- "level": "success",
- "text": "Successfully created purge job for: ."
- }
- ],
- }
-
-
-|
-
-**POST /api/1.2/user/login**
-
- Authentication of a user using username and password. Traffic Ops will send back a session cookie.
-
- Authentication Required: No
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``u`` | string | username |
- +----------------------+--------+------------------------------------------------+
- |``p`` | string | password |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "u": "username",
- "p": "password"
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Successfully logged in."
- }
- ],
- }
-
-|
-
-**GET /api/1.2/user/:id/deliveryservices/available.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- |id | yes | |
- +-----------------+----------+---------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``xmlId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
-
- {
- "response": [
- {
- "xmlId": "ns-img",
- "id": "90"
- },
- {
- "xmlId": "ns-img-secure",
- "id": "280"
- }
- ],
- }
-
-|
-
-**POST /api/1.2/user/login/token**
-
- Authentication of a user using a token.
-
- Authentication Required: No
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``t`` | string | token-value |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "t": "token-value"
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+-------------+
- | Parameter | Type | Description |
- +=============+========+=============+
- | ``alerts`` | array | |
- +-------------+--------+-------------+
- | ``>level`` | string | |
- +-------------+--------+-------------+
- | ``>text`` | string | |
- +-------------+--------+-------------+
- | ``version`` | string | |
- +-------------+--------+-------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "error",
- "text": "Unauthorized, please log in."
- }
- ],
- }
-
-
-|
-
-
-**POST /api/1.2/user/logout**
-
- User logout. Invalidates the session cookie.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``alerts`` | array | |
- +----------------------+--------+------------------------------------------------+
- |* ``level`` | string | |
- +----------------------+--------+------------------------------------------------+
- |* ``text`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``version`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example**
- ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "You are logged out."
- }
- ],
- }
-
-
-|
-
-**POST /api/1.2/user/reset_password**
-
- Reset user password.
-
- Authentication Required: No
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``email`` | string | The email address of the user to initiate |
- | | | password reset. |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example**
- ::
-
- {
- "email": "email@email.com"
- }
-
-|
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``alerts`` | array | A collection of alert messages. |
- +----------------------+--------+------------------------------------------------+
- |* ``level`` | string | Success, info, warning or error. |
- +----------------------+--------+------------------------------------------------+
- |* ``text`` | string | Alert message. |
- +----------------------+--------+------------------------------------------------+
- |``version`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Successfully sent password reset to email 'email@email.com'"
- }
- ],
- }
-
-|
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/user.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/user.txt b/docs/latest/_sources/development/traffic_ops_api/v12/user.txt
new file mode 100644
index 0000000..bbe0278
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/user.txt
@@ -0,0 +1,784 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-users:
+
+Users
+=====
+
+.. _to-api-v12-users-route:
+
+/api/1.2/users
+++++++++++++++
+
+**GET /api/1.2/users**
+
+ Retrieves all users.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/users/:id**
+
+ Retrieves user by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | User id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/user/current.json**
+
+ Retrieves the profile for the authenticated user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+=========+================================================+
+ |``email`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``localUser`` | boolean | |
+ +----------------------+---------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``newUser`` | boolean | |
+ +----------------------+---------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``addressLine1`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+---------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "email": "email@email.com",
+ "city": "",
+ "id": "50",
+ "phoneNumber": "",
+ "company": "",
+ "country": "",
+ "fullName": "Tom Callahan",
+ "localUser": true,
+ "uid": "0",
+ "stateOrProvince": "",
+ "username": "tommyboy",
+ "newUser": false,
+ "addressLine2": "",
+ "role": "6",
+ "addressLine1": "",
+ "gid": "0",
+ "postalCode": ""
+ },
+ }
+
+|
+
+**POST /api/1.2/user/current/update**
+
+ Updates the date for the authenticated user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+=========+================================================+
+ |``email`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``localUser`` | boolean | |
+ +----------------------+---------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``newUser`` | boolean | |
+ +----------------------+---------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``addressLine1`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+---------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+---------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "user": {
+ "email": "",
+ "city": "",
+ "id": "",
+ "phoneNumber": "",
+ "company": "",
+ "country": "",
+ "fullName": "",
+ "localUser": true,
+ "uid": "0",
+ "stateOrProvince": "",
+ "username": "tommyboy",
+ "newUser": false,
+ "addressLine2": "",
+ "role": "6",
+ "addressLine1": "",
+ "gid": "0",
+ "postalCode": ""
+ }
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "UserProfile was successfully updated."
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/user/current/jobs.json**
+
+ Retrieves the user's list of jobs.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+========================================+
+ | ``keyword`` | no | PURGE |
+ +--------------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``keyword`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``objectName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``assetUrl`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``assetType`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``status`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``dsId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``dsXmlId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``parameters`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``enteredTime`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``objectType`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``agent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``startTime`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "response": [
+ {
+ "id": "1",
+ "keyword": "PURGE",
+ "objectName": null,
+ "assetUrl": "",
+ "assetType": "file",
+ "status": "PENDING",
+ "dsId": "9999",
+ "dsXmlId": "ds-xml-id",
+ "username": "peewee",
+ "parameters": "TTL:56h",
+ "enteredTime": "2015-01-21 18:00:16",
+ "objectType": null,
+ "agent": "",
+ "startTime": "2015-01-21 10:45:38"
+ }
+ ],
+ }
+
+|
+
+**POST/api/1.2/user/current/jobs**
+
+Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
+
+.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.2 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``dsId`` | string | Unique Delivery Service ID |
+ +----------------------+--------+------------------------------------------------+
+ |``regex`` | string | Path Regex this should be a |
+ | | | `PCRE <http://www.pcre.org/>`_ compatible |
+ | | | regular expression for the path to match for |
+ | | | forcing the revalidation. Be careful to only |
+ | | | match on the content you need to remove - |
+ | | | revalidation is an expensive operation for |
+ | | | many origins, and a simple ``/.*`` can cause |
+ | | | an overload condition of the origin. |
+ +----------------------+--------+------------------------------------------------+
+ |``startTime`` | string | Start Time is the time when the revalidation |
+ | | | rule will be made active. Populate |
+ | | | with the current time to schedule ASAP. This |
+ | | | value cannot be more than 2 days before now. |
+ +----------------------+--------+------------------------------------------------+
+ |``ttl`` | int | Time To Live is how long the revalidation rule |
+ | | | will be active for in hours. It usually makes |
+ | | | sense to make this the same as the |
+ | | | ``Cache-Control`` header from the origin which |
+ | | | sets the object time to live in cache |
+ | | | (by ``max-age`` or ``Expires``). Entering a |
+ | | | longer TTL here will make the caches do |
+ | | | unnecessary work. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "dsId": "9999",
+ "regex": "/path/to/content.jpg",
+ "startTime": "2015-01-27 11:08:37",
+ "ttl": 54
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Successfully created purge job for: ."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.2/user/login**
+
+ Authentication of a user using username and password. Traffic Ops will send back a session cookie.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``u`` | string | username |
+ +----------------------+--------+------------------------------------------------+
+ |``p`` | string | password |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "u": "username",
+ "p": "password"
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Successfully logged in."
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/user/:id/deliveryservices/available.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``xmlId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+
+ {
+ "response": [
+ {
+ "xmlId": "ns-img",
+ "id": "90"
+ },
+ {
+ "xmlId": "ns-img-secure",
+ "id": "280"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/user/login/token**
+
+ Authentication of a user using a token.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``t`` | string | token-value |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "t": "token-value"
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=============+========+=============+
+ | ``alerts`` | array | |
+ +-------------+--------+-------------+
+ | ``>level`` | string | |
+ +-------------+--------+-------------+
+ | ``>text`` | string | |
+ +-------------+--------+-------------+
+ | ``version`` | string | |
+ +-------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Unauthorized, please log in."
+ }
+ ],
+ }
+
+
+|
+
+
+**POST /api/1.2/user/logout**
+
+ User logout. Invalidates the session cookie.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``alerts`` | array | |
+ +----------------------+--------+------------------------------------------------+
+ |* ``level`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |* ``text`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "You are logged out."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.2/user/reset_password**
+
+ Reset user password.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``email`` | string | The email address of the user to initiate |
+ | | | password reset. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example**
+ ::
+
+ {
+ "email": "email@email.com"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``alerts`` | array | A collection of alert messages. |
+ +----------------------+--------+------------------------------------------------+
+ |* ``level`` | string | Success, info, warning or error. |
+ +----------------------+--------+------------------------------------------------+
+ |* ``text`` | string | Alert message. |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Successfully sent password reset to email 'email@email.com'"
+ }
+ ],
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_portal.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_portal.rst.txt b/docs/latest/_sources/development/traffic_portal.rst.txt
deleted file mode 100644
index 7135bc7..0000000
--- a/docs/latest/_sources/development/traffic_portal.rst.txt
+++ /dev/null
@@ -1,54 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Traffic Portal
-*************
-
-Introduction
-============
-Traffic Portal is an `AngularJS 1.x <https://angularjs.org/>`_ client served from a `Node.js <https://nodejs.org/en/>`_ web server designed to consume the Traffic Ops 1.x API. Traffic Portal provides a set of functionality restricted to the delivery service(s) of the authenticated user. Functionality primarily includes a set of charts / graphs designed to provide insight into the performance of a user's delivery service(s).
-
-Software Requirements
-=====================
-To work on Traffic Portal you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
-
- * `Ruby 2.0.x or above <https://www.ruby-lang.org/en/>`_
- * `Compass 1.0.x or above <http://compass-style.org/>`_
- * `Node.js 6.0.x or above <https://nodejs.org/en/>`_
- * `Bower 1.7.9 or above <https://nodejs.org/en/>`_
- * `Grunt CLI 1.2.0 or above <https://github.com/gruntjs/grunt-cli>`_
- * Access to a working instance of Traffic Ops
-
-Traffic Portal Project Tree Overview
-=====================================
- * **traffic_control/traffic_portal/app/src** - contains HTML, JavaScript and Sass source files.
-
-Installing The Traffic Portal Developer Environment
-===================================================
-
- - Clone the traffic_control repository
- - Navigate to the traffic_control/traffic_portal of your cloned repository.
- - Run ``npm install`` to install application dependencies. Only needs to be done the first time unless traffic_portal/package.json changes.
- - Run ``bower install`` to install client-side dependencies. Only needs to be done the first time unless traffic_portal/bower.json changes.
- - Run ``grunt`` to package the application into traffic_portal/app/dist, start a local http server (Express), and start a file watcher.
- - Navigate to http://localhost:8080
-
-Notes
-=====
-
-- The Traffic Portal consumes the Traffic Ops API. By default, Traffic Portal assumes Traffic Ops is running on http://localhost:3000. Temporarily modify conf/config.js if you need to change the location of Traffic Ops.
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_portal.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_portal.txt b/docs/latest/_sources/development/traffic_portal.txt
new file mode 100644
index 0000000..7135bc7
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_portal.txt
@@ -0,0 +1,54 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Traffic Portal
+*************
+
+Introduction
+============
+Traffic Portal is an `AngularJS 1.x <https://angularjs.org/>`_ client served from a `Node.js <https://nodejs.org/en/>`_ web server designed to consume the Traffic Ops 1.x API. Traffic Portal provides a set of functionality restricted to the delivery service(s) of the authenticated user. Functionality primarily includes a set of charts / graphs designed to provide insight into the performance of a user's delivery service(s).
+
+Software Requirements
+=====================
+To work on Traffic Portal you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+ * `Ruby 2.0.x or above <https://www.ruby-lang.org/en/>`_
+ * `Compass 1.0.x or above <http://compass-style.org/>`_
+ * `Node.js 6.0.x or above <https://nodejs.org/en/>`_
+ * `Bower 1.7.9 or above <https://nodejs.org/en/>`_
+ * `Grunt CLI 1.2.0 or above <https://github.com/gruntjs/grunt-cli>`_
+ * Access to a working instance of Traffic Ops
+
+Traffic Portal Project Tree Overview
+=====================================
+ * **traffic_control/traffic_portal/app/src** - contains HTML, JavaScript and Sass source files.
+
+Installing The Traffic Portal Developer Environment
+===================================================
+
+ - Clone the traffic_control repository
+ - Navigate to the traffic_control/traffic_portal of your cloned repository.
+ - Run ``npm install`` to install application dependencies. Only needs to be done the first time unless traffic_portal/package.json changes.
+ - Run ``bower install`` to install client-side dependencies. Only needs to be done the first time unless traffic_portal/bower.json changes.
+ - Run ``grunt`` to package the application into traffic_portal/app/dist, start a local http server (Express), and start a file watcher.
+ - Navigate to http://localhost:8080
+
+Notes
+=====
+
+- The Traffic Portal consumes the Traffic Ops API. By default, Traffic Portal assumes Traffic Ops is running on http://localhost:3000. Temporarily modify conf/config.js if you need to change the location of Traffic Ops.
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_router.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_router.rst.txt b/docs/latest/_sources/development/traffic_router.rst.txt
deleted file mode 100644
index 6df7627..0000000
--- a/docs/latest/_sources/development/traffic_router.rst.txt
+++ /dev/null
@@ -1,143 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Traffic Router
-**************
-Introduction
-============
-Traffic Router is a Java Tomcat application that routes clients to the closest available cache on the CDN using both HTTP and DNS. Cache availability is determined by Traffic Monitor; consequently Traffic Router polls Traffic Monitor for its configuration and cache health state information, and uses this data to make routing decisions. HTTP routing is performed by localizing the client based on the request's source IP address (IPv4 or IPv6), and issues an HTTP 302 redirect to the nearest cache. HTTP routing utilizes consistent hashing on request URLs to optimize cache performance and request distribution. DNS routing is performed by localizing clients, resolvers in most cases, requesting ``A`` and ``AAAA`` records for a configurable name such as ``edge.deliveryservice.somecdn.net``. Traffic Router is comprised of four separate Maven modules:
-
- * api - Provides a simple JSON interface into certain aspects of core and is deployed as a WAR to a Service (read: connector/listen port) within Tomcat which is separate from core
- * connector - A JAR that overrides Tomcat's standard Http11Protocol Connector class and allows Traffic Router to delay opening listen sockets until it is in a state suitable for routing traffic
- * geolocation - Submodule for defining geolocation services
- * testServer - A convenience server for easier manual testing of the API portion of Traffic Router on a development machine
- * core - Services DNS and HTTP requests, performs localization on routing requests, and is deployed as a WAR to a Service (read: connector/listen port) within Tomcat which is separate from api
- * rpm - A simple Maven project which gathers the artifacts from the prior three modules and builds an RPM
-
-Software Requirements
-=====================
-To work on Traffic Router you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
-
-* Eclipse >= Kepler SR2 (or another Java IDE)
-* Maven >= 3.3.1
-* JDK >= 6.0
-
-Traffic Router Project Tree Overview
-=====================================
-* ``traffic_control/traffic_traffic_router/`` - base directory for Traffic Router
-
- * ``api/`` - Source code for Traffic Router API, which is built as its own deployable WAR file and communicates with Traffic Router Core using JMX
-
- * ``src/main`` - Main source directory for Traffic Router API
-
- * ``java/`` - Java source code for Traffic Router API
- * ``resources/`` - Spring resources pulled in during an RPM build
- * ``webapp/`` - Java webapp resources
-
- * ``src/test`` - Test source directory for Traffic Router API
-
- * ``java/`` - JUnit based unit tests for Traffic Router API
- * ``resources/`` - Resources pulled in by unit tests
-
- * ``connector/`` - Source code for Traffic Router Connector;
-
- * ``src/main/java`` - Java source directory for Traffic Router Connector
-
- * ``core/`` - Source code for Traffic Router Core, which is built as its own deployable WAR file and communicates with Traffic Router API using JMX
-
- * ``src/main`` - Main source directory for Traffic Router Core
-
- * ``etc/init.d`` - Init script for Tomcat
- * ``conf/`` - Minimum required configuration files
- * ``java/`` - Java source code for Traffic Router Core
- * ``opt/tomcat/conf`` - Contains Tomcat configuration file(s) pulled in during an RPM build
- * ``resources/`` - Resources pulled in during an RPM build
- * ``scripts/`` - Scripts used by the RPM build process
- * ``webapp/`` - Java webapp resources
-
- * ``src/test`` - Test source directory for Traffic Router Core
-
- * ``conf/`` - Minimal Configuration files that make it possible to run junit tests
- * ``db/`` - Files downloaded by unit tests
- * ``java/`` - JUnit based unit tests for Traffic Router Core
- * ``resources/`` - Example data files used by junit tests
-
- * ``var/auto-zones`` - BIND formatted zone files generated by Traffic Router Core during unit testing
-
-Java Formatting Conventions
-===========================
-None at this time. The codebase will eventually be formatted per Java standards.
-
-Installing The Developer Environment
-====================================
-To install the Traffic Router Developer environment:
-
-1. Clone the traffic_control repository using Git.
-2. Change directories into ``traffic_control/traffic_router``.
-3. Set the environment variable TRAFFIC_MONITOR_HOSTS to be a semicolon delimited list of Traffic Monitors that can be accessed during integration tests
-4. core/src/test/resources no longer exists
-5. core/src/test/conf contains a properties file for accessing Traffic Ops
-6. Default configuration values now reside in core/src/main/webapp/WEB-INF/applicationContext.xml
-7. The above values may be overridden by creating and/or modifying the property files listed in core/src/main/resources/applicationProperties.xml
-8. Pre-existing properties files are still honored by Traffic Router
-
-+-------------------------------------+------------------------------------------------------------------------------------------------------------------+
-| Parameter | Value |
-+=====================================+==================================================================================================================+
-| ``traffic_monitor.bootstrap.hosts`` | FQDN and port of the Traffic Monitor instance(s), separated by semicolons as necessary (do not include http://). |
-+-------------------------------------+------------------------------------------------------------------------------------------------------------------+
-
-4. Import the existing git repo into Eclipse:
-
- a. File -> Import -> Git -> Projects from Git; Next
- b. Existing local repository; Next
- c. Add -> browse to find ``traffic_control``; Open
- d. Select ``traffic_control``; Next
- e. Ensure "Import existing projects" is selected, expand ``traffic_control``, select ``traffic_router``; Next
- f. Ensure ``traffic_router_api``, ``traffic_router_connector``, and ``traffic_router_core`` are checked; Finish (this step can take several minutes to complete)
- g. Ensure ``traffic_router_api``, ``traffic_router_connector``, and ``traffic_router_core`` have been opened by Eclipse after importing
-
-5. From the terminal, run ``mvn clean verify`` from the ``traffic_router`` directory
-
-6. Start the embedded Jetty instance for Core from within Eclipse
-
- a. In the package explorer, expand ``traffic_router_core``
- b. Expand ``src/test/java``
- c. Expand the package ``com.comcast.cdn.traffic_control.traffic_router.core``
- d. Open and run ``TrafficRouterStart.java``
-
- .. Note:: If an error is displayed in the Console, run ``mvn clean verify`` from the ``traffic_router`` directory
-
-7. Traffic Router Core should now be running; the HTTP routing interface is available on http://localhost:8081, while the DNS server and routing interface is available on localhost:1053 via TCP and UDP.
-
-Test Cases
-==========
-* Unit tests can be executed using Maven by running ``mvn test`` at the root of the ``traffic_router`` project.
-* Unit and Integration tests can be executed using Maven by running ``mvn verify`` at the root of the ``traffic_router`` project.
-
-RPM Packaging
-=============
-Running ``mvn package`` on a Linux based distribution will trigger the build process to create the Traffic Router rpm.
-
-API
-===
-
-:ref:`reference-tr-api`
-
-.. toctree::
- :hidden:
- :maxdepth: 1
-
- traffic_router/traffic_router_api
[38/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.txt b/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.txt
new file mode 100644
index 0000000..373c7ec
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.txt
@@ -0,0 +1,1276 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v11-ds:
+
+Delivery Service
+================
+
+.. _to-api-v11-ds-route:
+
+/api/1.1/deliveryservices
++++++++++++++++++++++++++
+
+**GET /api/1.1/deliveryservices**
+
+ Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/deliveryservices/:id**
+
+ Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ ]
+ }
+
+|
+
+
+.. _to-api-v11-ds-health:
+
+Health
+++++++
+
+**GET /api/1.1/deliveryservices/:id/state.json**
+
+ Retrieves the failover state for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+---------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+=================================================+
+ | ``failover`` | hash | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>locations`` | array | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>destination`` | string | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>configured`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>enabled`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+ | ``enabled`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "failover": {
+ "locations": [ ],
+ "destination": null,
+ "configured": false,
+ "enabled": false
+ },
+ "enabled": true
+ }
+ }
+
+|
+
+**GET /api/1.1/deliveryservices/:id/health.json**
+
+ Retrieves the health of all locations (cache groups) for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ }
+ }
+
+
+|
+
+**GET /api/1.1/deliveryservices/:id/capacity.json**
+
+ Retrieves the capacity percentages of a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +========================+========+===================================================+
+ | ``availablePercent`` | number | The percentage of server capacity assigned to |
+ | | | the delivery service that is available. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``unavailablePercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service that is unavailable. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``utilizedPercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service being used. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``maintenancePercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service that is down for maintenance. |
+ +------------------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "availablePercent": 89.0939840205533,
+ "unavailablePercent": 0,
+ "utilizedPercent": 10.9060020300395,
+ "maintenancePercent": 0.0000139494071146245
+ },
+ }
+
+
+|
+
+**GET /api/1.1/deliveryservices/:id/routing.json**
+
+ Retrieves the routing method percentages of a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+=============================================================================================================================+
+ | ``staticRoute`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``miss`` | number | The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP). |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``geo`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``err`` | number | The percentage of Traffic Router requests for this deliveryservice resulting in an error. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``cz`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF hit. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``dsr`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the |
+ | | | client to the overflow CDN. |
+ +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "staticRoute": 0,
+ "miss": 0,
+ "geo": 37.8855391018869,
+ "err": 0,
+ "cz": 62.1144608981131,
+ "dsr": 0
+ },
+ }
+
+|
+
+.. _to-api-v11-ds-metrics:
+
+Metrics
++++++++
+
+**GET /api/1.1/deliveryservices/:id/server_types/:type/metric_types/start_date/:start/end_date/:end.json**
+
+ Retrieves detailed and summary metrics for MIDs or EDGEs for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+=============================================================================+
+ | ``id`` | yes | The delivery service id. |
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | ``server_types`` | yes | EDGE or MID. |
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | ``metric_types`` | yes | One of the following: "kbps", "tps", "tps_2xx", "tps_3xx", "tps_4xx", |
+ | | | "tps_5xx". |
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | ``start_date`` | yes | UNIX time |
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | ``end_date`` | yes | UNIX time |
+ +------------------+----------+-----------------------------------------------------------------------------+
+
+ **Request Query Parameters**
+
+ +------------------+----------+-----------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+=============================================================================+
+ | ``stats`` | no | Flag used to return only summary metrics |
+ +------------------+----------+-----------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------+
+ | Parameter | Type | Description |
+ +======================+========+=============+
+ | ``stats`` | hash | |
+ +----------------------+--------+-------------+
+ | ``>>count`` | int | |
+ +----------------------+--------+-------------+
+ | ``>>98thPercentile`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>min`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>max`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>5thPercentile`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>95thPercentile`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>median`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>mean`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>stddev`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>sum`` | number | |
+ +----------------------+--------+-------------+
+ | ``data`` | array | |
+ +----------------------+--------+-------------+
+ | ``>>item`` | array | |
+ +----------------------+--------+-------------+
+ | ``>>time`` | number | |
+ +----------------------+--------+-------------+
+ | ``>>value`` | number | |
+ +----------------------+--------+-------------+
+ | ``label`` | string | |
+ +----------------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "stats": {
+ "count": 988,
+ "98thPercentile": 16589105.55958,
+ "min": 3185442.975,
+ "max": 17124754.257,
+ "5thPercentile": 3901253.95445,
+ "95thPercentile": 16013210.034,
+ "median": 8816895.576,
+ "mean": 8995846.31741194,
+ "stddev": 3941169.83683573,
+ "sum": 333296106.060112
+ },
+ "data": [
+ [
+ 1414303200000,
+ 12923518.466
+ ],
+ [
+ 1414303500000,
+ 12625139.65
+ ]
+ ],
+ "label": "MID Kbps"
+ }
+ ],
+ }
+
+
+.. _to-api-v11-ds-server:
+
+Server
+++++++
+
+**GET /api/1.1/deliveryserviceserver.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: Yes
+
+ **Request Query Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``page`` | no | The page number for use in pagination. |
+ +-----------+----------+----------------------------------------+
+ | ``limit`` | no | For use in limiting the result set. |
+ +-----------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``lastUpdated`` | array | |
+ +----------------------+--------+------------------------------------------------+
+ |``server`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``deliveryService`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "page": 2,
+ "orderby": "deliveryservice",
+ "response": [
+ {
+ "lastUpdated": "2014-09-26 17:53:43",
+ "server": "20",
+ "deliveryService": "1"
+ },
+ {
+ "lastUpdated": "2014-09-26 17:53:44",
+ "server": "21",
+ "deliveryService": "1"
+ },
+ ],
+ "limit": 2
+ }
+
+|
+
+.. _to-api-v11-ds-sslkeys:
+
+SSL Keys
++++++++++
+
+**GET /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "certificate": {
+ "crt": "crt",
+ "key": "key",
+ "csr": "csr"
+ },
+ "businessUnit": "CDN_Eng",
+ "city": "Denver",
+ "organization": "KableTown",
+ "hostname": "foober.com",
+ "country": "US",
+ "state": "Colorado",
+ "version": "1"
+ }
+ }
+
+|
+
+**GET /api/1.1/deliveryservices/hostname/:hostname/sslkeys.json**
+
+ Authentication Required: Yes
+
+ Role Required: Admin
+
+ **Request Route Parameters**
+
+ +--------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+===================================================+
+ | ``hostname`` | yes | pristine hostname of the desired delivery service |
+ +--------------+----------+---------------------------------------------------+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "certificate": {
+ "crt": "crt",
+ "key": "key",
+ "csr": "csr"
+ },
+ "businessUnit": "CDN_Eng",
+ "city": "Denver",
+ "organization": "KableTown",
+ "hostname": "foober.com",
+ "country": "US",
+ "state": "Colorado",
+ "version": "1"
+ }
+ }
+
+|
+
+**GET /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys/delete.json**
+
+ Authentication Required: Yes
+
+ Role Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +--------------+--------+------------------+
+ | Parameter | Type | Description |
+ +==============+========+==================+
+ | ``response`` | string | success response |
+ +--------------+--------+------------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully deleted ssl keys for <xml_id>"
+ }
+
+|
+
+**POST /api/1.1/deliveryservices/sslkeys/generate**
+
+ Generates SSL crt, csr, and private key for a delivery service
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Properties**
+
+ +--------------+---------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============+=========+=================================================+
+ | ``key`` | string | xml_id of the delivery service |
+ +--------------+---------+-------------------------------------------------+
+ | ``version`` | string | version of the keys being generated |
+ +--------------+---------+-------------------------------------------------+
+ | ``hostname`` | string | the *pristine hostname* of the delivery service |
+ +--------------+---------+-------------------------------------------------+
+ | ``country`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``state`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``city`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``org`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``unit`` | boolean | |
+ +--------------+---------+-------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "ds-01",
+ "businessUnit": "CDN Engineering",
+ "version": "3",
+ "hostname": "tr.ds-01.ott.kabletown.com",
+ "certificate": {
+ "key": "some_key",
+ "csr": "some_csr",
+ "crt": "some_crt"
+ },
+ "country": "US",
+ "organization": "Kabletown",
+ "city": "Denver",
+ "state": "Colorado"
+ }
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully created ssl keys for ds-01"
+ }
+
+|
+
+**POST /api/1.1/deliveryservices/sslkeys/add**
+
+ Allows user to add SSL crt, csr, and private key for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Properties**
+
+ +-------------+--------+-------------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+=====================================+
+ | ``key`` | string | xml_id of the delivery service |
+ +-------------+--------+-------------------------------------+
+ | ``version`` | string | version of the keys being generated |
+ +-------------+--------+-------------------------------------+
+ | ``csr`` | string | |
+ +-------------+--------+-------------------------------------+
+ | ``crt`` | string | |
+ +-------------+--------+-------------------------------------+
+ | ``key`` | string | |
+ +-------------+--------+-------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "ds-01",
+ "version": "1",
+ "certificate": {
+ "key": "some_key",
+ "csr": "some_csr",
+ "crt": "some_crt"
+ }
+ }
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully added ssl keys for ds-01"
+ }
+
+
+|
+
+**POST /api/1.1/deliveryservices/request**
+
+ Allows a user to send delivery service request details to a specified email address.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | Parameter | Type | Required | Description |
+ +========================================+========+==========+=============================================================================================+
+ | ``emailTo`` | string | yes | The email to which the delivery service request will be sent. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``details`` | hash | yes | Parameters for the delivery service request. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>customer`` | string | yes | Name of the customer to associated with the delivery service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>deliveryProtocol`` | string | yes | Eg. http or http/https
<TRUNCATED>
[35/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/server.txt b/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
new file mode 100644
index 0000000..44f1292
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/server.txt
@@ -0,0 +1,630 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-server:
+
+Server
+======
+
+.. _to-api-v11-servers-route:
+
+/api/1.1/servers
+++++++++++++++++
+
+**GET /api/1.1/servers**
+
+ Retrieves properties of CDN servers.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Server id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/servers/summary**
+
+ Retrieves a count of CDN servers by type.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------+--------+------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===========+========+========================================================================+
+ | ``count`` | int | The number of servers of this type in this instance of Traffic Ops. |
+ +-----------+--------+------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of the server count (see :ref:`to-api-v11-type`). |
+ +-----------+--------+------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "count": 4,
+ "type": "CCR"
+ },
+ {
+ "count": 55,
+ "type": "EDGE"
+ },
+ {
+ "type": "MID",
+ "count": 18
+ },
+ {
+ "count": 0,
+ "type": "INFLUXDB"
+ },
+ {
+ "count": 4,
+ "type": "RASCAL"
+ }
+ }
+
+|
+
+**GET /api/1.1/servers/hostname/:name/details**
+
+ Retrieves the details of a server.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+----------------------------------+
+ | Name | Required | Description |
+ +==========+==========+==================================+
+ | ``name`` | yes | The host name part of the cache. |
+ +----------+----------+----------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservices`` | array | Array of strings with the delivery service ids assigned (see :ref:`to-api-v11-ds`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``hardwareInfo`` | hash | Hwinfo struct (see :ref:`to-api-v11-hwinfo`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time/Date of the last update for this server. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``xmppId`` | string | Deprecated. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``xmppPasswd`` | string | Deprecated. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroup": "us-il-chicago",
+ "deliveryservices": [
+ "1",
+ "2",
+ "3",
+ "4"
+ ],
+ "domainName": "chi.kabletown.net",
+ "hardwareInfo": {
+ "Physical Disk 0:1:3": "D1S2",
+ "Physical Disk 0:1:2": "D1S2",
+ "Physical Disk 0:1:15": "D1S2",
+ "Power Supply.Slot.2": "04.07.15",
+ "Physical Disk 0:1:24": "YS08",
+ "Physical Disk 0:1:1": "D1S2",
+ "Model": "PowerEdge R720xd",
+ "Physical Disk 0:1:22": "D1S2",
+ "Physical Disk 0:1:18": "D1S2",
+ "Enterprise UEFI Diagnostics": "4217A5",
+ "Lifecycle Controller": "1.0.8.42",
+ "Physical Disk 0:1:8": "D1S2",
+ "Manufacturer": "Dell Inc.",
+ "Physical Disk 0:1:6": "D1S2",
+ "SysMemTotalSize": "196608",
+ "PopulatedDIMMSlots": "24",
+ "Physical Disk 0:1:20": "D1S2",
+ "Intel(R) Ethernet 10G 2P X520 Adapter": "13.5.7",
+ "Physical Disk 0:1:14": "D1S2",
+ "BACKPLANE FIRMWARE": "1.00",
+ "Dell OS Drivers Pack, 7.0.0.29, A00": "7.0.0.29",
+ "Integrated Dell Remote Access Controller": "1.57.57",
+ "Physical Disk 0:1:5": "D1S2",
+ "ServiceTag": "D6XPDV1",
+ "PowerState": "2",
+ "Physical Disk 0:1:23": "D1S2",
+ "Physical Disk 0:1:25": "D903",
+ "BIOS": "1.3.6",
+ "Physical Disk 0:1:12": "D1S2",
+ "System CPLD": "1.0.3",
+ "Physical Disk 0:1:4": "D1S2",
+ "Physical Disk 0:1:0": "D1S2",
+ "Power Supply.Slot.1": "04.07.15",
+ "PERC H710P Mini": "21.0.2-0001",
+ "PowerCap": "689",
+ "Physical Disk 0:1:16": "D1S2",
+ "Physical Disk 0:1:10": "D1S2",
+ "Physical Disk 0:1:11": "D1S2",
+ "Lifecycle Controller 2": "1.0.8.42",
+ "BP12G+EXP 0:1": "1.07",
+ "Physical Disk 0:1:9": "D1S2",
+ "Physical Disk 0:1:17": "D1S2",
+ "Broadcom Gigabit Ethernet BCM5720": "7.2.20",
+ "Physical Disk 0:1:21": "D1S2",
+ "Physical Disk 0:1:13": "D1S2",
+ "Physical Disk 0:1:7": "D1S2",
+ "Physical Disk 0:1:19": "D1S2"
+ },
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "physLocation": "plocation-chi-1",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "xmppId": "atsec-chi-00-dummyxmpp",
+ "xmppPasswd": "X"
+
+ }
+ }
+
+|
+
+**POST /api/1.1/servercheck**
+
+ Post a server check result to the serverchecks table.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------------------+----------+-------------+
+ | Name | Required | Description |
+ +============================+==========+=============+
+ | ``id`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``host_name`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``servercheck_short_name`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``value`` | yes | |
+ +----------------------------+----------+-------------+
+
+ **Request Example** ::
+
+ {
+ "id": "",
+ "host_name": "",
+ "servercheck_short_name": "",
+ "value": ""
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+
+ Response Example:
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Server Check was successfully updated."
+ }
+ ],
+ }
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.rst.txt
deleted file mode 100644
index c9d3a3d..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.rst.txt
+++ /dev/null
@@ -1,63 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-dns:
-
-Static DNS Entries
-==================
-
-.. _to-api-v11-static-dns-route:
-
-/api/1.1/staticdnsentries
-+++++++++++++++++++++++++
-
-**GET /api/1.1/staticdnsentries.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +---------------------+-----------+------------------------------------------------------------+
- | Parameter | Type | Description |
- +=====================+===========+============================================================+
- | ``deliveryservice`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``ttl`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``type`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``address`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``cachegroup`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``host`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "deliveryservice": "foo-ds",
- "ttl": "30",
- "type": "CNAME_RECORD",
- "address": "bar.foo.baz.tv.",
- "cachegroup": "us-co-denver",
- "host": "mm"
- }
- ]
- }
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.txt b/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.txt
new file mode 100644
index 0000000..c9d3a3d
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.txt
@@ -0,0 +1,63 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-dns:
+
+Static DNS Entries
+==================
+
+.. _to-api-v11-static-dns-route:
+
+/api/1.1/staticdnsentries
++++++++++++++++++++++++++
+
+**GET /api/1.1/staticdnsentries.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +---------------------+-----------+------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+===========+============================================================+
+ | ``deliveryservice`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``ttl`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``type`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``address`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``cachegroup`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``host`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "deliveryservice": "foo-ds",
+ "ttl": "30",
+ "type": "CNAME_RECORD",
+ "address": "bar.foo.baz.tv.",
+ "cachegroup": "us-co-denver",
+ "host": "mm"
+ }
+ ]
+ }
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/status.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/status.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/status.rst.txt
deleted file mode 100644
index 6a8c92a..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/status.rst.txt
+++ /dev/null
@@ -1,127 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-status:
-
-Status
-======
-
-.. _to-api-v11-statuses-route:
-
-/api/1.1/statuses
-+++++++++++++++++
-
-**GET /api/1.1/statuses**
-
- Retrieves a list of the server status codes available.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------+--------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+================================================================================+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``name`` | string | The string equivalent of the status |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``description`` | string | A short description of the status |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
- +-----------------+--------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "4",
- "name": "ADMIN_DOWN",
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "id": "5",
- "name": "CCR_IGNORE",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "id": "1",
- "name": "OFFLINE",
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "id": "2",
- "name": "ONLINE",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "id": "3",
- "name": "REPORTED",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
- "lastUpdated": "2013-02-13 16:34:29"
- }
- ]
- }
-
-**GET /api/1.1/statuses/:id**
-
- Retrieves a server status by ID.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | Status id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +-----------------+--------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+================================================================================+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``name`` | string | The string equivalent of the status |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``description`` | string | A short description of the status |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
- +-----------------+--------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "4",
- "name": "ADMIN_DOWN",
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
- "lastUpdated": "2013-02-13 16:34:29"
- }
- ]
- }
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/status.txt b/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
new file mode 100644
index 0000000..6a8c92a
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/status.txt
@@ -0,0 +1,127 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-status:
+
+Status
+======
+
+.. _to-api-v11-statuses-route:
+
+/api/1.1/statuses
++++++++++++++++++
+
+**GET /api/1.1/statuses**
+
+ Retrieves a list of the server status codes available.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "5",
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "1",
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "2",
+ "name": "ONLINE",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "3",
+ "name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
+**GET /api/1.1/statuses/:id**
+
+ Retrieves a server status by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Status id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+================================================================================+
+ | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The string equivalent of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``description`` | string | A short description of the status |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +-----------------+--------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+ }
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/system.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/system.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/system.rst.txt
deleted file mode 100644
index c4e53df..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/system.rst.txt
+++ /dev/null
@@ -1,79 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-sys:
-
-System
-======
-
-.. _to-api-v11-sys-route:
-
-/api/1.1/system
-+++++++++++++++
-
-**GET /api/1.1/system/info.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Key | Type | Description |
- +============================+========+======================================================================================================================================+
- | ``parameters`` | hash | This is a hash with the parameter names that describe the Traffic Ops installation as keys. |
- | | | These are all the parameters in the ``GLOBAL`` profile. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.toolname`` | string | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated |
- | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.instance_name`` | string | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>traffic_rtr_fwd_proxy`` | string | When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. |
- | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
- | | | this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to |
- | | | set this parameter on a production system. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.url`` | string | The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated |
- | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>traffic_mon_fwd_proxy`` | string | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. |
- | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
- | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
- | | | set this parameter on a production system. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.logourl`` | string | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>tm.infourl`` | string | This is the "for more information go here" URL, which is visible in the About page. |
- +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "parameters": {
- "tm.toolname": "Traffic Ops",
- "tm.infourl": "http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info",
- "traffic_mon_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
- "traffic_rtr_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
- "tm.logourl": "\/images\/tc_logo.png",
- "tm.url": "https:\/\/tm.kabletown.net\/",
- "tm.instance_name": "Kabletown CDN"
- }
- },
- }
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/system.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/system.txt b/docs/latest/_sources/development/traffic_ops_api/v11/system.txt
new file mode 100644
index 0000000..c4e53df
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/system.txt
@@ -0,0 +1,79 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-sys:
+
+System
+======
+
+.. _to-api-v11-sys-route:
+
+/api/1.1/system
++++++++++++++++
+
+**GET /api/1.1/system/info.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Key | Type | Description |
+ +============================+========+======================================================================================================================================+
+ | ``parameters`` | hash | This is a hash with the parameter names that describe the Traffic Ops installation as keys. |
+ | | | These are all the parameters in the ``GLOBAL`` profile. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.toolname`` | string | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated |
+ | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.instance_name`` | string | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>traffic_rtr_fwd_proxy`` | string | When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. |
+ | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+ | | | this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to |
+ | | | set this parameter on a production system. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.url`` | string | The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated |
+ | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>traffic_mon_fwd_proxy`` | string | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. |
+ | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting |
+ | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to |
+ | | | set this parameter on a production system. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.logourl`` | string | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>tm.infourl`` | string | This is the "for more information go here" URL, which is visible in the About page. |
+ +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "parameters": {
+ "tm.toolname": "Traffic Ops",
+ "tm.infourl": "http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info",
+ "traffic_mon_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
+ "traffic_rtr_fwd_proxy": "http:\/\/proxy.kabletown.net:81",
+ "tm.logourl": "\/images\/tc_logo.png",
+ "tm.url": "https:\/\/tm.kabletown.net\/",
+ "tm.instance_name": "Kabletown CDN"
+ }
+ },
+ }
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.rst.txt
deleted file mode 100644
index 5ed2654..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.rst.txt
+++ /dev/null
@@ -1,210 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-ext:
-
-TO Extensions
-=============
-
-.. _to-api-v11-ext-route:
-
-/api/1.1/to_extensions
-++++++++++++++++++++++
-
-**GET /api/1.1/to_extensions.json**
-
-Retrieves the list of extensions.
-
-Authentication Required: Yes
-
-Role(s) Required: None
-
-**Response Properties**
-
-+--------------------------+--------+--------------------------------------------+
-| Parameter | Type | Description |
-+==========================+========+============================================+
-|``script_file`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``version`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``name`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``description`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``info_url`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``additional_config_json``| string | |
-+--------------------------+--------+--------------------------------------------+
-|``isactive`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``id`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``type`` | string | |
-+--------------------------+--------+--------------------------------------------+
-|``servercheck_short_name``| string | |
-+--------------------------+--------+--------------------------------------------+
-
-**Response Example** ::
-
- {
- "response": [
- {
- script_file: "ping",
- version: "1.0.0",
- name: "ILO_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
- isactive: "1",
- id: "1",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "ILO"
- },
- {
- script_file: "ping",
- version: "1.0.0",
- name: "10G_PING",
- description: null,
- info_url: "http://foo.com/bar.html",
- additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
- isactive: "1",
- id: "2",
- type: "CHECK_EXTENSION_BOOL",
- servercheck_short_name: "10G"
- }
- ],
- }
-
-
-|
-
-**POST /api/1.1/to_extensions**
-
- Creates a Traffic Ops extension.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Parameters**
-
- +--------------------------+--------+--------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+============================================+
- |``name`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``version`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``info_url`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``script_file`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``isactive`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``additional_config_json``| string | |
- +--------------------------+--------+--------------------------------------------+
- |``description`` | string | |
- +--------------------------+--------+--------------------------------------------+
- |``servercheck_short_name``| string | |
- +--------------------------+--------+--------------------------------------------+
- |``type`` | string | |
- +--------------------------+--------+--------------------------------------------+
-
- **Request Example** ::
-
-
- {
- "name": "ILO_PING",
- "version": "1.0.0",
- "info_url": "http://foo.com/bar.html",
- "script_file": "ping",
- "isactive": "1",
- "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}",
- "description": null,
- "servercheck_short_name": "ILO"
- "type": "CHECK_EXTENSION_BOOL",
- }
-
-|
-
- **Response Properties**
-
- +------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Check Extension loaded."
- }
- ],
- }
-
-
-|
-
-**POST /api/1.1/to_extensions/:id/delete**
-
- Deletes a Traffic Ops extension.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +--------+----------+-----------------+
- | Name | Required | Description |
- +========+==========+=================+
- | ``id`` | yes | TO extension id |
- +--------+----------+-----------------+
-
- **Response Properties**
-
- +------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Extension deleted."
- }
- ],
- }
-
-
-|
-
[20/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_router.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_router.txt b/docs/latest/_sources/development/traffic_router.txt
new file mode 100644
index 0000000..6df7627
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_router.txt
@@ -0,0 +1,143 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Traffic Router
+**************
+Introduction
+============
+Traffic Router is a Java Tomcat application that routes clients to the closest available cache on the CDN using both HTTP and DNS. Cache availability is determined by Traffic Monitor; consequently Traffic Router polls Traffic Monitor for its configuration and cache health state information, and uses this data to make routing decisions. HTTP routing is performed by localizing the client based on the request's source IP address (IPv4 or IPv6), and issues an HTTP 302 redirect to the nearest cache. HTTP routing utilizes consistent hashing on request URLs to optimize cache performance and request distribution. DNS routing is performed by localizing clients, resolvers in most cases, requesting ``A`` and ``AAAA`` records for a configurable name such as ``edge.deliveryservice.somecdn.net``. Traffic Router is comprised of four separate Maven modules:
+
+ * api - Provides a simple JSON interface into certain aspects of core and is deployed as a WAR to a Service (read: connector/listen port) within Tomcat which is separate from core
+ * connector - A JAR that overrides Tomcat's standard Http11Protocol Connector class and allows Traffic Router to delay opening listen sockets until it is in a state suitable for routing traffic
+ * geolocation - Submodule for defining geolocation services
+ * testServer - A convenience server for easier manual testing of the API portion of Traffic Router on a development machine
+ * core - Services DNS and HTTP requests, performs localization on routing requests, and is deployed as a WAR to a Service (read: connector/listen port) within Tomcat which is separate from api
+ * rpm - A simple Maven project which gathers the artifacts from the prior three modules and builds an RPM
+
+Software Requirements
+=====================
+To work on Traffic Router you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+* Eclipse >= Kepler SR2 (or another Java IDE)
+* Maven >= 3.3.1
+* JDK >= 6.0
+
+Traffic Router Project Tree Overview
+=====================================
+* ``traffic_control/traffic_traffic_router/`` - base directory for Traffic Router
+
+ * ``api/`` - Source code for Traffic Router API, which is built as its own deployable WAR file and communicates with Traffic Router Core using JMX
+
+ * ``src/main`` - Main source directory for Traffic Router API
+
+ * ``java/`` - Java source code for Traffic Router API
+ * ``resources/`` - Spring resources pulled in during an RPM build
+ * ``webapp/`` - Java webapp resources
+
+ * ``src/test`` - Test source directory for Traffic Router API
+
+ * ``java/`` - JUnit based unit tests for Traffic Router API
+ * ``resources/`` - Resources pulled in by unit tests
+
+ * ``connector/`` - Source code for Traffic Router Connector;
+
+ * ``src/main/java`` - Java source directory for Traffic Router Connector
+
+ * ``core/`` - Source code for Traffic Router Core, which is built as its own deployable WAR file and communicates with Traffic Router API using JMX
+
+ * ``src/main`` - Main source directory for Traffic Router Core
+
+ * ``etc/init.d`` - Init script for Tomcat
+ * ``conf/`` - Minimum required configuration files
+ * ``java/`` - Java source code for Traffic Router Core
+ * ``opt/tomcat/conf`` - Contains Tomcat configuration file(s) pulled in during an RPM build
+ * ``resources/`` - Resources pulled in during an RPM build
+ * ``scripts/`` - Scripts used by the RPM build process
+ * ``webapp/`` - Java webapp resources
+
+ * ``src/test`` - Test source directory for Traffic Router Core
+
+ * ``conf/`` - Minimal Configuration files that make it possible to run junit tests
+ * ``db/`` - Files downloaded by unit tests
+ * ``java/`` - JUnit based unit tests for Traffic Router Core
+ * ``resources/`` - Example data files used by junit tests
+
+ * ``var/auto-zones`` - BIND formatted zone files generated by Traffic Router Core during unit testing
+
+Java Formatting Conventions
+===========================
+None at this time. The codebase will eventually be formatted per Java standards.
+
+Installing The Developer Environment
+====================================
+To install the Traffic Router Developer environment:
+
+1. Clone the traffic_control repository using Git.
+2. Change directories into ``traffic_control/traffic_router``.
+3. Set the environment variable TRAFFIC_MONITOR_HOSTS to be a semicolon delimited list of Traffic Monitors that can be accessed during integration tests
+4. core/src/test/resources no longer exists
+5. core/src/test/conf contains a properties file for accessing Traffic Ops
+6. Default configuration values now reside in core/src/main/webapp/WEB-INF/applicationContext.xml
+7. The above values may be overridden by creating and/or modifying the property files listed in core/src/main/resources/applicationProperties.xml
+8. Pre-existing properties files are still honored by Traffic Router
+
++-------------------------------------+------------------------------------------------------------------------------------------------------------------+
+| Parameter | Value |
++=====================================+==================================================================================================================+
+| ``traffic_monitor.bootstrap.hosts`` | FQDN and port of the Traffic Monitor instance(s), separated by semicolons as necessary (do not include http://). |
++-------------------------------------+------------------------------------------------------------------------------------------------------------------+
+
+4. Import the existing git repo into Eclipse:
+
+ a. File -> Import -> Git -> Projects from Git; Next
+ b. Existing local repository; Next
+ c. Add -> browse to find ``traffic_control``; Open
+ d. Select ``traffic_control``; Next
+ e. Ensure "Import existing projects" is selected, expand ``traffic_control``, select ``traffic_router``; Next
+ f. Ensure ``traffic_router_api``, ``traffic_router_connector``, and ``traffic_router_core`` are checked; Finish (this step can take several minutes to complete)
+ g. Ensure ``traffic_router_api``, ``traffic_router_connector``, and ``traffic_router_core`` have been opened by Eclipse after importing
+
+5. From the terminal, run ``mvn clean verify`` from the ``traffic_router`` directory
+
+6. Start the embedded Jetty instance for Core from within Eclipse
+
+ a. In the package explorer, expand ``traffic_router_core``
+ b. Expand ``src/test/java``
+ c. Expand the package ``com.comcast.cdn.traffic_control.traffic_router.core``
+ d. Open and run ``TrafficRouterStart.java``
+
+ .. Note:: If an error is displayed in the Console, run ``mvn clean verify`` from the ``traffic_router`` directory
+
+7. Traffic Router Core should now be running; the HTTP routing interface is available on http://localhost:8081, while the DNS server and routing interface is available on localhost:1053 via TCP and UDP.
+
+Test Cases
+==========
+* Unit tests can be executed using Maven by running ``mvn test`` at the root of the ``traffic_router`` project.
+* Unit and Integration tests can be executed using Maven by running ``mvn verify`` at the root of the ``traffic_router`` project.
+
+RPM Packaging
+=============
+Running ``mvn package`` on a Linux based distribution will trigger the build process to create the Traffic Router rpm.
+
+API
+===
+
+:ref:`reference-tr-api`
+
+.. toctree::
+ :hidden:
+ :maxdepth: 1
+
+ traffic_router/traffic_router_api
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt b/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt
deleted file mode 100644
index d742276..0000000
--- a/docs/latest/_sources/development/traffic_router/traffic_router_api.rst.txt
+++ /dev/null
@@ -1,48 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _reference-tr-api:
-
-Traffic Router API
-==================
-
-**/crs/stats**
-
-General stats.
-
-|
-
-**/crs/stats/ip/:ipaddress**
-
-Geolocation information for an IPv4 or IPv6 address.
-
-|
-
-**/crs/locations**
-
-A list of configured cache groups.
-
-|
-
-**/crs/locations/caches**
-
-A mapping of caches to cache groups and their current health state.
-
-|
-
-/crs/locations/:location/caches
-
-A list of caches for this cache group only.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_router/traffic_router_api.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_router/traffic_router_api.txt b/docs/latest/_sources/development/traffic_router/traffic_router_api.txt
new file mode 100644
index 0000000..d742276
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_router/traffic_router_api.txt
@@ -0,0 +1,48 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _reference-tr-api:
+
+Traffic Router API
+==================
+
+**/crs/stats**
+
+General stats.
+
+|
+
+**/crs/stats/ip/:ipaddress**
+
+Geolocation information for an IPv4 or IPv6 address.
+
+|
+
+**/crs/locations**
+
+A list of configured cache groups.
+
+|
+
+**/crs/locations/caches**
+
+A mapping of caches to cache groups and their current health state.
+
+|
+
+/crs/locations/:location/caches
+
+A list of caches for this cache group only.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_server.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_server.rst.txt b/docs/latest/_sources/development/traffic_server.rst.txt
deleted file mode 100644
index f8a78fb..0000000
--- a/docs/latest/_sources/development/traffic_server.rst.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Traffic Server
-**************
-See the `Apache Traffic Server documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_server.txt b/docs/latest/_sources/development/traffic_server.txt
new file mode 100644
index 0000000..f8a78fb
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_server.txt
@@ -0,0 +1,19 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Traffic Server
+**************
+See the `Apache Traffic Server documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_stats.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_stats.rst.txt b/docs/latest/_sources/development/traffic_stats.rst.txt
deleted file mode 100644
index 02317f7..0000000
--- a/docs/latest/_sources/development/traffic_stats.rst.txt
+++ /dev/null
@@ -1,58 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Traffic Stats
-*************
-
-Introduction
-============
-Traffic Stats is a utility written in `Go <http.golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by `Grafana <http://grafana.org>`_ which are linked from Traffic Ops. Traffic Stats also calculates daily statistics from InfluxDb and stores them in the Traffic Ops database.
-
-Software Requirements
-=====================
-To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
-
- * `Go 1.7.x or above <https://golang.org/doc/install>`_
- * Access to a working instance of Traffic Ops
- * Access to a working instance of Traffic Monitor
- * `InfluxDb version 1.0.0 or greater <https://influxdb.com/download/index.html>`_
-
-Traffic Stats Project Tree Overview
-=====================================
- * **traffic_control/traffic_stats** - contains Go source files and Files used to create the Traffic Stats rpm.
- * **traffic_control/traffic_stats/grafana/** - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.
- * **traffic_control/traffic_stats/influxdb_tools/** - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.
-
-
-Go Formatting Conventions
-============================
-In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code. It is also recommended to use `Go lint <https://github.com/golang/lint>`_.
-
-Installing The Developer Environment
-====================================
-To install the Traffic Ops Developer environment:
-
- - Clone the traffic_control repository using Git into a location accessible by your $GOPATH
- - Navigate to the traffic_ops/client directory of your cloned repository. (This is the directory containing Traffic Ops client code used by Traffic Stats)
- - From the traffic_ops/client directory run ``go test`` to test the client code. This will run all unit tests for the client and return the results. If there are missing dependencies you will need to run ``go get <dependency name>`` to get the dependency
- - Once the tests pass, run ``go install`` to build and install the Traffic Ops client package. This makes it accessible to Traffic Stats.
- - Navigate to your cloned repo under Traffic Stats
- - Run ``go build traffic_stats.go`` to build traffic_stats. You will need to run ``go get`` for any missing dependencies.
-
-
-Test Cases
-==========
- Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_stats.txt b/docs/latest/_sources/development/traffic_stats.txt
new file mode 100644
index 0000000..02317f7
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_stats.txt
@@ -0,0 +1,58 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Traffic Stats
+*************
+
+Introduction
+============
+Traffic Stats is a utility written in `Go <http.golang.org>`_ that is used to acquire and store statistics about CDNs controlled by Traffic Control. Traffic Stats mines metrics from Traffic Monitor's JSON APIs and stores the data in `InfluxDb <http://influxdb.com>`_. Data is typically stored in InfluxDb on a short-term basis (30 days or less) and is used to drive graphs created by `Grafana <http://grafana.org>`_ which are linked from Traffic Ops. Traffic Stats also calculates daily statistics from InfluxDb and stores them in the Traffic Ops database.
+
+Software Requirements
+=====================
+To work on Traffic Stats you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+ * `Go 1.7.x or above <https://golang.org/doc/install>`_
+ * Access to a working instance of Traffic Ops
+ * Access to a working instance of Traffic Monitor
+ * `InfluxDb version 1.0.0 or greater <https://influxdb.com/download/index.html>`_
+
+Traffic Stats Project Tree Overview
+=====================================
+ * **traffic_control/traffic_stats** - contains Go source files and Files used to create the Traffic Stats rpm.
+ * **traffic_control/traffic_stats/grafana/** - contains a javascript file which is installed on the grafana server. This allows Traffic Ops to create custom dashboards for Delivery Services, Caches, etc.
+ * **traffic_control/traffic_stats/influxdb_tools/** - contains one tool to create the databases and retention policies needed by Traffic Stats as well as continuous queries to downsample data; contains another tool to sync downsampled data between influxdb instances. This is is helpful if you have multiple instances and they get out of sync with data.
+
+
+Go Formatting Conventions
+============================
+In general `Go fmt <https://golang.org/cmd/gofmt/>`_ is the standard for formatting go code. It is also recommended to use `Go lint <https://github.com/golang/lint>`_.
+
+Installing The Developer Environment
+====================================
+To install the Traffic Ops Developer environment:
+
+ - Clone the traffic_control repository using Git into a location accessible by your $GOPATH
+ - Navigate to the traffic_ops/client directory of your cloned repository. (This is the directory containing Traffic Ops client code used by Traffic Stats)
+ - From the traffic_ops/client directory run ``go test`` to test the client code. This will run all unit tests for the client and return the results. If there are missing dependencies you will need to run ``go get <dependency name>`` to get the dependency
+ - Once the tests pass, run ``go install`` to build and install the Traffic Ops client package. This makes it accessible to Traffic Stats.
+ - Navigate to your cloned repo under Traffic Stats
+ - Run ``go build traffic_stats.go`` to build traffic_stats. You will need to run ``go get`` for any missing dependencies.
+
+
+Test Cases
+==========
+ Currently there are no automated tests for Traffic Stats :( but pull requests are always welcome to fix this problem!
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/administration.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/administration.rst.txt b/docs/latest/_sources/faq/administration.rst.txt
deleted file mode 100644
index feecff7..0000000
--- a/docs/latest/_sources/faq/administration.rst.txt
+++ /dev/null
@@ -1,66 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Running a Traffic Control CDN
-*****************************
-
-
-Why is my CRConfig.json rejected?
-=================================
- Especially in version 1.1.0, there's a number of manual steps that need to be done after the initial install. Make sure that after the initial install, you perform these steps in order:
-
- .. Note:: Even though Traffic Ops allows you to enter the servers with no IPv6 address information, the CRConfig will not be accepted by Traffic Router without IPv6 address information for at least Traffic Router and Traffic Monitor. Traffic Control assumes in a lot of places that all servers have at least an IPv4 and an IPv6 address. If you are not using IPv6, it is best to enter dummy addresses for all server types, and turn IPv6 off in all delivery services. (https://github.com/Comcast/traffic_control/issues/44).
-
-
- * Add users
- Not necessarily needed for getting your CRConfig accepted, but always a good idea.
-
- * Add Divisions
- You will need at least one.
-
- * Add Regions
- You will need at least one.
-
- * Add Physical Locations
- You will need at least one.
-
- * Add Mid tier Cache Groups
- You will need at least one.
-
- * Add Edge tier Cache Groups
- You will need at least one.
-
- * Add Traffic Monitors
- You will need to enter at least one Traffic Monitor - make sure to change the server status to *ONLINE*.
-
- * Add Traffic Routers
- You will need to enter at least one Traffic Router - make sure to change the server status to *ONLINE*.
-
- * Add Edges
- You will need at least one edge cache to make Traffic Router accept the CRConfig.
-
- * Add Mid
- Technically you don't need a mid tier, but if you have one, best to enter the info before continuing.
-
- * Change the ``polling.url`` parameters to reflect your CDN
- Set where to get the coverage zone map, and the geo IP database.
-
- * Create at least one delivery service, and assign at least one edge cache in REPORTED state to it.
- Even if it is a dummy DS, without a single DS, the CRConfig will not be accepted by Traffic Router.
-
- * Snapshot CRConfig
- **Tools > Snapshot CRConfig** diff, and write.
-
- Now you are ready to install the sw on Traffic Monitor and then Traffic Router.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/administration.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/administration.txt b/docs/latest/_sources/faq/administration.txt
new file mode 100644
index 0000000..feecff7
--- /dev/null
+++ b/docs/latest/_sources/faq/administration.txt
@@ -0,0 +1,66 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Running a Traffic Control CDN
+*****************************
+
+
+Why is my CRConfig.json rejected?
+=================================
+ Especially in version 1.1.0, there's a number of manual steps that need to be done after the initial install. Make sure that after the initial install, you perform these steps in order:
+
+ .. Note:: Even though Traffic Ops allows you to enter the servers with no IPv6 address information, the CRConfig will not be accepted by Traffic Router without IPv6 address information for at least Traffic Router and Traffic Monitor. Traffic Control assumes in a lot of places that all servers have at least an IPv4 and an IPv6 address. If you are not using IPv6, it is best to enter dummy addresses for all server types, and turn IPv6 off in all delivery services. (https://github.com/Comcast/traffic_control/issues/44).
+
+
+ * Add users
+ Not necessarily needed for getting your CRConfig accepted, but always a good idea.
+
+ * Add Divisions
+ You will need at least one.
+
+ * Add Regions
+ You will need at least one.
+
+ * Add Physical Locations
+ You will need at least one.
+
+ * Add Mid tier Cache Groups
+ You will need at least one.
+
+ * Add Edge tier Cache Groups
+ You will need at least one.
+
+ * Add Traffic Monitors
+ You will need to enter at least one Traffic Monitor - make sure to change the server status to *ONLINE*.
+
+ * Add Traffic Routers
+ You will need to enter at least one Traffic Router - make sure to change the server status to *ONLINE*.
+
+ * Add Edges
+ You will need at least one edge cache to make Traffic Router accept the CRConfig.
+
+ * Add Mid
+ Technically you don't need a mid tier, but if you have one, best to enter the info before continuing.
+
+ * Change the ``polling.url`` parameters to reflect your CDN
+ Set where to get the coverage zone map, and the geo IP database.
+
+ * Create at least one delivery service, and assign at least one edge cache in REPORTED state to it.
+ Even if it is a dummy DS, without a single DS, the CRConfig will not be accepted by Traffic Router.
+
+ * Snapshot CRConfig
+ **Tools > Snapshot CRConfig** diff, and write.
+
+ Now you are ready to install the sw on Traffic Monitor and then Traffic Router.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/development.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/development.rst.txt b/docs/latest/_sources/faq/development.rst.txt
deleted file mode 100644
index 8518eeb..0000000
--- a/docs/latest/_sources/faq/development.rst.txt
+++ /dev/null
@@ -1,21 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Development
-***********
-
-How can I become involved?
-==========================
- See our `CONTRIBUTING <https://github.com/apache/incubator-trafficcontrol/blob/master/CONTRIBUTING.md>`_ page.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/development.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/development.txt b/docs/latest/_sources/faq/development.txt
new file mode 100644
index 0000000..8518eeb
--- /dev/null
+++ b/docs/latest/_sources/faq/development.txt
@@ -0,0 +1,21 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Development
+***********
+
+How can I become involved?
+==========================
+ See our `CONTRIBUTING <https://github.com/apache/incubator-trafficcontrol/blob/master/CONTRIBUTING.md>`_ page.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/general.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/general.rst.txt b/docs/latest/_sources/faq/general.rst.txt
deleted file mode 100644
index 747aa60..0000000
--- a/docs/latest/_sources/faq/general.rst.txt
+++ /dev/null
@@ -1,52 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-General
-*******
-
-Who is using Traffic Control?
-=============================
- `Comcast Cable <http://www.comcast.com/>`_
- Comcast is the original developer of Traffic Control and is using it for all it's IP video delivery, delivering images and software to it's X1 platform, and for `delivering third party content <https://www.comcastwholesale.com/products-services/content-delivery-network>`_ to it's footprint.
-
- `Cox Communications <http://www.cox.com/>`_
-
- `Cisco <http://www.cisco.com/>`_
- Cisco has a product called `Open Media Distribution <http://www.cisco.com/c/en/us/products/video/open-media-distribution/index.html>`_ that is based on Traffic Control.
-
- `Concurrent <https://www.ccur.com/>`_
- Concurrent has a product that uses Traffic Control, see their `github page <https://github.com/concurrentlabs/laguna>`_ for more info.
-
- `Augere Pakistan / QUBEE <http://www.qubee.com.pk>`_
-
-How do I get help with Traffic Control?
-=======================================
- Hop on to our Slack Channel by filling out `this form <https://goo.gl/Suzakj>`_, or send a question to our mailing list `here <ma...@trafficcontrol.incubator.apache.org>`_.
-
-What is Rascal?
-===============
- Rascal was the original name for Traffic Monitor. You will sometimes still see this name in the source, or in older documents.
-
-What is the CCR?
-================
- Comcast Content Router was the original name for Traffic Router. You will sometimes still see this name in the source, or in older documents.
-
-What is Twelve Monkeys?
-=======================
- Twelve Monkeys was the the original internal name for Traffic Ops. You will sometimes still see this name in the source, or in older documents. It's also a good movie.
-
-What license is Traffic Control released under?
-===============================================
- See the `LICENSE file <https://github.com/apache/incubator-trafficcontrol/blob/master/LICENSE>`_
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/general.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/general.txt b/docs/latest/_sources/faq/general.txt
new file mode 100644
index 0000000..747aa60
--- /dev/null
+++ b/docs/latest/_sources/faq/general.txt
@@ -0,0 +1,52 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+General
+*******
+
+Who is using Traffic Control?
+=============================
+ `Comcast Cable <http://www.comcast.com/>`_
+ Comcast is the original developer of Traffic Control and is using it for all it's IP video delivery, delivering images and software to it's X1 platform, and for `delivering third party content <https://www.comcastwholesale.com/products-services/content-delivery-network>`_ to it's footprint.
+
+ `Cox Communications <http://www.cox.com/>`_
+
+ `Cisco <http://www.cisco.com/>`_
+ Cisco has a product called `Open Media Distribution <http://www.cisco.com/c/en/us/products/video/open-media-distribution/index.html>`_ that is based on Traffic Control.
+
+ `Concurrent <https://www.ccur.com/>`_
+ Concurrent has a product that uses Traffic Control, see their `github page <https://github.com/concurrentlabs/laguna>`_ for more info.
+
+ `Augere Pakistan / QUBEE <http://www.qubee.com.pk>`_
+
+How do I get help with Traffic Control?
+=======================================
+ Hop on to our Slack Channel by filling out `this form <https://goo.gl/Suzakj>`_, or send a question to our mailing list `here <ma...@trafficcontrol.incubator.apache.org>`_.
+
+What is Rascal?
+===============
+ Rascal was the original name for Traffic Monitor. You will sometimes still see this name in the source, or in older documents.
+
+What is the CCR?
+================
+ Comcast Content Router was the original name for Traffic Router. You will sometimes still see this name in the source, or in older documents.
+
+What is Twelve Monkeys?
+=======================
+ Twelve Monkeys was the the original internal name for Traffic Ops. You will sometimes still see this name in the source, or in older documents. It's also a good movie.
+
+What license is Traffic Control released under?
+===============================================
+ See the `LICENSE file <https://github.com/apache/incubator-trafficcontrol/blob/master/LICENSE>`_
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/index.rst.txt b/docs/latest/_sources/faq/index.rst.txt
deleted file mode 100644
index 82ea912..0000000
--- a/docs/latest/_sources/faq/index.rst.txt
+++ /dev/null
@@ -1,26 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-FAQ
-***
-
-Table of Contents:
-
-.. toctree::
- :maxdepth: 2
-
- general
- development
- administration
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/faq/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/faq/index.txt b/docs/latest/_sources/faq/index.txt
new file mode 100644
index 0000000..82ea912
--- /dev/null
+++ b/docs/latest/_sources/faq/index.txt
@@ -0,0 +1,26 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+FAQ
+***
+
+Table of Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+ general
+ development
+ administration
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/glossary.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/glossary.rst.txt b/docs/latest/_sources/glossary.rst.txt
deleted file mode 100644
index a932579..0000000
--- a/docs/latest/_sources/glossary.rst.txt
+++ /dev/null
@@ -1,81 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _glossary:
-
-Glossary
-========
-
-.. glossary::
-
- 302 content routing
- :ref:`rl-http-cr`.
-
- astats (stats_over_http)
- An ATS plugin that allows you to monitor vitals of the ATS server. See :ref:`rl-astats`.
-
- cache
- A caching proxy server. See :ref:`rl-caching_proxy`.
-
- cachegroup
- A group of caches that together create a combined larger cache using consistent hashing. See :ref:`rl-cachegroup`.
-
- consistent hashing
- See `the Wikipedia article <http://en.wikipedia.org/wiki/Consistent_hashing>`_; Traffic Control uses consistent hashing when using :ref:`rl-http-cr` for the edge tier and when selecting parents in the mid tier.
-
- content routing
- Directing clients (or client systems) to a particular location or device in a location for optimal delivery of content See also :ref:`rl-http-cr` and :ref:`rl-dns-cr`.
-
- coverage zone map
- The coverage zone map (czm) or coverage zone file (zcf) is a file that maps network prefixes to cachegroups. See :ref:`rl-localization`.
-
- delivery service
- A grouping of content in the CDN, usually a determined by the URL hostname. See :ref:`rl-ds`.
-
- edge (tier or cache)
- Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a :ref:`rl-rev-proxy`. See also :ref:`rl-cachegroup`.
-
- (traffic ops) extension
- Using *extensions*, Traffic Ops be extended to use proprietary checks or monitoring sources. See :ref:`rl-trops-ext`.
-
- forward proxy
- A proxy that works that acts like it is the client to the origin. See :ref:`rl-fwd-proxy`.
-
- geo localization or geo routing
- Localizing clients to the nearest caches using a geo database like the one from Maxmind.
-
- health protocol
- The protocol to monitor the health of all the caches. See :ref:`rl-health-proto`.
-
- localization
- Finding location on the network, or on planet earth. See :ref:`rl-localization`.
-
- mid (tier or cache)
- The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a :ref:`rl-fwd-proxy`. See also :ref:`rl-cachegroup`.
-
- origin
- The source of content for the CDN. Usually a redundant HTTP/1.1 webserver.
-
- parent (cache or cachegroup)
- The (group of) cache(s) in the higher tier. See :ref:`rl-cachegroup`.
-
- profile
- A group of settings (parameters) that will be applied to a server. See :ref:`rl-profile`.
-
- reverse proxy
- A proxy that acts like it is the origin to the client. See :ref:`rl-rev-proxy`.
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/glossary.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/glossary.txt b/docs/latest/_sources/glossary.txt
new file mode 100644
index 0000000..b32bea9
--- /dev/null
+++ b/docs/latest/_sources/glossary.txt
@@ -0,0 +1,66 @@
+.. _glossary:
+
+Glossary
+========
+
+.. glossary::
+
+ 302 content routing
+ :ref:`rl-http-cr`.
+
+ astats (stats_over_http)
+ An ATS plugin that allows you to monitor vitals of the ATS server. See :ref:`rl-astats`.
+
+ cache
+ A caching proxy server. See :ref:`rl-caching_proxy`.
+
+ cachegroup
+ A group of caches that together create a combined larger cache using consistent hashing. See :ref:`rl-cachegroup`.
+
+ consistent hashing
+ See `the Wikipedia article <http://en.wikipedia.org/wiki/Consistent_hashing>`_; Traffic Control uses consistent hashing when using :ref:`rl-http-cr` for the edge tier and when selecting parents in the mid tier.
+
+ content routing
+ Directing clients (or client systems) to a particular location or device in a location for optimal delivery of content See also :ref:`rl-http-cr` and :ref:`rl-dns-cr`.
+
+ coverage zone map
+ The coverage zone map (czm) or coverage zone file (zcf) is a file that maps network prefixes to cachegroups. See :ref:`rl-localization`.
+
+ delivery service
+ A grouping of content in the CDN, usually a determined by the URL hostname. See :ref:`rl-ds`.
+
+ edge (tier or cache)
+ Closest to the client or end-user. The edge tier is the tier that serves the client, edge caches are caches in the edge tier. In a Traffic Control CDN the basic function of the edge cache is that of a :ref:`rl-rev-proxy`. See also :ref:`rl-cachegroup`.
+
+ (traffic ops) extension
+ Using *extensions*, Traffic Ops be extended to use proprietary checks or monitoring sources. See :ref:`rl-trops-ext`.
+
+ forward proxy
+ A proxy that works that acts like it is the client to the origin. See :ref:`rl-fwd-proxy`.
+
+ geo localization or geo routing
+ Localizing clients to the nearest caches using a geo database like the one from Maxmind.
+
+ health protocol
+ The protocol to monitor the health of all the caches. See :ref:`rl-health-proto`.
+
+ localization
+ Finding location on the network, or on planet earth. See :ref:`rl-localization`.
+
+ mid (tier or cache)
+ The tier above the edge tier. The mid tier does not directly serves the end-user and is used as an additional layer between the edge and the origin. In a Traffic Control CDN the basic function of the mid cache is that of a :ref:`rl-fwd-proxy`. See also :ref:`rl-cachegroup`.
+
+ origin
+ The source of content for the CDN. Usually a redundant HTTP/1.1 webserver.
+
+ parent (cache or cachegroup)
+ The (group of) cache(s) in the higher tier. See :ref:`rl-cachegroup`.
+
+ profile
+ A group of settings (parameters) that will be applied to a server. See :ref:`rl-profile`.
+
+ reverse proxy
+ A proxy that acts like it is the origin to the client. See :ref:`rl-rev-proxy`.
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/index.rst.txt b/docs/latest/_sources/index.rst.txt
deleted file mode 100644
index 2a12096..0000000
--- a/docs/latest/_sources/index.rst.txt
+++ /dev/null
@@ -1,80 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-%%%%%%%%%%%%%%%
-Traffic Control
-%%%%%%%%%%%%%%%
-
-The vast majority of today's Internet traffic is media files being sent from a single source to many thousands or even millions of destinations. Content Delivery Networks make that one-to-many distribution possible in an economical way.
-
-Traffic Control is an Open Source implementation of a Content Delivery Network.
-
-The following documentation sections are available:
-
-CDN Basics
-==========
-A review of the basic functionality of a Content Delivery Network.
-
-.. toctree::
- :maxdepth: 2
-
- basics/index
-
-
-Traffic Control Overview
-========================
-An introduction to the Traffic Control architecture, components, and their integration.
-
-.. toctree::
- :maxdepth: 0
-
- overview/index
-
-Administrator's Guide
-=====================
-How to deploy and manage a Traffic Control CDN.
-
-.. toctree::
- :maxdepth: 3
-
- admin/index
-
-Developer's Guide
-==================
-A guide to the various internal and external APIs, and a introduction for the Traffic Control developer.
-
-.. toctree::
- :maxdepth: 3
-
- development/index
-
-
-FAQ
-===
-
-.. toctree::
- :maxdepth: 3
-
- faq/index
-
-Indices and Tables
-==================
-
-.. toctree::
- :maxdepth: 3
-
- glossary.rst
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/index.txt b/docs/latest/_sources/index.txt
new file mode 100644
index 0000000..2a12096
--- /dev/null
+++ b/docs/latest/_sources/index.txt
@@ -0,0 +1,80 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+%%%%%%%%%%%%%%%
+Traffic Control
+%%%%%%%%%%%%%%%
+
+The vast majority of today's Internet traffic is media files being sent from a single source to many thousands or even millions of destinations. Content Delivery Networks make that one-to-many distribution possible in an economical way.
+
+Traffic Control is an Open Source implementation of a Content Delivery Network.
+
+The following documentation sections are available:
+
+CDN Basics
+==========
+A review of the basic functionality of a Content Delivery Network.
+
+.. toctree::
+ :maxdepth: 2
+
+ basics/index
+
+
+Traffic Control Overview
+========================
+An introduction to the Traffic Control architecture, components, and their integration.
+
+.. toctree::
+ :maxdepth: 0
+
+ overview/index
+
+Administrator's Guide
+=====================
+How to deploy and manage a Traffic Control CDN.
+
+.. toctree::
+ :maxdepth: 3
+
+ admin/index
+
+Developer's Guide
+==================
+A guide to the various internal and external APIs, and a introduction for the Traffic Control developer.
+
+.. toctree::
+ :maxdepth: 3
+
+ development/index
+
+
+FAQ
+===
+
+.. toctree::
+ :maxdepth: 3
+
+ faq/index
+
+Indices and Tables
+==================
+
+.. toctree::
+ :maxdepth: 3
+
+ glossary.rst
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/index.rst.txt b/docs/latest/_sources/overview/index.rst.txt
deleted file mode 100644
index 65dd20e..0000000
--- a/docs/latest/_sources/overview/index.rst.txt
+++ /dev/null
@@ -1,30 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Traffic Control Overview
-************************
-Introduces the Traffic Control architecture, components, and their integration.
-
-.. toctree::
- :maxdepth: 2
-
- introduction.rst
- traffic_ops
- traffic_portal
- traffic_router
- traffic_monitor
- traffic_stats
- traffic_server
- traffic_vault
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/index.txt b/docs/latest/_sources/overview/index.txt
new file mode 100644
index 0000000..65dd20e
--- /dev/null
+++ b/docs/latest/_sources/overview/index.txt
@@ -0,0 +1,30 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Traffic Control Overview
+************************
+Introduces the Traffic Control architecture, components, and their integration.
+
+.. toctree::
+ :maxdepth: 2
+
+ introduction.rst
+ traffic_ops
+ traffic_portal
+ traffic_router
+ traffic_monitor
+ traffic_stats
+ traffic_server
+ traffic_vault
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/introduction.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/introduction.rst.txt b/docs/latest/_sources/overview/introduction.rst.txt
deleted file mode 100644
index a983820..0000000
--- a/docs/latest/_sources/overview/introduction.rst.txt
+++ /dev/null
@@ -1,28 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Introduction
-============
-Traffic Control is a control plane for a CDN, which includes all of the components mentioned in the CDN Basics section, except for the Log File Analysis System. The caching software chosen for Traffic Control is `Apache Traffic Server <http://trafficserver.apache.org/>`_ (ATS). Although the current release only supports ATS as a cache, this may change with future releases.
-
-Traffic Control was first developed at Comcast for internal use and released to Open Source in April of 2015. Traffic Control moved into the Apache Incubator in August of 2016.
-
-Traffic Control implements the blue boxes in the architecture diagram below.
-
-
-.. image:: traffic_control_overview_3.png
- :align: center
-
-In the next sections each of these components will be explained further.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/introduction.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/introduction.txt b/docs/latest/_sources/overview/introduction.txt
new file mode 100644
index 0000000..a983820
--- /dev/null
+++ b/docs/latest/_sources/overview/introduction.txt
@@ -0,0 +1,28 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Introduction
+============
+Traffic Control is a control plane for a CDN, which includes all of the components mentioned in the CDN Basics section, except for the Log File Analysis System. The caching software chosen for Traffic Control is `Apache Traffic Server <http://trafficserver.apache.org/>`_ (ATS). Although the current release only supports ATS as a cache, this may change with future releases.
+
+Traffic Control was first developed at Comcast for internal use and released to Open Source in April of 2015. Traffic Control moved into the Apache Incubator in August of 2016.
+
+Traffic Control implements the blue boxes in the architecture diagram below.
+
+
+.. image:: traffic_control_overview_3.png
+ :align: center
+
+In the next sections each of these components will be explained further.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_monitor.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_monitor.rst.txt b/docs/latest/_sources/overview/traffic_monitor.rst.txt
deleted file mode 100644
index 1a3222f..0000000
--- a/docs/latest/_sources/overview/traffic_monitor.rst.txt
+++ /dev/null
@@ -1,66 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _reference-label-tc-tm:
-
-.. index::
- Traffic Monitor - Overview
-
-.. |arrow| image:: fwda.png
-
-Traffic Monitor
-===============
-Traffic Monitor is a Java/Tomcat application that monitors the caches in a CDN for a variety of metrics. These metrics are for use in determining the overall health of a given cache and the related delivery services. A given CDN can operate a number of Traffic Monitors, from a number of geographically diverse locations, to prevent false positives caused by network problems at a given site.
-
-Traffic Monitors operate independently, but use the state of other Traffic Monitors in conjunction with their own state, to provide a consistent view of CDN cache health to upstream applications such as Traffic Router. Health Protocol governs the cache and Delivery Service availability.
-
-Traffic Monitor provides a view into CDN health using several RESTful JSON endpoints, which are consumed by other Traffic Monitors and upstream components such as Traffic Router. Traffic Monitor is also responsible for serving the overall CDN configuration to Traffic Router, which ensures that the configuration of these two critical components remain synchronized as operational and health related changes propagate through the CDN.
-
-
-.. _rl-astats:
-
-|arrow| Cache Monitoring
--------------------------
- Traffic Monitor polls all caches configured with a status of ``REPORTED`` or ``ADMIN_DOWN`` at an interval specified as a configuration parameter in Traffic Ops. If the cache is set to ``ADMIN_DOWN`` it is marked as unavailable but still polled for availability and statistics. If the cache is explicitly configured with a status of ``ONLINE`` or ``OFFLINE``, it is not polled by Traffic Monitor and presented to Traffic Router as configured, regardless of actual availability.
-
- Traffic Monitor makes HTTP requests at regular intervals to a special URL on each EDGE cache and consumes the JSON output. The special URL is a plugin running on the Apache Traffic Server (ATS) caches called astats, which is restricted to Traffic Monitor only. The astats plugin provides insight into application and system performance, such as:
-
- - Throughput (e.g. bytes in, bytes out, etc).
- - Transactions (e.g. number of 2xx, 3xx, 4xx responses, etc).
- - Connections (e.g. from clients, to parents, origins, etc).
- - Cache performance (e.g.: hits, misses, refreshes, etc).
- - Storage performance (e.g.: writes, reads, frags, directories, etc).
- - System performance (e.g: load average, network interface throughput, etc).
-
- Many of the application level statistics are available at the global or aggregate level, some at the Delivery Service (remap rule) level. Traffic Monitor uses the system level performance to determine the overall health of the cache by evaluating network throughput and load against values configured in Traffic Ops. Traffic Monitor also uses throughput and transaction statistics at the remap rule level to determine Delivery Service health.
-
-If astats is unavailable due to a network related issue or the system statistics have exceeded the configured thresholds, Traffic Monitor will mark the cache as unavailable. If the delivery service statistics exceed the configured thresholds, the delivery service is marked as unavailable, and Traffic Router will start sending clients to the overflow destinations for that delivery service, but the cache remains available to serve other content,
-
-.. seealso:: For more information on ATS Statistics, see the `ATS documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_
-
-.. _rl-health-proto:
-
-|arrow| Health Protocol
------------------------
- Redundant Traffic Monitor servers operate independently from each other but take the state of other Traffic Monitors into account when asked for health state information. In the above overview of cache monitoring, the behavior of Traffic Monitor pertains only to how an individual instance detects and handles failures. The Health Protocol adds another dimension to the health state of the CDN by merging the states of all Traffic Monitors into one, and then taking the *optimistic* approach when dealing with a cache or Delivery Service that might have been marked as unavailable by this particular instance or a peer instance of Traffic Monitor.
-
- Upon startup or configuration change in Traffic Ops, in addition to caches, Traffic Monitor begins polling its peer Traffic Monitors whose state is set to ``ONLINE``. Each ``ONLINE`` Traffic Monitor polls all of its peers at a configurable interval and saves the peer's state for later use. When polling its peers, Traffic Monitor asks for the raw health state from each respective peer, which is strictly that instance's view of the CDN's health. When any ``ONLINE`` Traffic Monitor is asked for CDN health by an upstream component, such as Traffic Router, the component gets the health protocol influenced version of CDN health (non-raw view).
-
- In operation of the health protocol, Traffic Monitor takes all health states from all peers, including the locally known health state, and serves an optimistic outlook to the requesting client. This means that, for example, if three of the four Traffic Monitors see a given cache or Delivery Service as exceeding its thresholds and unavailable, it is still considered available. Only if all Traffic Monitors agree that the given object is unavailable is that state propagated to upstream components. This optimistic approach to the Health Protocol is counter to the "fail fast" philosophy, but serves well for large networks with complicated geography and or routing. The optimistic Health Protocol allows network failures or latency to occur without affecting overall traffic routing, as Traffic Monitors can and do have a different view of the network when deployed in geographically diverse locations. Short polling intervals of both the caches and Traffic Monitor peers help to reduce custom
er impact of outages.
-
-It is not uncommon for a cache to be marked unavailable by Traffic Monitor - in fact, it is business as usual for many CDNs. A hot video asset may cause a single cache (say cache-03) to get close to it's interface capacity, the health protocol "kicks in", and Traffic Monitor marks cache-03 as unavailable. New clients want to see the same asset, and now, Traffic Router will send these customers to another cache (say cache-01) in the same cachegroup. The load is now shared between cache-01 and cache-03. As clients finish watching the asset on cache-03, it will drop below the threshold and gets marked available again, and new clients will now go back to cache-03 again.
-
-It is less common for a delivery service to be marked unavailable by Traffic Monitor, the delivery service thresholds are usually used for overflow situations at extreme peaks to protect other delivery services in the CDN from getting impacted.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_monitor.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_monitor.txt b/docs/latest/_sources/overview/traffic_monitor.txt
new file mode 100644
index 0000000..1a3222f
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_monitor.txt
@@ -0,0 +1,66 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _reference-label-tc-tm:
+
+.. index::
+ Traffic Monitor - Overview
+
+.. |arrow| image:: fwda.png
+
+Traffic Monitor
+===============
+Traffic Monitor is a Java/Tomcat application that monitors the caches in a CDN for a variety of metrics. These metrics are for use in determining the overall health of a given cache and the related delivery services. A given CDN can operate a number of Traffic Monitors, from a number of geographically diverse locations, to prevent false positives caused by network problems at a given site.
+
+Traffic Monitors operate independently, but use the state of other Traffic Monitors in conjunction with their own state, to provide a consistent view of CDN cache health to upstream applications such as Traffic Router. Health Protocol governs the cache and Delivery Service availability.
+
+Traffic Monitor provides a view into CDN health using several RESTful JSON endpoints, which are consumed by other Traffic Monitors and upstream components such as Traffic Router. Traffic Monitor is also responsible for serving the overall CDN configuration to Traffic Router, which ensures that the configuration of these two critical components remain synchronized as operational and health related changes propagate through the CDN.
+
+
+.. _rl-astats:
+
+|arrow| Cache Monitoring
+-------------------------
+ Traffic Monitor polls all caches configured with a status of ``REPORTED`` or ``ADMIN_DOWN`` at an interval specified as a configuration parameter in Traffic Ops. If the cache is set to ``ADMIN_DOWN`` it is marked as unavailable but still polled for availability and statistics. If the cache is explicitly configured with a status of ``ONLINE`` or ``OFFLINE``, it is not polled by Traffic Monitor and presented to Traffic Router as configured, regardless of actual availability.
+
+ Traffic Monitor makes HTTP requests at regular intervals to a special URL on each EDGE cache and consumes the JSON output. The special URL is a plugin running on the Apache Traffic Server (ATS) caches called astats, which is restricted to Traffic Monitor only. The astats plugin provides insight into application and system performance, such as:
+
+ - Throughput (e.g. bytes in, bytes out, etc).
+ - Transactions (e.g. number of 2xx, 3xx, 4xx responses, etc).
+ - Connections (e.g. from clients, to parents, origins, etc).
+ - Cache performance (e.g.: hits, misses, refreshes, etc).
+ - Storage performance (e.g.: writes, reads, frags, directories, etc).
+ - System performance (e.g: load average, network interface throughput, etc).
+
+ Many of the application level statistics are available at the global or aggregate level, some at the Delivery Service (remap rule) level. Traffic Monitor uses the system level performance to determine the overall health of the cache by evaluating network throughput and load against values configured in Traffic Ops. Traffic Monitor also uses throughput and transaction statistics at the remap rule level to determine Delivery Service health.
+
+If astats is unavailable due to a network related issue or the system statistics have exceeded the configured thresholds, Traffic Monitor will mark the cache as unavailable. If the delivery service statistics exceed the configured thresholds, the delivery service is marked as unavailable, and Traffic Router will start sending clients to the overflow destinations for that delivery service, but the cache remains available to serve other content,
+
+.. seealso:: For more information on ATS Statistics, see the `ATS documentation <https://docs.trafficserver.apache.org/en/latest/index.html>`_
+
+.. _rl-health-proto:
+
+|arrow| Health Protocol
+-----------------------
+ Redundant Traffic Monitor servers operate independently from each other but take the state of other Traffic Monitors into account when asked for health state information. In the above overview of cache monitoring, the behavior of Traffic Monitor pertains only to how an individual instance detects and handles failures. The Health Protocol adds another dimension to the health state of the CDN by merging the states of all Traffic Monitors into one, and then taking the *optimistic* approach when dealing with a cache or Delivery Service that might have been marked as unavailable by this particular instance or a peer instance of Traffic Monitor.
+
+ Upon startup or configuration change in Traffic Ops, in addition to caches, Traffic Monitor begins polling its peer Traffic Monitors whose state is set to ``ONLINE``. Each ``ONLINE`` Traffic Monitor polls all of its peers at a configurable interval and saves the peer's state for later use. When polling its peers, Traffic Monitor asks for the raw health state from each respective peer, which is strictly that instance's view of the CDN's health. When any ``ONLINE`` Traffic Monitor is asked for CDN health by an upstream component, such as Traffic Router, the component gets the health protocol influenced version of CDN health (non-raw view).
+
+ In operation of the health protocol, Traffic Monitor takes all health states from all peers, including the locally known health state, and serves an optimistic outlook to the requesting client. This means that, for example, if three of the four Traffic Monitors see a given cache or Delivery Service as exceeding its thresholds and unavailable, it is still considered available. Only if all Traffic Monitors agree that the given object is unavailable is that state propagated to upstream components. This optimistic approach to the Health Protocol is counter to the "fail fast" philosophy, but serves well for large networks with complicated geography and or routing. The optimistic Health Protocol allows network failures or latency to occur without affecting overall traffic routing, as Traffic Monitors can and do have a different view of the network when deployed in geographically diverse locations. Short polling intervals of both the caches and Traffic Monitor peers help to reduce custom
er impact of outages.
+
+It is not uncommon for a cache to be marked unavailable by Traffic Monitor - in fact, it is business as usual for many CDNs. A hot video asset may cause a single cache (say cache-03) to get close to it's interface capacity, the health protocol "kicks in", and Traffic Monitor marks cache-03 as unavailable. New clients want to see the same asset, and now, Traffic Router will send these customers to another cache (say cache-01) in the same cachegroup. The load is now shared between cache-01 and cache-03. As clients finish watching the asset on cache-03, it will drop below the threshold and gets marked available again, and new clients will now go back to cache-03 again.
+
+It is less common for a delivery service to be marked unavailable by Traffic Monitor, the delivery service thresholds are usually used for overflow situations at extreme peaks to protect other delivery services in the CDN from getting impacted.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_ops.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_ops.rst.txt b/docs/latest/_sources/overview/traffic_ops.rst.txt
deleted file mode 100644
index 9cc72ee..0000000
--- a/docs/latest/_sources/overview/traffic_ops.rst.txt
+++ /dev/null
@@ -1,39 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. |arrow| image:: fwda.png
-
-Traffic Ops
-===========
-Traffic Ops is the tool for administration (configuration and monitoring) of all components in a Traffic Control CDN. The CDN administrator uses Traffic Ops to manage servers, cache groups, delivery services, etc. In many cases, a configuration change requires propagation to several, or even all, caches and only explicitly after or before the same change propagates to Traffic Router. Traffic Ops takes care of this required consistency between the different components and their configuration. Traffic Ops exposes its data through a series of HTTP APIs and has a user interface that is interactive and viewable using a standard web browser.
-
-Traffic Ops uses a MySQL or PostgreSQL database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ to generate the user interface and APIs. Not all configuration data is in this database however; for sensitive data, like SSL private keys or token based authentication shared secrets, a separate key-value store is used, allowing the operator to harden the server that runs this key-value store better from a security perspective (i.e only allow Traffic Ops access it with a cert). The Traffic Ops server, by design, needs to be accessible from all the other servers in the Traffic Control CDN.
-
-Traffic Ops generates all the application specific configuration files for the caches and other servers. The caches and other servers check in with Traffic Ops at a regular interval (default 15 minutes) to see if updated configuration files require application.
-
-Traffic Ops also runs a collection of periodic checks to determine the operational readiness of the caches. These periodic checks are customizable by the Traffic Ops admin using extensions.
-
-|
-
-.. _rl-trops-ext:
-
-|arrow| Traffic Ops Extension
------------------------------
- Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are three types of extensions:
-
- * Check Extensions - Allows you to add custom checks to the "Health->Server Checks" view.
- * Configuration Extension - Allows you to add custom configuration file generators.
- * Data source Extensions - Allows you to add data sources for the graph views and usage APIs.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_ops.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_ops.txt b/docs/latest/_sources/overview/traffic_ops.txt
new file mode 100644
index 0000000..9cc72ee
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_ops.txt
@@ -0,0 +1,39 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. |arrow| image:: fwda.png
+
+Traffic Ops
+===========
+Traffic Ops is the tool for administration (configuration and monitoring) of all components in a Traffic Control CDN. The CDN administrator uses Traffic Ops to manage servers, cache groups, delivery services, etc. In many cases, a configuration change requires propagation to several, or even all, caches and only explicitly after or before the same change propagates to Traffic Router. Traffic Ops takes care of this required consistency between the different components and their configuration. Traffic Ops exposes its data through a series of HTTP APIs and has a user interface that is interactive and viewable using a standard web browser.
+
+Traffic Ops uses a MySQL or PostgreSQL database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ to generate the user interface and APIs. Not all configuration data is in this database however; for sensitive data, like SSL private keys or token based authentication shared secrets, a separate key-value store is used, allowing the operator to harden the server that runs this key-value store better from a security perspective (i.e only allow Traffic Ops access it with a cert). The Traffic Ops server, by design, needs to be accessible from all the other servers in the Traffic Control CDN.
+
+Traffic Ops generates all the application specific configuration files for the caches and other servers. The caches and other servers check in with Traffic Ops at a regular interval (default 15 minutes) to see if updated configuration files require application.
+
+Traffic Ops also runs a collection of periodic checks to determine the operational readiness of the caches. These periodic checks are customizable by the Traffic Ops admin using extensions.
+
+|
+
+.. _rl-trops-ext:
+
+|arrow| Traffic Ops Extension
+-----------------------------
+ Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are three types of extensions:
+
+ * Check Extensions - Allows you to add custom checks to the "Health->Server Checks" view.
+ * Configuration Extension - Allows you to add custom configuration file generators.
+ * Data source Extensions - Allows you to add data sources for the graph views and usage APIs.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_portal.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_portal.rst.txt b/docs/latest/_sources/overview/traffic_portal.rst.txt
deleted file mode 100644
index 20325e4..0000000
--- a/docs/latest/_sources/overview/traffic_portal.rst.txt
+++ /dev/null
@@ -1,43 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. index::
- Traffic Portal - Overview
-
-Traffic Portal
-==============
-Traffic Portal is an `AngularJS 1.x <https://angularjs.org/>`_ client served from a `Node.js <https://nodejs.org/en/>`_ web server designed to consume the Traffic Ops 1.x API. Traffic Portal provides a set of functionality restricted to the delivery service(s) of the authenticated user. Functionality primarily includes a set of charts / graphs designed to provide insight into the performance of a user's delivery service(s).
-
-Charts / Graphs include:
-
- - Overall Cache Group Status
- - Delivery Service Bandwidth Per Second
- - Delivery Service Transactions Per Second
- - Delivery Service HTTP Status By Class
- - Delivery Service Capacity
- - Delivery Service Routing Methods
- - Delivery Service Cache Group Status
-
-Other features:
-
- - Ability to manager user profile
- - Ability to reset user password
- - Ability to view delivery service configuration
- - Ability to invalidate content for a delivery service
- - Ability to retrieve all caches associated with a delivery service
- - Ability to request a new delivery service
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/overview/traffic_portal.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/overview/traffic_portal.txt b/docs/latest/_sources/overview/traffic_portal.txt
new file mode 100644
index 0000000..20325e4
--- /dev/null
+++ b/docs/latest/_sources/overview/traffic_portal.txt
@@ -0,0 +1,43 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. index::
+ Traffic Portal - Overview
+
+Traffic Portal
+==============
+Traffic Portal is an `AngularJS 1.x <https://angularjs.org/>`_ client served from a `Node.js <https://nodejs.org/en/>`_ web server designed to consume the Traffic Ops 1.x API. Traffic Portal provides a set of functionality restricted to the delivery service(s) of the authenticated user. Functionality primarily includes a set of charts / graphs designed to provide insight into the performance of a user's delivery service(s).
+
+Charts / Graphs include:
+
+ - Overall Cache Group Status
+ - Delivery Service Bandwidth Per Second
+ - Delivery Service Transactions Per Second
+ - Delivery Service HTTP Status By Class
+ - Delivery Service Capacity
+ - Delivery Service Routing Methods
+ - Delivery Service Cache Group Status
+
+Other features:
+
+ - Ability to manager user profile
+ - Ability to reset user password
+ - Ability to view delivery service configuration
+ - Ability to invalidate content for a delivery service
+ - Ability to retrieve all caches associated with a delivery service
+ - Ability to request a new delivery service
+
+
+
[11/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/basics/caching_proxies.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/caching_proxies.html b/docs/latest/basics/caching_proxies.html
index 801c457..ec52c8e 100644
--- a/docs/latest/basics/caching_proxies.html
+++ b/docs/latest/basics/caching_proxies.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Caching Proxies — Traffic Control 1.8.1 documentation </title>
+ <title>Caching Proxies — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="CDN Basics" href="index.html"/>
<link rel="next" title="Cache Control Headers and Revalidation" href="cache_revalidation.html"/>
<link rel="prev" title="HTTP 1.1" href="http_11.html"/>
@@ -85,7 +82,7 @@
<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Caching Proxies</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
</ul>
</li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">CDN Basics</a> »</li>
<li>Caching Proxies</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/caching_proxies.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/caching_proxies.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -225,16 +222,16 @@ cache is: <code class="docutils literal"><span class="pre">http://www-origin-cac
<p class="first admonition-title">Note</p>
<p class="last">In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.</p>
</div>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-
-<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Date: Sun, 14 Dec 2014 23:22:44 GMT
+Server: Apache/2.2.15 (Red Hat)
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50a3559482cc0"
+Content-Length: 45
+Connection: close
+Content-Type: text/html; charset=UTF-8
+
+<html><body>This is a fun file</body></html>
</pre></div>
</div>
<p>The client is given the URL <code class="docutils literal"><span class="pre">http://www-origin-cache.cdn.com/foo/bar/fun.html</span></code> (note the different hostname) and when attempting to obtain that URL, the following occurs:</p>
@@ -244,8 +241,8 @@ cache is: <code class="docutils literal"><span class="pre">http://www-origin-cac
<li><p class="first">Similar to the previous case, the LDNS server resolves the name <code class="docutils literal"><span class="pre">www-origin-cache.cdn.com</span></code> to an IPv4 address, in this example, this address is 55.44.33.22.</p>
</li>
<li><p class="first">The client opens a TCP connection from a random port locally, to port 80 (the HTTP default) on 55.44.33.22, and sends the following:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
-<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">-</span><span class="n">origin</span><span class="o">-</span><span class="n">cache</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span>
+<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
+Host: www-origin-cache.cdn.com
</pre></div>
</div>
</li>
@@ -258,38 +255,38 @@ cache is: <code class="docutils literal"><span class="pre">http://www-origin-cac
<blockquote>
<div><ol class="arabic">
<li><p class="first">The proxy uses DNS to get the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connect to it on port 80, and sends:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
-<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
+<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
+Host: www.origin.com
</pre></div>
</div>
</li>
<li><p class="first">The origin server responds with the headers and content as shown:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-
-<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Date: Sun, 14 Dec 2014 23:22:44 GMT
+Server: Apache/2.2.15 (Red Hat)
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50a3559482cc0"
+Content-Length: 45
+Connection: close
+Content-Type: text/html; charset=UTF-8
+
+<html><body>This is a fun file</body></html>
</pre></div>
</div>
</li>
<li><p class="first">The proxy sends the origin response on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-<span class="n">Age</span><span class="p">:</span> <span class="mi">0</span>
-<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
-
- <span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Date: Sun, 14 Dec 2014 23:22:44 GMT
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50a3559482cc0"
+Content-Length: 45
+Connection: close
+Content-Type: text/html; charset=UTF-8
+Age: 0
+Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+Server: ATS/4.2.1
+
+ <html><body>This is a fun file</body></html>
</pre></div>
</div>
</li>
@@ -298,18 +295,18 @@ cache is: <code class="docutils literal"><span class="pre">http://www-origin-cac
<p>6b. If it <em>is</em> in the cache:</p>
<blockquote>
<div><p>The proxy responds to the client with the previously retrieved result:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-<span class="n">Age</span><span class="p">:</span> <span class="mi">39711</span>
-<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
-
-<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Date: Sun, 14 Dec 2014 23:22:44 GMT
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50a3559482cc0"
+Content-Length: 45
+Connection: close
+Content-Type: text/html; charset=UTF-8
+Age: 39711
+Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+Server: ATS/4.2.1
+
+<html><body>This is a fun file</body></html>
</pre></div>
</div>
</div></blockquote>
@@ -334,7 +331,7 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote>
<li>To retrieve <code class="docutils literal"><span class="pre">http://www.origin.com/foo/bar/fun.html</span></code> URL, the client connects to 99.88.77.66 on port 8080 and sends:</li>
</ol>
<blockquote>
-<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
+<div><div class="highlight-python"><div class="highlight"><pre>GET http://www.origin.com/foo/bar/fun.html HTTP/1.1
</pre></div>
</div>
<div class="admonition note">
@@ -349,38 +346,38 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote>
<blockquote>
<div><ol class="arabic">
<li><p class="first">The proxy uses DNS to obtain the IPv4 address for <code class="docutils literal"><span class="pre">www.origin.com</span></code>, connects to it on port 80, and sends:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
-<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
+<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
+Host: www.origin.com
</pre></div>
</div>
</li>
<li><p class="first">The origin server responds with the headers and content as shown below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">Apache</span><span class="o">/</span><span class="mf">2.2</span><span class="o">.</span><span class="mi">15</span> <span class="p">(</span><span class="n">Red</span> <span class="n">Hat</span><span class="p">)</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-
-<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Date: Sun, 14 Dec 2014 23:22:44 GMT
+Server: Apache/2.2.15 (Red Hat)
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50a3559482cc0"
+Content-Length: 45
+Connection: close
+Content-Type: text/html; charset=UTF-8
+
+<html><body>This is a fun file</body></html>
</pre></div>
</div>
</li>
<li><p class="first">The proxy sends this on to the client adding a <code class="docutils literal"><span class="pre">Via:</span></code> header (and maybe others):</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-<span class="n">Age</span><span class="p">:</span> <span class="mi">0</span>
-<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
-
-<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Date: Sun, 14 Dec 2014 23:22:44 GMT
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50a3559482cc0"
+Content-Length: 45
+Connection: close
+Content-Type: text/html; charset=UTF-8
+Age: 0
+Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+Server: ATS/4.2.1
+
+<html><body>This is a fun file</body></html>
</pre></div>
</div>
</li>
@@ -389,18 +386,18 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote>
<p>4b. If it <em>is</em> in the cache:</p>
<blockquote>
<div><p>The proxy responds to the client with the previously retrieved result:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Date</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">22</span><span class="p">:</span><span class="mi">44</span> <span class="n">GMT</span>
-<span class="n">Last</span><span class="o">-</span><span class="n">Modified</span><span class="p">:</span> <span class="n">Sun</span><span class="p">,</span> <span class="mi">14</span> <span class="n">Dec</span> <span class="mi">2014</span> <span class="mi">23</span><span class="p">:</span><span class="mi">18</span><span class="p">:</span><span class="mi">51</span> <span class="n">GMT</span>
-<span class="n">ETag</span><span class="p">:</span> <span class="s2">"1aa008f-2d-50a3559482cc0"</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
-<span class="n">Connection</span><span class="p">:</span> <span class="n">close</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-<span class="n">Age</span><span class="p">:</span> <span class="mi">99711</span>
-<span class="n">Via</span><span class="p">:</span> <span class="n">http</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">cache01</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">kabletown</span><span class="o">.</span><span class="n">net</span> <span class="p">(</span><span class="n">ApacheTrafficServer</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span> <span class="p">[</span><span class="n">uScSsSfUpSeN</span><span class="p">:</span><span class="n">t</span> <span class="n">cCSi</span> <span class="n">p</span> <span class="n">sS</span><span class="p">])</span>
-<span class="n">Server</span><span class="p">:</span> <span class="n">ATS</span><span class="o">/</span><span class="mf">4.2</span><span class="o">.</span><span class="mi">1</span>
-
-<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Date: Sun, 14 Dec 2014 23:22:44 GMT
+Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ETag: "1aa008f-2d-50a3559482cc0"
+Content-Length: 45
+Connection: close
+Content-Type: text/html; charset=UTF-8
+Age: 99711
+Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+Server: ATS/4.2.1
+
+<html><body>This is a fun file</body></html>
</pre></div>
</div>
</div></blockquote>
@@ -450,7 +447,7 @@ client obtains, and is unaware of the proxy in the middle.</div></blockquote>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/basics/content_delivery_networks.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/content_delivery_networks.html b/docs/latest/basics/content_delivery_networks.html
index 85a644e..c6c83f0 100644
--- a/docs/latest/basics/content_delivery_networks.html
+++ b/docs/latest/basics/content_delivery_networks.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Content Delivery Networks — Traffic Control 1.8.1 documentation </title>
+ <title>Content Delivery Networks — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="CDN Basics" href="index.html"/>
<link rel="next" title="HTTP 1.1" href="http_11.html"/>
<link rel="prev" title="CDN Basics" href="index.html"/>
@@ -83,7 +80,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Content Delivery Networks</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">CDN Basics</a> »</li>
<li>Content Delivery Networks</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/content_delivery_networks.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/content_delivery_networks.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -190,30 +187,35 @@
<div class="section" id="content-delivery-networks">
<span id="index-0"></span><h1>Content Delivery Networks<a class="headerlink" href="#content-delivery-networks" title="Permalink to this headline">¶</a></h1>
<p>The vast majority of today’s Internet traffic is media files (often video or audio) being sent from a single source (the <em>Content Provider</em>) to many thousands or even millions of destinations (the <em>Content Consumers</em>). Content Delivery Networks are the technology that make that one-to-many distribution possible in an economical way. A Content Delivery Network (CDN) is a distributed system of servers for delivering content over HTTP. These servers are deployed in multiple locations with the goal of optimizing the delivery of content to the end users, while minimizing the traffic on the network. A CDN typically consists of the following:</p>
-<ul class="simple">
+<ul>
<li><dl class="first docutils">
<dt><strong>Caching Proxies</strong></dt>
-<dd>The proxy (cache or caching proxy) is a server that both proxies the requests and caches the results for reusing.</dd>
+<dd><p class="first last">The proxy (cache or caching proxy) is a server that both proxies the requests and caches the results for reusing.</p>
+</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Content Router</strong></dt>
-<dd>The Content Router ensures that the end user is connected to the optimal cache for the location of the end user and content availability.</dd>
+<dd><p class="first last">The Content Router ensures that the end user is connected to the optimal cache for the location of the end user and content availability.</p>
+</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Health Protocol</strong></dt>
-<dd>The Health Protocol monitors the usage of the caches and tenants in the CDN.</dd>
+<dd><p class="first last">The Health Protocol monitors the usage of the caches and tenants in the CDN.</p>
+</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Configuration Management System</strong></dt>
-<dd>In many cases a CDN encompasses hundreds of servers across a large geographic area. The Configuration Management System allows an operator to manage these servers.</dd>
+<dd><p class="first last">In many cases a CDN encompasses hundreds of servers across a large geographic area. The Configuration Management System allows an operator to manage these servers.</p>
+</dd>
</dl>
</li>
<li><dl class="first docutils">
<dt><strong>Log File Analysis System</strong></dt>
-<dd>Every transaction in the CDN gets logged. The Log File Analysis System aggregates all of the log entries from all of the servers to a central location for analysis and troubleshooting.</dd>
+<dd><p class="first last">Every transaction in the CDN gets logged. The Log File Analysis System aggregates all of the log entries from all of the servers to a central location for analysis and troubleshooting.</p>
+</dd>
</dl>
</li>
</ul>
@@ -257,7 +259,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/basics/http_11.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/http_11.html b/docs/latest/basics/http_11.html
index 9d1fb0f..79793f8 100644
--- a/docs/latest/basics/http_11.html
+++ b/docs/latest/basics/http_11.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>HTTP 1.1 — Traffic Control 1.8.1 documentation </title>
+ <title>HTTP 1.1 — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="CDN Basics" href="index.html"/>
<link rel="next" title="Caching Proxies" href="caching_proxies.html"/>
<link rel="prev" title="Content Delivery Networks" href="content_delivery_networks.html"/>
@@ -84,7 +81,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">CDN Basics</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">HTTP 1.1</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
<li class="toctree-l2"><a class="reference internal" href="cache_revalidation.html">Cache Control Headers and Revalidation</a></li>
</ul>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">CDN Basics</a> »</li>
<li>HTTP 1.1</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/http_11.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/http_11.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -204,17 +201,17 @@
</div></blockquote>
<ol class="arabic" start="3">
<li><p class="first">The client opens a TCP connection from a random port locally to port 80 (the HTTP default) on 44.33.22.11, and sends this (showing the minimum HTTP 1.1 request, typically there are additional headers):</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">GET</span> <span class="o">/</span><span class="n">foo</span><span class="o">/</span><span class="n">bar</span><span class="o">/</span><span class="n">fun</span><span class="o">.</span><span class="n">html</span> <span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span>
-<span class="n">Host</span><span class="p">:</span> <span class="n">www</span><span class="o">.</span><span class="n">origin</span><span class="o">.</span><span class="n">com</span>
+<div class="highlight-python"><div class="highlight"><pre>GET /foo/bar/fun.html HTTP/1.1
+Host: www.origin.com
</pre></div>
</div>
</li>
<li><p class="first">The server at <code class="docutils literal"><span class="pre">www.origin.com</span></code> looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path <code class="docutils literal"><span class="pre">/foo/bar/fun.html</span></code>, in the example, this is a file that contains <code class="docutils literal"><span class="pre"><html><body>This</span> <span class="pre">is</span> <span class="pre">a</span> <span class="pre">fun</span> <span class="pre">file</body></html></span></code>, so the server responds with the following:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span> <span class="n">text</span><span class="o">/</span><span class="n">html</span><span class="p">;</span> <span class="n">charset</span><span class="o">=</span><span class="n">UTF</span><span class="o">-</span><span class="mi">8</span>
-<span class="n">Content</span><span class="o">-</span><span class="n">Length</span><span class="p">:</span> <span class="mi">45</span>
+<div class="highlight-python"><div class="highlight"><pre>HTTP/1.1 200 OK
+Content-Type: text/html; charset=UTF-8
+Content-Length: 45
-<span class="o"><</span><span class="n">html</span><span class="o">><</span><span class="n">body</span><span class="o">></span><span class="n">This</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">fun</span> <span class="n">file</span><span class="o"></</span><span class="n">body</span><span class="o">></</span><span class="n">html</span><span class="o">></span>
+<html><body>This is a fun file</body></html>
</pre></div>
</div>
</li>
@@ -261,7 +258,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/basics/index.html
----------------------------------------------------------------------
diff --git a/docs/latest/basics/index.html b/docs/latest/basics/index.html
index d3427a1..7f7ceab 100644
--- a/docs/latest/basics/index.html
+++ b/docs/latest/basics/index.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>CDN Basics — Traffic Control 1.8.1 documentation </title>
+ <title>CDN Basics — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="next" title="Content Delivery Networks" href="content_delivery_networks.html"/>
<link rel="prev" title="Traffic Control" href="../index.html"/>
@@ -81,7 +78,7 @@
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">CDN Basics</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="">CDN Basics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="content_delivery_networks.html">Content Delivery Networks</a></li>
<li class="toctree-l2"><a class="reference internal" href="http_11.html">HTTP 1.1</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_proxies.html">Caching Proxies</a></li>
@@ -161,12 +158,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li>CDN Basics</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/basics/index.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/basics/index.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -240,7 +237,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/index.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/index.html b/docs/latest/development/index.html
index 0c9164b..553674d 100644
--- a/docs/latest/development/index.html
+++ b/docs/latest/development/index.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Developer’s Guide — Traffic Control 1.8.1 documentation </title>
+ <title>Developer’s Guide — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="next" title="Traffic Ops" href="traffic_ops.html"/>
<link rel="prev" title="Configure Delivery Service Steering" href="../admin/quick_howto/steering.html"/>
@@ -119,7 +116,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Developer’s Guide</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Developer’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
@@ -161,12 +158,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li>Developer’s Guide</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/index.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/index.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -282,7 +279,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_monitor.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_monitor.html b/docs/latest/development/traffic_monitor.html
index 91356e2..959832c 100644
--- a/docs/latest/development/traffic_monitor.html
+++ b/docs/latest/development/traffic_monitor.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Monitor — Traffic Control 1.8.1 documentation </title>
+ <title>Traffic Monitor — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Developer’s Guide" href="index.html"/>
<link rel="next" title="Traffic Monitor APIs" href="traffic_monitor/traffic_monitor_api.html"/>
<link rel="prev" title="Traffic Router API" href="traffic_router/traffic_router_api.html"/>
@@ -124,7 +121,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops.html">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Monitor</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server</a></li>
</ul>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Developer’s Guide</a> »</li>
<li>Traffic Monitor</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/traffic_monitor.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/traffic_monitor.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -321,7 +318,7 @@
</div>
<div class="section" id="api">
<h2>API<a class="headerlink" href="#api" title="Permalink to this headline">¶</a></h2>
-<p><a class="reference internal" href="traffic_monitor/traffic_monitor_api.html#reference-tm-api"><span class="std std-ref">Traffic Monitor APIs</span></a></p>
+<p><a class="reference internal" href="traffic_monitor/traffic_monitor_api.html#reference-tm-api"><em>Traffic Monitor APIs</em></a></p>
<div class="toctree-wrapper compound">
</div>
</div>
@@ -365,7 +362,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_monitor/traffic_monitor_api.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_monitor/traffic_monitor_api.html b/docs/latest/development/traffic_monitor/traffic_monitor_api.html
index 7d9392c..05152ce 100644
--- a/docs/latest/development/traffic_monitor/traffic_monitor_api.html
+++ b/docs/latest/development/traffic_monitor/traffic_monitor_api.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Monitor APIs — Traffic Control 1.8.1 documentation </title>
+ <title>Traffic Monitor APIs — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../genindex.html"/>
- <link rel="search" title="Search" href="../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../index.html"/>
<link rel="up" title="Traffic Monitor" href="../traffic_monitor.html"/>
<link rel="next" title="Traffic Stats" href="../traffic_stats.html"/>
<link rel="prev" title="Traffic Monitor" href="../traffic_monitor.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Traffic Monitor APIs</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/development/traffic_monitor/traffic_monitor_api.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/development/traffic_monitor/traffic_monitor_api.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -478,7 +475,7 @@ treated as partial strings.</td>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops.html b/docs/latest/development/traffic_ops.html
index d23644a..340c5e8 100644
--- a/docs/latest/development/traffic_ops.html
+++ b/docs/latest/development/traffic_ops.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Ops — Traffic Control 1.8.1 documentation </title>
+ <title>Traffic Ops — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Developer’s Guide" href="index.html"/>
<link rel="next" title="API Routes" href="traffic_ops_api/routes.html"/>
<link rel="prev" title="Developer’s Guide" href="index.html"/>
@@ -121,7 +118,7 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Developer’s Guide</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Developer’s Guide</a> »</li>
<li>Traffic Ops</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/development/traffic_ops.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/development/traffic_ops.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -267,7 +264,7 @@
<div class="section" id="perl-formatting-conventions">
<h2>Perl Formatting Conventions<a class="headerlink" href="#perl-formatting-conventions" title="Permalink to this headline">¶</a></h2>
<p>Perl tidy is for use in code formatting. See the following config file for formatting conventions.</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>edit a file called $HOME/.perltidyrc
+<div class="highlight-python"><div class="highlight"><pre>edit a file called $HOME/.perltidyrc
-l=156
-et=4
@@ -353,7 +350,7 @@ environment.</td>
<li>Install the local dependencies using Carton (cpanfile).</li>
</ol>
<blockquote>
-<div><div class="highlight-default"><div class="highlight"><pre><span></span>$ cd traffic_ops/app
+<div><div class="highlight-python"><div class="highlight"><pre>$ cd traffic_ops/app
$ carton
</pre></div>
</div>
@@ -363,7 +360,7 @@ $ carton
</ol>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>master $ mysql
+<div class="highlight-python"><div class="highlight"><pre>master $ mysql
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 305
Server version: 5.6.19 Homebrew
@@ -394,7 +391,7 @@ mysql> grant all on to_integration.* to 'to_user'@'localhost'
<div class="line"><br /></div>
</div>
<p>Running the the admin.pl script in setup mode should look like this:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>master $ db/admin.pl --env=development setup
+<div class="highlight-python"><div class="highlight"><pre>master $ db/admin.pl --env=development setup
Using database.conf: conf/development/database.conf
Using database.conf: conf/development/database.conf
Using database.conf: conf/development/database.conf
@@ -427,9 +424,9 @@ Warning: Using a password on the command line interface can be insecure.
</li>
</ol>
<blockquote>
-<div><div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="mi">2015</span><span class="o">-</span><span class="mi">02</span><span class="o">-</span><span class="mi">24</span> <span class="mi">10</span><span class="p">:</span><span class="mi">44</span><span class="p">:</span><span class="mi">34</span><span class="p">,</span><span class="mi">991</span><span class="p">]</span> <span class="p">[</span><span class="n">INFO</span><span class="p">]</span> <span class="n">Listening</span> <span class="n">at</span> <span class="s2">"http://*:3000"</span><span class="o">.</span>
+<div><div class="highlight-python"><div class="highlight"><pre>[2015-02-24 10:44:34,991] [INFO] Listening at "http://*:3000".
-<span class="n">Server</span> <span class="n">available</span> <span class="n">at</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="mf">127.0</span><span class="o">.</span><span class="mf">0.1</span><span class="p">:</span><span class="mf">3000.</span>
+Server available at http://127.0.0.1:3000.
</pre></div>
</div>
</div></blockquote>
@@ -451,7 +448,7 @@ Warning: Using a password on the command line interface can be insecure.
<h2>Test Cases<a class="headerlink" href="#test-cases" title="Permalink to this headline">¶</a></h2>
<p>Use prove to execute test cases. Execute after a carton install:</p>
<ul class="simple">
-<li>To run the Unit Tests: <code class="docutils literal"><span class="pre">$</span> <span class="pre">local/bin/prove</span> <span class="pre">-qrp</span>  <span class="pre">t/</span></code></li>
+<li>To run the Unit Tests: <code class="docutils literal"><span class="pre">$</span> <span class="pre">local/bin/prove</span> <span class="pre">-qrp</span> <span class="pre">t/</span></code></li>
<li>To run the Integration Tests: <code class="docutils literal"><span class="pre">$</span> <span class="pre">local/bin/prove</span> <span class="pre">-qrp</span> <span class="pre">t_integration/</span></code></li>
</ul>
<div class="section" id="the-kabletown-cdn-example">
@@ -489,14 +486,14 @@ Warning: Using a password on the command line interface can be insecure.
</ol>
<blockquote>
<div>These allow you to add statistic sources for the graph views and APIs.</div></blockquote>
-<p>Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see <a class="reference internal" href="../admin/traffic_ops_extensions.html#admin-to-ext-script"><span class="std std-ref">Managing Traffic Ops Extensions</span></a>.</p>
+<p>Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see <a class="reference internal" href="../admin/traffic_ops_extensions.html#admin-to-ext-script"><em>Managing Traffic Ops Extensions</em></a>.</p>
<div class="section" id="check-extensions">
<h3>Check Extensions<a class="headerlink" href="#check-extensions" title="Permalink to this headline">¶</a></h3>
<p>In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the “Health->Server Checks” view and that usually run periodically out of cron.</p>
<p>It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results.</p>
<p>An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops’ <code class="docutils literal"><span class="pre">/api/1.1/servers.json</span></code> REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops <code class="docutils literal"><span class="pre">/api/1.1/servercheck/</span></code> target.</p>
<p>A check extension can have a column of <img alt="checkmark" src="../_images/good1.png" />‘s and <img alt="X" src="../_images/bad1.png" />‘s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Script</span> <span class="n">here</span><span class="o">.</span>
+<div class="highlight-python"><div class="highlight"><pre>Script here.
</pre></div>
</div>
<p>Check Extension scripts are located in the $TO_HOME/bin/checks directory.</p>
@@ -511,7 +508,7 @@ Warning: Using a password on the command line interface can be insecure.
<dt><strong>Maximum Transmission Check - MTU</strong></dt>
<dd>Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the <code class="docutils literal"><span class="pre">ip_address</span></code> of the server in the server table.</dd>
<dt><strong>Operational Readiness Check - ORT</strong></dt>
-<dd>See <a class="reference internal" href="../admin/traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a> for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.</dd>
+<dd>See <a class="reference internal" href="../admin/traffic_server.html#reference-traffic-ops-ort"><em>Configuring Traffic Server</em></a> for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.</dd>
<dt><strong>Ping Check - 10G, ILO, 10G6, FQDN</strong></dt>
<dd><p class="first">The bin/checks/ToPingCheck.pl is to check basic IP connectivity, and in the default setup it checks IP connectivity to the following:</p>
<dl class="last docutils">
@@ -544,7 +541,7 @@ Warning: Using a password on the command line interface can be insecure.
<div class="section" id="extension-directories">
<h3>Extension Directories<a class="headerlink" href="#extension-directories" title="Permalink to this headline">¶</a></h3>
<p>PERL5LIB Example Configuration:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">export</span> <span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops_extensions</span><span class="o">/</span><span class="n">private</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">Extensions</span><span class="o">/</span><span class="n">TrafficStats</span>
+<div class="highlight-python"><div class="highlight"><pre>export PERL5LIB=/opt/traffic_ops_extensions/private/lib/Extensions:/opt/traffic_ops/app/lib/Extensions/TrafficStats
</pre></div>
</div>
</div>
@@ -571,9 +568,9 @@ Extensions::YourCustomExtension</p>
<div class="section" id="response-structure">
<h3>Response Structure<a class="headerlink" href="#response-structure" title="Permalink to this headline">¶</a></h3>
<p>All successful responses have the following structure:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="o"><</span><span class="n">JSON</span> <span class="nb">object</span> <span class="k">with</span> <span class="n">main</span> <span class="n">response</span><span class="o">></span><span class="p">,</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": <JSON object with main response>,
+}
</pre></div>
</div>
<p>To make the documentation easier to read, only the <code class="docutils literal"><span class="pre"><JSON</span> <span class="pre">object</span> <span class="pre">with</span> <span class="pre">main</span> <span class="pre">response></span></code> is documented, even though the response and version fields are always present.</p>
@@ -586,7 +583,7 @@ Extensions::YourCustomExtension</p>
<li>Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.</li>
</ol>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+<div class="highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
{"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
[jvd@laika ~]$
[jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login
@@ -661,7 +658,7 @@ Extensions::YourCustomExtension</p>
<dl class="docutils">
<dt>401 Unauthorized</dt>
<dd><p class="first">When you don’t supply the right cookie, this is the response.</p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+<div class="last highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
* Hostname was NOT found in DNS cache
* Trying ::1...
* connect to ::1 port 3000 failed: Connection refused
@@ -693,7 +690,7 @@ Extensions::YourCustomExtension</p>
</dd>
<dt>404 Not Found</dt>
<dd><p class="first">When the resource (path) is non existent Traffic Ops returns a 404:</p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
+<div class="last highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
* Hostname was NOT found in DNS cache
* Trying ::1...
* connect to ::1 port 3000 failed: Connection refused
@@ -727,7 +724,7 @@ Extensions::YourCustomExtension</p>
</dd>
<dt>500 Internal Server Error</dt>
<dd><p class="first">When you are asking for a correct path, but the database doesn’t match, it returns a 500:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
+<div class="highlight-python"><div class="highlight"><pre>[jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
* Hostname was NOT found in DNS cache
* Trying ::1...
* connect to ::1 port 3000 failed: Connection refused
@@ -868,7 +865,7 @@ Extensions::YourCustomExtension</p>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/routes.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/routes.html b/docs/latest/development/traffic_ops_api/routes.html
index 64a1df3..918ee17 100644
--- a/docs/latest/development/traffic_ops_api/routes.html
+++ b/docs/latest/development/traffic_ops_api/routes.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>API Routes — Traffic Control 1.8.1 documentation </title>
+ <title>API Routes — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../genindex.html"/>
- <link rel="search" title="Search" href="../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../index.html"/>
<link rel="up" title="Traffic Ops" href="../traffic_ops.html"/>
<link rel="next" title="ASN" href="v11/asn.html"/>
<link rel="prev" title="Traffic Ops" href="../traffic_ops.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>API Routes</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/development/traffic_ops_api/routes.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/development/traffic_ops_api/routes.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -227,16 +224,16 @@ table.docutils col:nth-child(3) {
</thead>
<tbody valign="top">
<tr class="row-even"><td>/asns</td>
-<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><span class="std std-ref">/api/1.1/asns</span></a></td>
-<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><span class="std std-ref">/api/1.2/asns</span></a></td>
+<td><a class="reference internal" href="v11/asn.html#to-api-v11-asns-route"><em>/api/1.1/asns</em></a></td>
+<td><a class="reference internal" href="v12/asn.html#to-api-v12-asns-route"><em>/api/1.2/asns</em></a></td>
</tr>
<tr class="row-odd"><td>/availableds</td>
-<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td>
-<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td>
+<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><em>/api/1.1/deliveryservices</em></a></td>
+<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><em>/api/1.2/deliveryservices</em></a></td>
</tr>
<tr class="row-even"><td><em>Not Implemented</em></td>
<td><em>Not Implemented</em></td>
-<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><span class="std std-ref">/api/1.2/cache_stats</span></a></td>
+<td><a class="reference internal" href="v12/cache_stats.html#to-api-v12-cache-stats-route"><em>/api/1.2/cache_stats</em></a></td>
</tr>
<tr class="row-odd"><td>/datacrans</td>
<td>/api/1.1/crans.json</td>
@@ -247,8 +244,8 @@ table.docutils col:nth-child(3) {
<td>/api/1.2/crans.json</td>
</tr>
<tr class="row-odd"><td>/datadeliveryservice</td>
-<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><span class="std std-ref">/api/1.1/deliveryservices</span></a></td>
-<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><span class="std std-ref">/api/1.2/deliveryservices</span></a></td>
+<td><a class="reference internal" href="v11/deliveryservice.html#to-api-v11-ds-route"><em>/api/1.1/deliveryservices</em></a></td>
+<td><a class="reference internal" href="v12/deliveryservice.html#to-api-v12-ds-route"><em>/api/1.2/deliveryservices</em></a></td>
</tr>
<tr class="row-even"><td>/datadeliveryserviceserver</td>
<td>/api/1.1/deliveryserviceserver.json</td>
@@ -260,11 +257,11 @@ table.docutils col:nth-child(3) {
</tr>
<tr class="row-even"><td><em>Not Implemented</em></td>
<td><em>Not Implemented</em></td>
-<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><span class="std std-ref">/api/1.2/deliveryservice_stats</span></a></td>
+<td><a class="reference internal" href="v12/deliveryservice_stats.html#to-api-v12-ds-stats-route"><em>/api/1.2/deliveryservice_stats</em></a></td>
</tr>
<tr class="row-odd"><td>/datahwinfo</td>
-<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><span class="std std-ref">/api/1.1/hwinfo</span></a></td>
-<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><span class="std std-ref">/api/1.2/hwinfo</span></a></td>
+<td><a class="reference internal" href="v11/hwinfo.html#to-api-v11-hwinfo-route"><em>/api/1.1/hwinfo</em></a></td>
+<td><a class="reference internal" href="v12/hwinfo.html#to-api-v12-hwinfo-route"><em>/api/1.2/hwinfo</em></a></td>
</tr>
<tr class="row-even"><td>/datalinks</td>
<td>/api/1.1/deliveryserviceserver.json</td>
@@ -275,86 +272,86 @@ table.docutils col:nth-child(3) {
<td>/api/1.2/deliveryserviceserver.json</td>
</tr>
<tr class="row-even"><td>/datalogs</td>
-<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><span class="std std-ref">/api/1.1/logs</span></a></td>
-<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><span class="std std-ref">/api/1.2/logs</span></a></td>
+<td><a class="reference internal" href="v11/changelog.html#to-api-v11-change-logs-route"><em>/api/1.1/logs</em></a></td>
+<td><a class="reference internal" href="v12/changelog.html#to-api-v12-change-logs-route"><em>/api/1.2/logs</em></a></td>
</tr>
<tr class="row-odd"><td>/datalocation/orderby/id</td>
-<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td>
-<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td>
+<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><em>/api/1.1/cachegroups</em></a></td>
+<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><em>/api/1.2/cachegroups</em></a></td>
</tr>
<tr class="row-even"><td>/datalocationparameters</td>
-<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><span class="std std-ref">/api/1.1/cachegroups</span></a></td>
-<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><span class="std std-ref">/api/1.2/cachegroups</span></a></td>
+<td><a class="reference internal" href="v11/cachegroup.html#to-api-v11-cachegroups-route"><em>/api/1.1/cachegroups</em></a></td>
+<td><a class="reference internal" href="v12/cachegroup.html#to-api-v12-cachegroups-route"><em>/api/1.2/cachegroups</em></a></td>
</tr>
<tr class="row-odd"><td>/dataparameter</td>
-<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><span class="std std-ref">/api/1.1/parameters</span></a></td>
-<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><span class="std std-ref">/api/1.2/parameters</span></a></td>
+<td><a class="reference internal" href="v11/parameter.html#to-api-v11-parameters-route"><em>/api/1.1/parameters</em></a></td>
+<td><a class="reference internal" href="v12/parameter.html#to-api-v12-parameters-route"><em>/api/1.2/parameters</em></a></td>
</tr>
<tr class="row-even"><td>/dataparameter/:parameter</td>
<td>/api/1.1/parameters/profile/:parameter.json</td>
<td>/api/1.2/parameters/profile/:parameter.json</td>
</tr>
<tr class="row-odd"><td>/dataphys_location</td>
-<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><span class="std std-ref">/api/1.1/phys_locations</span></a></td>
-<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><span class="std std-ref">/api/1.2/phys_locations</span></a></td>
+<td><a class="reference internal" href="v11/phys_location.html#to-api-v11-phys-loc-route"><em>/api/1.1/phys_locations</em></a></td>
+<td><a class="reference internal" href="v12/phys_location.html#to-api-v12-phys-loc-route"><em>/api/1.2/phys_locations</em></a></td>
</tr>
<tr class="row-even"><td><p class="first">/dataprofile</p>
<p class="last">/dataprofile/orderby/name</p>
</td>
-<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><span class="std std-ref">/api/1.1/profiles</span></a></td>
-<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><span class="std std-ref">/api/1.2/profiles</span></a></td>
+<td><a class="reference internal" href="v11/profile.html#to-api-v11-profiles-route"><em>/api/1.1/profiles</em></a></td>
+<td><a class="reference internal" href="v12/profile.html#to-api-v12-profiles-route"><em>/api/1.2/profiles</em></a></td>
</tr>
<tr class="row-odd"><td>/dataregion</td>
-<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><span class="std std-ref">/api/1.1/regions</span></a></td>
-<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><span class="std std-ref">/api/1.2/regions</span></a></td>
+<td><a class="reference internal" href="v11/region.html#to-api-v11-regions-route"><em>/api/1.1/regions</em></a></td>
+<td><a class="reference internal" href="v12/region.html#to-api-v12-regions-route"><em>/api/1.2/regions</em></a></td>
</tr>
<tr class="row-even"><td>/datarole</td>
-<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td>
-<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td>
+<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><em>/api/1.1/roles</em></a></td>
+<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><em>/api/1.2/roles</em></a></td>
</tr>
<tr class="row-odd"><td>/datarole/orderby/:field</td>
-<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><span class="std std-ref">/api/1.1/roles</span></a></td>
-<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><span class="std std-ref">/api/1.2/roles</span></a></td>
+<td><a class="reference internal" href="v11/role.html#to-api-v11-roles-route"><em>/api/1.1/roles</em></a></td>
+<td><a class="reference internal" href="v12/role.html#to-api-v12-roles-route"><em>/api/1.2/roles</em></a></td>
</tr>
<tr class="row-even"><td>/dataserver</td>
-<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td>
-<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td>
+<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><em>/api/1.1/servers</em></a></td>
+<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><em>/api/1.2/servers</em></a></td>
</tr>
<tr class="row-odd"><td>/dataserver/orderby/:field</td>
-<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><span class="std std-ref">/api/1.1/servers</span></a></td>
-<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><span class="std std-ref">/api/1.2/servers</span></a></td>
+<td><a class="reference internal" href="v11/server.html#to-api-v11-servers-route"><em>/api/1.1/servers</em></a></td>
+<td><a class="reference internal" href="v12/server.html#to-api-v12-servers-route"><em>/api/1.2/servers</em></a></td>
</tr>
<tr class="row-even"><td>/dataserverdetail/select/:hostname</td>
<td>/api/1.1/servers/hostname/:hostname/details.json</td>
<td>/api/1.2/servers/hostname/:hostname/details.json</td>
</tr>
<tr class="row-odd"><td>/datastaticdnsentry</td>
-<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><span class="std std-ref">/api/1.1/staticdnsentries</span></a></td>
-<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><span class="std std-ref">/api/1.2/staticdnsentries</span></a></td>
+<td><a class="reference internal" href="v11/static_dns.html#to-api-v11-static-dns-route"><em>/api/1.1/staticdnsentries</em></a></td>
+<td><a class="reference internal" href="v12/static_dns.html#to-api-v12-static-dns-route"><em>/api/1.2/staticdnsentries</em></a></td>
</tr>
<tr class="row-even"><td>/datastatus</td>
-<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td>
-<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td>
+<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><em>/api/1.1/statuses</em></a></td>
+<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><em>/api/1.2/statuses</em></a></td>
</tr>
<tr class="row-odd"><td>/datastatus/orderby/name</td>
-<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><span class="std std-ref">/api/1.1/statuses</span></a></td>
-<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><span class="std std-ref">/api/1.2/statuses</span></a></td>
+<td><a class="reference internal" href="v11/status.html#to-api-v11-statuses-route"><em>/api/1.1/statuses</em></a></td>
+<td><a class="reference internal" href="v12/status.html#to-api-v12-statuses-route"><em>/api/1.2/statuses</em></a></td>
</tr>
<tr class="row-even"><td>/datatype</td>
-<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td>
-<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td>
+<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><em>/api/1.1/types</em></a></td>
+<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><em>/api/1.2/types</em></a></td>
</tr>
<tr class="row-odd"><td>/datatype/orderby/:field</td>
-<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><span class="std std-ref">/api/1.1/types</span></a></td>
-<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><span class="std std-ref">/api/1.2/types</span></a></td>
+<td><a class="reference internal" href="v11/type.html#to-api-v11-types-route"><em>/api/1.1/types</em></a></td>
+<td><a class="reference internal" href="v12/type.html#to-api-v12-types-route"><em>/api/1.2/types</em></a></td>
</tr>
<tr class="row-even"><td>/datauser</td>
-<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td>
-<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td>
+<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><em>/api/1.1/users</em></a></td>
+<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><em>/api/1.2/users</em></a></td>
</tr>
<tr class="row-odd"><td>/datauser/orderby/:field</td>
-<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><span class="std std-ref">/api/1.1/users</span></a></td>
-<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><span class="std std-ref">/api/1.2/users</span></a></td>
+<td><a class="reference internal" href="v11/user.html#to-api-v11-users-route"><em>/api/1.1/users</em></a></td>
+<td><a class="reference internal" href="v12/user.html#to-api-v12-users-route"><em>/api/1.2/users</em></a></td>
</tr>
</tbody>
</table>
@@ -398,7 +395,7 @@ table.docutils col:nth-child(3) {
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[23/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/server.txt b/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
new file mode 100644
index 0000000..3700160
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/server.txt
@@ -0,0 +1,1125 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-server:
+
+Server
+======
+
+.. _to-api-v12-servers-route:
+
+/api/1.2/servers
+++++++++++++++++
+
+**GET /api/1.2/servers**
+
+ Retrieves properties of CDN servers.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +====================+==========+=============================================+
+ | ``dsId`` | no | Used to filter servers by delivery service. |
+ +--------------------+----------+---------------------------------------------+
+ | ``status`` | no | Used to filter servers by status. |
+ +--------------------+----------+---------------------------------------------+
+ | ``type`` | no | Used to filter servers by type. |
+ +--------------------+----------+---------------------------------------------+
+ | ``profileId`` | no | Used to filter servers by profile. |
+ +--------------------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ },
+ {
+ ... more server data
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/servers/:id**
+
+ Retrieves properties of a CDN server by server ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Server id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | The cache group id. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the server belongs to. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``guid`` | string | An identifier used to uniquely identify the server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+ | ``updPending`` | bool | |
+ +--------------------+--------+------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "cachegroup": "us-il-chicago",
+ "cachegroupId": "3",
+ "cdnId": "3",
+ "cdnName": "CDN-1",
+ "domainName": "chi.kabletown.net",
+ "guid": null,
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "lastUpdated": "2015-03-08 15:57:32",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "offlineReason": "N/A",
+ "physLocation": "plocation-chi-1",
+ "physLocationId": "9",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "profileDesc": "EDGE1_CDN1_421_SSL profile",
+ "profileId": "12",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "statusId": "6",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "typeId": "3",
+ "updPending": false
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/servers/summary**
+
+ Retrieves a count of CDN servers by type.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------+--------+------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===========+========+========================================================================+
+ | ``count`` | int | The number of servers of this type in this instance of Traffic Ops. |
+ +-----------+--------+------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of the server count (see :ref:`to-api-v12-type`). |
+ +-----------+--------+------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "count": 4,
+ "type": "CCR"
+ },
+ {
+ "count": 55,
+ "type": "EDGE"
+ },
+ {
+ "type": "MID",
+ "count": 18
+ },
+ {
+ "count": 0,
+ "type": "INFLUXDB"
+ },
+ {
+ "count": 4,
+ "type": "RASCAL"
+ }
+ }
+
+|
+
+**GET /api/1.2/servers/hostname/:name/details**
+
+ Retrieves the details of a server.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+----------------------------------+
+ | Name | Required | Description |
+ +==========+==========+==================================+
+ | ``name`` | yes | The host name part of the cache. |
+ +----------+----------+----------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=============================================================================================================+
+ | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v12-cachegroup`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``deliveryservices`` | array | Array of strings with the delivery service ids assigned (see :ref:`to-api-v12-ds`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``domainName`` | string | The domain name part of the FQDN of the cache. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``hardwareInfo`` | hash | Hwinfo struct (see :ref:`to-api-v12-hwinfo`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``hostName`` | string | The host name part of the cache. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The server id (database row number). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``iloUsername`` | string | The user name for lights-out-management. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``interfaceName`` | string | The network interface name used for serving traffic. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time/Date of the last update for this server. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``physLocation`` | string | The physical location name (see :ref:`to-api-v12-phys-loc`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``profile`` | string | The assigned profile name (see :ref:`to-api-v12-profile`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``rack`` | string | A string indicating rack location. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``routerHostName`` | string | The human readable name of the router. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``routerPortName`` | string | The human readable name of the router port. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``status`` | string | The Status string (See :ref:`to-api-v12-status`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The name of the type of this server (see :ref:`to-api-v12-type`). |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``xmppId`` | string | Deprecated. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+ | ``xmppPasswd`` | string | Deprecated. |
+ +----------------------+--------+-------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroup": "us-il-chicago",
+ "deliveryservices": [
+ "1",
+ "2",
+ "3",
+ "4"
+ ],
+ "domainName": "chi.kabletown.net",
+ "hardwareInfo": {
+ "Physical Disk 0:1:3": "D1S2",
+ "Physical Disk 0:1:2": "D1S2",
+ "Physical Disk 0:1:15": "D1S2",
+ "Power Supply.Slot.2": "04.07.15",
+ "Physical Disk 0:1:24": "YS08",
+ "Physical Disk 0:1:1": "D1S2",
+ "Model": "PowerEdge R720xd",
+ "Physical Disk 0:1:22": "D1S2",
+ "Physical Disk 0:1:18": "D1S2",
+ "Enterprise UEFI Diagnostics": "4217A5",
+ "Lifecycle Controller": "1.0.8.42",
+ "Physical Disk 0:1:8": "D1S2",
+ "Manufacturer": "Dell Inc.",
+ "Physical Disk 0:1:6": "D1S2",
+ "SysMemTotalSize": "196608",
+ "PopulatedDIMMSlots": "24",
+ "Physical Disk 0:1:20": "D1S2",
+ "Intel(R) Ethernet 10G 2P X520 Adapter": "13.5.7",
+ "Physical Disk 0:1:14": "D1S2",
+ "BACKPLANE FIRMWARE": "1.00",
+ "Dell OS Drivers Pack, 7.0.0.29, A00": "7.0.0.29",
+ "Integrated Dell Remote Access Controller": "1.57.57",
+ "Physical Disk 0:1:5": "D1S2",
+ "ServiceTag": "D6XPDV1",
+ "PowerState": "2",
+ "Physical Disk 0:1:23": "D1S2",
+ "Physical Disk 0:1:25": "D903",
+ "BIOS": "1.3.6",
+ "Physical Disk 0:1:12": "D1S2",
+ "System CPLD": "1.0.3",
+ "Physical Disk 0:1:4": "D1S2",
+ "Physical Disk 0:1:0": "D1S2",
+ "Power Supply.Slot.1": "04.07.15",
+ "PERC H710P Mini": "21.0.2-0001",
+ "PowerCap": "689",
+ "Physical Disk 0:1:16": "D1S2",
+ "Physical Disk 0:1:10": "D1S2",
+ "Physical Disk 0:1:11": "D1S2",
+ "Lifecycle Controller 2": "1.0.8.42",
+ "BP12G+EXP 0:1": "1.07",
+ "Physical Disk 0:1:9": "D1S2",
+ "Physical Disk 0:1:17": "D1S2",
+ "Broadcom Gigabit Ethernet BCM5720": "7.2.20",
+ "Physical Disk 0:1:21": "D1S2",
+ "Physical Disk 0:1:13": "D1S2",
+ "Physical Disk 0:1:7": "D1S2",
+ "Physical Disk 0:1:19": "D1S2"
+ },
+ "hostName": "atsec-chi-00",
+ "id": "19",
+ "iloIpAddress": "172.16.2.6",
+ "iloIpGateway": "172.16.2.1",
+ "iloIpNetmask": "255.255.255.0",
+ "iloPassword": "********",
+ "iloUsername": "",
+ "interfaceMtu": "9000",
+ "interfaceName": "bond0",
+ "ip6Address": "2033:D0D0:3300::2:2/64",
+ "ip6Gateway": "2033:D0D0:3300::2:1",
+ "ipAddress": "10.10.2.2",
+ "ipGateway": "10.10.2.1",
+ "ipNetmask": "255.255.255.0",
+ "mgmtIpAddress": "",
+ "mgmtIpGateway": "",
+ "mgmtIpNetmask": "",
+ "physLocation": "plocation-chi-1",
+ "profile": "EDGE1_CDN1_421_SSL",
+ "rack": "RR 119.02",
+ "routerHostName": "rtr-chi.kabletown.net",
+ "routerPortName": "2",
+ "status": "ONLINE",
+ "tcpPort": "80",
+ "httpsPort": "443",
+ "type": "EDGE",
+ "xmppId": "atsec-chi-00-dummyxmpp",
+ "xmppPasswd": "X"
+
+ }
+ }
+
+|
+
+**POST /api/1.2/servercheck**
+
+ Post a server check result to the serverchecks table.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------------------+----------+-------------+
+ | Name | Required | Description |
+ +============================+==========+=============+
+ | ``id`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``host_name`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``servercheck_short_name`` | yes | |
+ +----------------------------+----------+-------------+
+ | ``value`` | yes | |
+ +----------------------------+----------+-------------+
+
+ **Request Example** ::
+
+ {
+ "id": "",
+ "host_name": "",
+ "servercheck_short_name": "",
+ "value": ""
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ Response Example:
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Server Check was successfully updated."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/servers**
+
+ Allow user to create a server.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +----------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+================================================+
+ | hostName | yes | The host name part of the server. |
+ +----------------+----------+------------------------------------------------+
+ | domainName | yes | The domain name part of the FQDN of the cache. |
+ +----------------+----------+------------------------------------------------+
+ | cachegroup | yes | cache group name |
+ +----------------+----------+------------------------------------------------+
+ | interfaceName | yes | |
+ +----------------+----------+------------------------------------------------+
+ | ipAddress | yes | |
+ +----------------+----------+------------------------------------------------+
+ | ipNetmask | yes | |
+ +----------------+----------+------------------------------------------------+
+ | ipGateway | yes | |
+ +----------------+----------+------------------------------------------------+
+ | interfaceMtu | no | 1500 or 9000 |
+ +----------------+----------+------------------------------------------------+
+ | physLocation | yes | |
+ +----------------+----------+------------------------------------------------+
+ | type | yes | server type |
+ +----------------+----------+------------------------------------------------+
+ | profile | yes | |
+ +----------------+----------+------------------------------------------------+
+ | cdnName | yes | cdn name the server belongs to |
+ +----------------+----------+------------------------------------------------+
+ | tcpPort | no | |
+ +----------------+----------+------------------------------------------------+
+ | httpsPort | no | |
+ +----------------+----------+------------------------------------------------+
+ | xmppId | no | |
+ +----------------+----------+------------------------------------------------+
+ | xmppPasswd | no | |
+ +----------------+----------+------------------------------------------------+
+ | ip6Address | no | |
+ +----------------+----------+------------------------------------------------+
+ | ip6Gateway | no | |
+ +----------------+----------+------------------------------------------------+
+ | rack | no | |
+ +----------------+----------+------------------------------------------------+
+ | mgmtIpAddress | no | |
+ +----------------+----------+------------------------------------------------+
+ | mgmtIpNetmask | no | |
+ +----------------+----------+------------------------------------------------+
+ | mgmtIpGateway | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloIpAddress | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloIpNetmask | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloIpGateway | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloUsername | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloPassword | no | |
+ +----------------+----------+------------------------------------------------+
+ | routerHostName | no | |
+ +----------------+----------+------------------------------------------------+
+ | routerPortName | no | |
+ +----------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "hostName": "tc1_ats1",
+ "domainName": "my.test.com",
+ "cachegroup": "cache_group_edge",
+ "cdnName": "cdn_number_1",
+ "interfaceName": "eth0",
+ "ipAddress": "10.74.27.188",
+ "ipNetmask": "255.255.255.0",
+ "ipGateway": "10.74.27.1",
+ "interfaceMtu": "1500",
+ "physLocation": "plocation-chi-1",
+ "type": "EDGE",
+ "profile": "EDGE1_CDN1_421"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------+--------+------------------------------------------------+
+ | Name | Type | Description |
+ +================+========+================================================+
+ | hostName | string | The host name part of the server. |
+ +----------------+--------+------------------------------------------------+
+ | Name | string | Description |
+ +----------------+--------+------------------------------------------------+
+ | domainName | string | The domain name part of the FQDN of the cache. |
+ +----------------+--------+------------------------------------------------+
+ | cachegroup | string | cache group name |
+ +----------------+--------+------------------------------------------------+
+ | interfaceName | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | interfaceMtu | string | 1500 or 9000 |
+ +----------------+--------+------------------------------------------------+
+ | physLocation | string | |
+ +----------------+--------+------------------------------------------------+
+ | type | string | server type |
+ +----------------+--------+------------------------------------------------+
+ | profile | string | |
+ +----------------+--------+------------------------------------------------+
+ | cdnName | string | cdn name the server belongs to |
+ +----------------+--------+------------------------------------------------+
+ | tcpPort | string | |
+ +----------------+--------+------------------------------------------------+
+ | httpsPort | string | |
+ +----------------+--------+------------------------------------------------+
+ | xmppId | string | |
+ +----------------+--------+------------------------------------------------+
+ | xmppPasswd | string | |
+ +----------------+--------+------------------------------------------------+
+ | ip6Address | string | |
+ +----------------+--------+------------------------------------------------+
+ | ip6Gateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | rack | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloUsername | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloPassword | string | |
+ +----------------+--------+------------------------------------------------+
+ | routerHostName | string | |
+ +----------------+--------+------------------------------------------------+
+ | routerPortName | string | |
+ +----------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ 'response' : {
+ 'xmppPasswd' : '**********',
+ 'profile' : 'EDGE1_CDN1_421',
+ 'iloUsername' : null,
+ 'status' : 'REPORTED',
+ 'ipAddress' : '10.74.27.188',
+ 'cdnId' : '1',
+ 'physLocation' : 'plocation-chi-1',
+ 'cachegroup' : 'cache_group_edge',
+ 'interfaceName' : 'eth0',
+ 'ip6Gateway' : null,
+ 'iloPassword' : null,
+ 'id' : '1003',
+ 'routerPortName' : null,
+ 'lastUpdated' : '2016-01-25 14:16:16',
+ 'ipNetmask' : '255.255.255.0',
+ 'ipGateway' : '10.74.27.1',
+ 'tcpPort' : '80',
+ 'httpsPort' : '443',
+ 'mgmtIpAddress' : null,
+ 'ip6Address' : null,
+ 'interfaceMtu' : '1500',
+ 'iloIpGateway' : null,
+ 'hostName' : 'tc1_ats1',
+ 'xmppId' : 'tc1_ats1',
+ 'rack' : null,
+ 'mgmtIpNetmask' : null,
+ 'iloIpAddress' : null,
+ 'mgmtIpGateway' : null,
+ 'type' : 'EDGE',
+ 'domainName' : 'my.test.com',
+ 'iloIpNetmask' : null,
+ 'routerHostName' : null
+ }
+ }
+
+|
+
+**PUT /api/1.2/servers/{:id}**
+
+ Allow user to edit server through api.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------+----------+-------------------------------+
+ | Name | Required | Description |
+ +======+==========+===============================+
+ | id | yes | The id of the server to edit. |
+ +------+----------+-------------------------------+
+
+ **Request Properties**
+
+ +----------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+================================================+
+ | hostName | yes | The host name part of the server. |
+ +----------------+----------+------------------------------------------------+
+ | domainName | yes | The domain name part of the FQDN of the cache. |
+ +----------------+----------+------------------------------------------------+
+ | cachegroup | yes | cache group name |
+ +----------------+----------+------------------------------------------------+
+ | interfaceName | yes | |
+ +----------------+----------+------------------------------------------------+
+ | ipAddress | yes | |
+ +----------------+----------+------------------------------------------------+
+ | ipNetmask | yes | |
+ +----------------+----------+------------------------------------------------+
+ | ipGateway | yes | |
+ +----------------+----------+------------------------------------------------+
+ | interfaceMtu | no | 1500 or 9000 |
+ +----------------+----------+------------------------------------------------+
+ | physLocation | yes | |
+ +----------------+----------+------------------------------------------------+
+ | type | yes | server type |
+ +----------------+----------+------------------------------------------------+
+ | profile | yes | |
+ +----------------+----------+------------------------------------------------+
+ | cdnName | yes | cdn name the server belongs to |
+ +----------------+----------+------------------------------------------------+
+ | tcpPort | no | |
+ +----------------+----------+------------------------------------------------+
+ | httpsPort | no | |
+ +----------------+----------+------------------------------------------------+
+ | xmppId | no | |
+ +----------------+----------+------------------------------------------------+
+ | xmppPasswd | no | |
+ +----------------+----------+------------------------------------------------+
+ | ip6Address | no | |
+ +----------------+----------+------------------------------------------------+
+ | ip6Gateway | no | |
+ +----------------+----------+------------------------------------------------+
+ | rack | no | |
+ +----------------+----------+------------------------------------------------+
+ | mgmtIpAddress | no | |
+ +----------------+----------+------------------------------------------------+
+ | mgmtIpNetmask | no | |
+ +----------------+----------+------------------------------------------------+
+ | mgmtIpGateway | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloIpAddress | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloIpNetmask | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloIpGateway | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloUsername | no | |
+ +----------------+----------+------------------------------------------------+
+ | iloPassword | no | |
+ +----------------+----------+------------------------------------------------+
+ | routerHostName | no | |
+ +----------------+----------+------------------------------------------------+
+ | routerPortName | no | |
+ +----------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "hostName": "tc1_ats2",
+ "domainName": "my.test.com",
+ "cachegroup": "cache_group_edge",
+ "cdnName": "cdn_number_1",
+ "interfaceName": "eth0",
+ "ipAddress": "10.74.27.188",
+ "ipNetmask": "255.255.255.0",
+ "ipGateway": "10.74.27.1",
+ "interfaceMtu": "1500",
+ "physLocation": "plocation-chi-1",
+ "type": "EDGE",
+ "profile": "EDGE1_CDN1_421"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------+--------+------------------------------------------------+
+ | Name | Type | Description |
+ +================+========+================================================+
+ | hostName | string | The host name part of the server. |
+ +----------------+--------+------------------------------------------------+
+ | Name | string | Description |
+ +----------------+--------+------------------------------------------------+
+ | domainName | string | The domain name part of the FQDN of the cache. |
+ +----------------+--------+------------------------------------------------+
+ | cachegroup | string | cache group name |
+ +----------------+--------+------------------------------------------------+
+ | interfaceName | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | ipGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | interfaceMtu | string | 1500 or 9000 |
+ +----------------+--------+------------------------------------------------+
+ | physLocation | string | |
+ +----------------+--------+------------------------------------------------+
+ | type | string | server type |
+ +----------------+--------+------------------------------------------------+
+ | profile | string | |
+ +----------------+--------+------------------------------------------------+
+ | cdnName | string | cdn name the server belongs to |
+ +----------------+--------+------------------------------------------------+
+ | tcpPort | string | |
+ +----------------+--------+------------------------------------------------+
+ | httpsPort | string | |
+ +----------------+--------+------------------------------------------------+
+ | xmppId | string | |
+ +----------------+--------+------------------------------------------------+
+ | xmppPasswd | string | |
+ +----------------+--------+------------------------------------------------+
+ | ip6Address | string | |
+ +----------------+--------+------------------------------------------------+
+ | ip6Gateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | rack | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | mgmtIpGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpAddress | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpNetmask | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloIpGateway | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloUsername | string | |
+ +----------------+--------+------------------------------------------------+
+ | iloPassword | string | |
+ +----------------+--------+------------------------------------------------+
+ | routerHostName | string | |
+ +----------------+--------+------------------------------------------------+
+ | routerPortName | string | |
+ +----------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ 'response' : {
+ 'xmppPasswd' : '**********',
+ 'profile' : 'EDGE1_CDN1_421',
+ 'iloUsername' : null,
+ 'status' : 'REPORTED',
+ 'ipAddress' : '10.74.27.188',
+ 'cdnId' : '1',
+ 'physLocation' : 'plocation-chi-1',
+ 'cachegroup' : 'cache_group_edge',
+ 'interfaceName' : 'eth0',
+ 'ip6Gateway' : null,
+ 'iloPassword' : null,
+ 'id' : '1003',
+ 'routerPortName' : null,
+ 'lastUpdated' : '2016-01-25 14:16:16',
+ 'ipNetmask' : '255.255.255.0',
+ 'ipGateway' : '10.74.27.1',
+ 'tcpPort' : '80',
+ 'httpsPort' : '443',
+ 'mgmtIpAddress' : null,
+ 'ip6Address' : null,
+ 'interfaceMtu' : '1500',
+ 'iloIpGateway' : null,
+ 'hostName' : 'tc1_ats2',
+ 'xmppId' : 'tc1_ats1',
+ 'rack' : null,
+ 'mgmtIpNetmask' : null,
+ 'iloIpAddress' : null,
+ 'mgmtIpGateway' : null,
+ 'type' : 'EDGE',
+ 'domainName' : 'my.test.com',
+ 'iloIpNetmask' : null,
+ 'routerHostName' : null
+ }
+ }
+
+|
+
+**DELETE /api/1.2/servers/{:id}**
+
+ Allow user to delete server through api.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------+----------+---------------------------------+
+ | Name | Required | Description |
+ +======+==========+=================================+
+ | id | yes | The id of the server to delete. |
+ +------+----------+---------------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Server was deleted."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/servers/{:id}/queue_update**
+
+ Queue or dequeue updates for a specific server.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------+----------+------------------+
+ | Name | Required | Description |
+ +===========+==========+==================+
+ | id | yes | the server id. |
+ +-----------+----------+------------------+
+
+ **Request Properties**
+
+ +--------------+---------+-----------------------------------------------+
+ | Name | Type | Description |
+ +==============+=========+===============================================+
+ | action | string | queue or dequeue |
+ +--------------+---------+-----------------------------------------------+
+
+ **Response Properties**
+
+ +--------------+---------+-----------------------------------------------+
+ | Name | Type | Description |
+ +==============+=========+===============================================+
+ | action | string | The action processed, queue or dequeue. |
+ +--------------+---------+-----------------------------------------------+
+ | serverId | integer | server id |
+ +--------------+---------+-----------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "serverId": "1",
+ "action": "queue"
+ }
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.rst.txt
deleted file mode 100644
index 0e44cec..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.rst.txt
+++ /dev/null
@@ -1,66 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-dns:
-
-Static DNS Entries
-==================
-
-.. _to-api-v12-static-dns-route:
-
-/api/1.2/staticdnsentries
-+++++++++++++++++++++++++
-
-**GET /api/1.2/staticdnsentries.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +---------------------+-----------+------------------------------------------------------------+
- | Parameter | Type | Description |
- +=====================+===========+============================================================+
- | ``deliveryservice`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``ttl`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``type`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``address`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``cachegroup`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
- | ``host`` | string | |
- +---------------------+-----------+------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "deliveryservice": "foo-ds",
- "ttl": "30",
- "type": "CNAME_RECORD",
- "address": "bar.foo.baz.tv.",
- "cachegroup": "us-co-denver",
- "host": "mm"
- }
- ]
- }
-
-|
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.txt b/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.txt
new file mode 100644
index 0000000..0e44cec
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/static_dns.txt
@@ -0,0 +1,66 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-dns:
+
+Static DNS Entries
+==================
+
+.. _to-api-v12-static-dns-route:
+
+/api/1.2/staticdnsentries
++++++++++++++++++++++++++
+
+**GET /api/1.2/staticdnsentries.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +---------------------+-----------+------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+===========+============================================================+
+ | ``deliveryservice`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``ttl`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``type`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``address`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``cachegroup`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+ | ``host`` | string | |
+ +---------------------+-----------+------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "deliveryservice": "foo-ds",
+ "ttl": "30",
+ "type": "CNAME_RECORD",
+ "address": "bar.foo.baz.tv.",
+ "cachegroup": "us-co-denver",
+ "host": "mm"
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/status.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/status.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/status.rst.txt
deleted file mode 100644
index a97a313..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/status.rst.txt
+++ /dev/null
@@ -1,127 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-status:
-
-Status
-======
-
-.. _to-api-v12-statuses-route:
-
-/api/1.2/statuses
-+++++++++++++++++
-
-**GET /api/1.2/statuses**
-
- Retrieves a list of the server status codes available.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------+--------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+================================================================================+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``name`` | string | The string equivalent of the status |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``description`` | string | A short description of the status |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
- +-----------------+--------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "4",
- "name": "ADMIN_DOWN",
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "id": "5",
- "name": "CCR_IGNORE",
- "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "id": "1",
- "name": "OFFLINE",
- "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "id": "2",
- "name": "ONLINE",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
- "lastUpdated": "2013-02-13 16:34:29"
- },
- {
- "id": "3",
- "name": "REPORTED",
- "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
- "lastUpdated": "2013-02-13 16:34:29"
- }
- ]
- }
-
-**GET /api/1.2/statuses/:id**
-
- Retrieves a server status by ID.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | Status id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +-----------------+--------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+================================================================================+
- | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``name`` | string | The string equivalent of the status |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``description`` | string | A short description of the status |
- +-----------------+--------+--------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
- +-----------------+--------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "4",
- "name": "ADMIN_DOWN",
- "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
- "lastUpdated": "2013-02-13 16:34:29"
- }
- ]
- }
-
[08/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/parameter.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/parameter.html b/docs/latest/development/traffic_ops_api/v11/parameter.html
index 5d572dd..b30ce97 100644
--- a/docs/latest/development/traffic_ops_api/v11/parameter.html
+++ b/docs/latest/development/traffic_ops_api/v11/parameter.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Parameter — Traffic Control 1.8.1 documentation </title>
+ <title>Parameter — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Physical Location" href="phys_location.html"/>
<link rel="prev" title="Hardware Info" href="hwinfo.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Parameter</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/parameter.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/parameter.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -234,28 +231,28 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -326,28 +323,28 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"foo.bar.net"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"domain_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"FooConfig.xml"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"foo.bar.net"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"domain_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"FooConfig.xml"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"0,1,2,3,4,5,6"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Drive_Letters"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"storage.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"0,1,2,3,4,5,6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Drive_Letters"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"storage.config"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">"STRING __HOSTNAME__"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
- <span class="s2">"config_file"</span><span class="p">:</span> <span class="s2">"records.config"</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"secure"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">"STRING __HOSTNAME__"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CONFIG proxy.config.proxy_name"</span><span class="p">,</span>
+ <span class="s">"config_file"</span><span class="p">:</span> <span class="s">"records.config"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -395,7 +392,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/phys_location.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/phys_location.html b/docs/latest/development/traffic_ops_api/v11/phys_location.html
index c584990..d1972f3 100644
--- a/docs/latest/development/traffic_ops_api/v11/phys_location.html
+++ b/docs/latest/development/traffic_ops_api/v11/phys_location.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Physical Location — Traffic Control 1.8.1 documentation </title>
+ <title>Physical Location — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Profiles" href="profile.html"/>
<link rel="prev" title="Parameter" href="parameter.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Physical Location</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/phys_location.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/phys_location.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -270,39 +267,39 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -337,13 +334,13 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Ashburn"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Ashburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -450,23 +447,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -562,18 +559,18 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"regionId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doesssss"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 9rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"regionId"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doesssss"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 9rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -656,29 +653,29 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Physical location update was successful."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Physical location update was successful."</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"Mile High"</span><span class="p">,</span>
- <span class="s2">"region"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"poc"</span><span class="p">:</span> <span class="s2">"Jane Doe"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"phone"</span><span class="p">:</span> <span class="s2">"(123) 555-1111"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"NM"</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"jane.doe@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"87107"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"123 East 3rd St"</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"Albuquerque"</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"Mile High"</span><span class="p">,</span>
+ <span class="s">"region"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"poc"</span><span class="p">:</span> <span class="s">"Jane Doe"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-10-02 08:22:43"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"phone"</span><span class="p">:</span> <span class="s">"(123) 555-1111"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"NM"</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"jane.doe@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Albuquerque"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"87107"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"address"</span><span class="p">:</span> <span class="s">"123 East 3rd St"</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"Albuquerque"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -771,14 +768,14 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span> <span class="p">:</span> <span class="s2">"my physical location1"</span><span class="p">,</span>
- <span class="s2">"shortName"</span> <span class="p">:</span> <span class="s2">"myphylocation1"</span><span class="p">,</span>
- <span class="s2">"address"</span> <span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"city"</span> <span class="p">:</span> <span class="s2">"Shanghai"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"SH"</span><span class="p">,</span>
- <span class="s2">"zip"</span><span class="p">:</span> <span class="s2">"200000"</span><span class="p">,</span>
- <span class="s2">"comments"</span><span class="p">:</span> <span class="s2">"this is physical location1"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span> <span class="p">:</span> <span class="s">"my physical location1"</span><span class="p">,</span>
+ <span class="s">"shortName"</span> <span class="p">:</span> <span class="s">"myphylocation1"</span><span class="p">,</span>
+ <span class="s">"address"</span> <span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"city"</span> <span class="p">:</span> <span class="s">"Shanghai"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"SH"</span><span class="p">,</span>
+ <span class="s">"zip"</span><span class="p">:</span> <span class="s">"200000"</span><span class="p">,</span>
+ <span class="s">"comments"</span><span class="p">:</span> <span class="s">"this is physical location1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -857,23 +854,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s1">'shortName'</span><span class="p">:</span> <span class="s1">'myphylocati'</span><span class="p">,</span>
- <span class="s1">'regionName'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
- <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'my physical location1'</span><span class="p">,</span>
- <span class="s1">'poc'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'phone'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'comments'</span><span class="p">:</span> <span class="s1">'this is physical location1'</span><span class="p">,</span>
- <span class="s1">'state'</span><span class="p">:</span> <span class="s1">'SH'</span><span class="p">,</span>
- <span class="s1">'email'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'zip'</span><span class="p">:</span> <span class="s1">'20000'</span><span class="p">,</span>
- <span class="s1">'region_id'</span><span class="p">:</span> <span class="s1">'20'</span><span class="p">,</span>
- <span class="s1">'city'</span><span class="p">:</span> <span class="s1">'Shanghai'</span><span class="p">,</span>
- <span class="s1">'address'</span><span class="p">:</span> <span class="s1">''</span><span class="p">,</span>
- <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'200'</span>
- <span class="p">}</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre> {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+}
</pre></div>
</div>
</div></blockquote>
@@ -921,7 +918,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/profile.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/profile.html b/docs/latest/development/traffic_ops_api/v11/profile.html
index 965abff..bab5dc4 100644
--- a/docs/latest/development/traffic_ops_api/v11/profile.html
+++ b/docs/latest/development/traffic_ops_api/v11/profile.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Profiles — Traffic Control 1.8.1 documentation </title>
+ <title>Profiles — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Regions" href="region.html"/>
<link rel="prev" title="Physical Location" href="phys_location.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Profiles</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/profile.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/profile.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -232,13 +229,13 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -275,10 +272,10 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -347,13 +344,13 @@
</table>
</div></blockquote>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-10-08 19:34:45"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_TOP"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Content Router for top.foobar.net"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-10-08 19:34:45"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR_TOP"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Content Router for top.foobar.net"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -404,7 +401,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/region.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/region.html b/docs/latest/development/traffic_ops_api/v11/region.html
index 30b94f7..476d975 100644
--- a/docs/latest/development/traffic_ops_api/v11/region.html
+++ b/docs/latest/development/traffic_ops_api/v11/region.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Regions — Traffic Control 1.8.1 documentation </title>
+ <title>Regions — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Roles" href="role.html"/>
<link rel="prev" title="Profiles" href="profile.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Regions</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/region.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/region.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -230,19 +227,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Atlanta"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"divisionName"</span><span class="p">:</span> <span class="s">"West"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"7"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"7"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"divisionName"</span><span class="p">:</span> <span class="s">"West"</span>
<span class="p">},</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -306,13 +303,13 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"Atlanta"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"West"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"Atlanta"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"divisionName"</span><span class="p">:</span> <span class="s">"West"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -369,9 +366,9 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"myregion1"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"4"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -418,19 +415,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Region update was successful."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Region update was successful."</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-03-18 08:57:39"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
- <span class="s2">"division"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"divisionName"</span><span class="p">:</span> <span class="s2">"mydivision1"</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-03-18 08:57:39"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"myregion1"</span><span class="p">,</span>
+ <span class="s">"division"</span><span class="p">:</span> <span class="s">"4"</span><span class="p">,</span>
+ <span class="s">"divisionName"</span><span class="p">:</span> <span class="s">"mydivision1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -486,8 +483,8 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="last highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"myregion1"</span><span class="p">,</span>
+<div class="last highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"myregion1"</span><span class="p">,</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -530,12 +527,12 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s1">'divisionName'</span><span class="p">:</span> <span class="s1">'mydivision1'</span><span class="p">,</span>
- <span class="s1">'divsionId'</span><span class="p">:</span> <span class="s1">'4'</span><span class="p">,</span>
- <span class="s1">'name'</span><span class="p">:</span> <span class="s1">'myregion1'</span><span class="p">,</span>
- <span class="s1">'id'</span><span class="p">:</span> <span class="s1">'19'</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">'divisionName'</span><span class="p">:</span> <span class="s">'mydivision1'</span><span class="p">,</span>
+ <span class="s">'divsionId'</span><span class="p">:</span> <span class="s">'4'</span><span class="p">,</span>
+ <span class="s">'name'</span><span class="p">:</span> <span class="s">'myregion1'</span><span class="p">,</span>
+ <span class="s">'id'</span><span class="p">:</span> <span class="s">'19'</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -585,7 +582,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/role.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/role.html b/docs/latest/development/traffic_ops_api/v11/role.html
index 08d21ea..189a671 100644
--- a/docs/latest/development/traffic_ops_api/v11/role.html
+++ b/docs/latest/development/traffic_ops_api/v11/role.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Roles — Traffic Control 1.8.1 documentation </title>
+ <title>Roles — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Server" href="server.html"/>
<link rel="prev" title="Regions" href="region.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Roles</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/role.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/role.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -230,13 +227,13 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"read-only"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"privLevel"</span><span class="p">:</span> <span class="s2">"10"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"read-only user"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"read-only"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"privLevel"</span><span class="p">:</span> <span class="s">"10"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"read-only user"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -284,7 +281,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[09/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/deliveryservice.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/deliveryservice.html b/docs/latest/development/traffic_ops_api/v11/deliveryservice.html
index 1b6fba8..e9726e3 100644
--- a/docs/latest/development/traffic_ops_api/v11/deliveryservice.html
+++ b/docs/latest/development/traffic_ops_api/v11/deliveryservice.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Delivery Service — Traffic Control 1.8.1 documentation </title>
+ <title>Delivery Service — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Hardware Info" href="hwinfo.html"/>
<link rel="prev" title="Change Logs" href="changelog.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Delivery Service</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/deliveryservice.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/deliveryservice.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -368,11 +365,11 @@ available).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
@@ -470,77 +467,77 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
- <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
- <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
- <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
- <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
- <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
- <span class="p">],</span>
- <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
- <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
- <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
- <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
- <span class="p">}</span>
- <span class="p">],</span>
- <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
- <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
- <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
- <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
- <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
- <span class="p">}</span>
- <span class="p">{</span> <span class="o">..</span> <span class="p">},</span>
- <span class="p">{</span> <span class="o">..</span> <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -730,11 +727,11 @@ available).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td>
<td>bool</td>
-<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td>
+<td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops_using.html#rl-multi-site-origin"><em>Multi Site Origin</em></a></td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td>
<td>string</td>
@@ -832,72 +829,72 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span>
- <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
- <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span>
- <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
- <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span>
- <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"http://edge.foo-ds.foo.bar.net"</span>
+ <span class="s">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"ccrDnsTtl"</span><span class="p">:</span> <span class="s">"3600"</span><span class="p">,</span>
+ <span class="s">"cdnId"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"over-the-top"</span><span class="p">,</span>
+ <span class="s">"checkPath"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"displayName"</span><span class="p">:</span> <span class="s">"My Cool Delivery Service"</span><span class="p">,</span>
+ <span class="s">"dnsBypassCname"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"dnsBypassIp"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"dnsBypassIp6"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"dnsBypassTtl"</span><span class="p">:</span> <span class="s">"30"</span><span class="p">,</span>
+ <span class="s">"dscp"</span><span class="p">:</span> <span class="s">"40"</span><span class="p">,</span>
+ <span class="s">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"http://edge.foo-ds.foo.bar.net"</span>
<span class="p">],</span>
- <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span>
- <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span>
- <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"geoLimit"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"geoProvider"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"globalMaxTps"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"httpBypassFqdn"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"442"</span><span class="p">,</span>
+ <span class="s">"infoUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"initialDispersion"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 08:49:35"</span><span class="p">,</span>
+ <span class="s">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"longDesc"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"longDesc1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"longDesc2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"matchList"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
- <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span>
+ <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">.foo-ds</span><span class="se">\\</span><span class="s">..*"</span><span class="p">,</span>
+ <span class="s">"setNumber"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"HOST_REGEXP"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span>
- <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span>
- <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span>
- <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span>
- <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span>
+ <span class="s">"maxDnsAnswers"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"missLat"</span><span class="p">:</span> <span class="s">"41.881944"</span><span class="p">,</span>
+ <span class="s">"missLong"</span><span class="p">:</span> <span class="s">"-87.627778"</span><span class="p">,</span>
+ <span class="s">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"orgServerFqdn"</span><span class="p">:</span> <span class="s">"http://baz.boo.net"</span><span class="p">,</span>
+ <span class="s">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for over-the-top"</span><span class="p">,</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
+ <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"ROUTER_TOP"</span><span class="p">,</span>
+ <span class="s">"protocol"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"qstringIgnore"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"rangeRequestHandling"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"sslKeyVersion"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"trResponseHeaders"</span><span class="p">:</span> <span class="s">"Access-Control-Allow-Origin: *"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"HTTP"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"foo-ds"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -956,15 +953,15 @@ protocol (<a class="reference external" href="http://">http://</a> or <a class="
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"failover"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
- <span class="s2">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">false</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"failover"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"locations"</span><span class="p">:</span> <span class="p">[</span> <span class="p">],</span>
+ <span class="s">"destination"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"configured"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"enabled"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
- <span class="s2">"enabled"</span><span class="p">:</span> <span class="n">true</span>
+ <span class="s">"enabled"</span><span class="p">:</span> <span class="n">true</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1020,20 +1017,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -1106,12 +1103,12 @@ delivery service that is down for maintenance.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1187,14 +1184,14 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -1349,22 +1346,22 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">988</span><span class="p">,</span>
- <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">16589105.55958</span><span class="p">,</span>
- <span class="s2">"min"</span><span class="p">:</span> <span class="mf">3185442.975</span><span class="p">,</span>
- <span class="s2">"max"</span><span class="p">:</span> <span class="mf">17124754.257</span><span class="p">,</span>
- <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">3901253.95445</span><span class="p">,</span>
- <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">16013210.034</span><span class="p">,</span>
- <span class="s2">"median"</span><span class="p">:</span> <span class="mf">8816895.576</span><span class="p">,</span>
- <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">8995846.31741194</span><span class="p">,</span>
- <span class="s2">"stddev"</span><span class="p">:</span> <span class="mf">3941169.83683573</span><span class="p">,</span>
- <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">333296106.060112</span>
+ <span class="s">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"count"</span><span class="p">:</span> <span class="mi">988</span><span class="p">,</span>
+ <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">16589105.55958</span><span class="p">,</span>
+ <span class="s">"min"</span><span class="p">:</span> <span class="mf">3185442.975</span><span class="p">,</span>
+ <span class="s">"max"</span><span class="p">:</span> <span class="mf">17124754.257</span><span class="p">,</span>
+ <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">3901253.95445</span><span class="p">,</span>
+ <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">16013210.034</span><span class="p">,</span>
+ <span class="s">"median"</span><span class="p">:</span> <span class="mf">8816895.576</span><span class="p">,</span>
+ <span class="s">"mean"</span><span class="p">:</span> <span class="mf">8995846.31741194</span><span class="p">,</span>
+ <span class="s">"stddev"</span><span class="p">:</span> <span class="mf">3941169.83683573</span><span class="p">,</span>
+ <span class="s">"sum"</span><span class="p">:</span> <span class="mf">333296106.060112</span>
<span class="p">},</span>
- <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="mi">1414303200000</span><span class="p">,</span>
<span class="mf">12923518.466</span>
@@ -1374,7 +1371,7 @@ client to the overflow CDN.</td>
<span class="mf">12625139.65</span>
<span class="p">]</span>
<span class="p">],</span>
- <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"MID Kbps"</span>
+ <span class="s">"label"</span><span class="p">:</span> <span class="s">"MID Kbps"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1441,22 +1438,22 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
- <span class="s2">"orderby"</span><span class="p">:</span> <span class="s2">"deliveryservice"</span><span class="p">,</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"page"</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span>
+ <span class="s">"orderby"</span><span class="p">:</span> <span class="s">"deliveryservice"</span><span class="p">,</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:43"</span><span class="p">,</span>
- <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"20"</span><span class="p">,</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:43"</span><span class="p">,</span>
+ <span class="s">"server"</span><span class="p">:</span> <span class="s">"20"</span><span class="p">,</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-09-26 17:53:44"</span><span class="p">,</span>
- <span class="s2">"server"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-09-26 17:53:44"</span><span class="p">,</span>
+ <span class="s">"server"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"1"</span>
<span class="p">},</span>
<span class="p">],</span>
- <span class="s2">"limit"</span><span class="p">:</span> <span class="mi">2</span>
+ <span class="s">"limit"</span><span class="p">:</span> <span class="mi">2</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1568,20 +1565,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
- <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
+ <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</span>
<span class="p">},</span>
- <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
- <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
- <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
+ <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
+ <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
+ <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1691,20 +1688,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"crt"</span><span class="p">,</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"key"</span><span class="p">,</span>
- <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"csr"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"crt"</span><span class="p">,</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"key"</span><span class="p">,</span>
+ <span class="s">"csr"</span><span class="p">:</span> <span class="s">"csr"</span>
<span class="p">},</span>
- <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN_Eng"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
- <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"KableTown"</span><span class="p">,</span>
- <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"foober.com"</span><span class="p">,</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span>
+ <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN_Eng"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
+ <span class="s">"organization"</span><span class="p">:</span> <span class="s">"KableTown"</span><span class="p">,</span>
+ <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"foober.com"</span><span class="p">,</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span><span class="p">,</span>
+ <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1778,8 +1775,8 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted ssl keys for <xml_id>"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully deleted ssl keys for <xml_id>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1841,20 +1838,20 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
- <span class="s2">"businessUnit"</span><span class="p">:</span> <span class="s2">"CDN Engineering"</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"hostname"</span><span class="p">:</span> <span class="s2">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
- <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"ds-01"</span><span class="p">,</span>
+ <span class="s">"businessUnit"</span><span class="p">:</span> <span class="s">"CDN Engineering"</span><span class="p">,</span>
+ <span class="s">"version"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"hostname"</span><span class="p">:</span> <span class="s">"tr.ds-01.ott.kabletown.com"</span><span class="p">,</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"some_key"</span><span class="p">,</span>
+ <span class="s">"csr"</span><span class="p">:</span> <span class="s">"some_csr"</span><span class="p">,</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"some_crt"</span>
<span class="p">},</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">"US"</span><span class="p">,</span>
- <span class="s2">"organization"</span><span class="p">:</span> <span class="s2">"Kabletown"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">"Denver"</span><span class="p">,</span>
- <span class="s2">"state"</span><span class="p">:</span> <span class="s2">"Colorado"</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">"US"</span><span class="p">,</span>
+ <span class="s">"organization"</span><span class="p">:</span> <span class="s">"Kabletown"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">"Denver"</span><span class="p">,</span>
+ <span class="s">"state"</span><span class="p">:</span> <span class="s">"Colorado"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1888,8 +1885,8 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created ssl keys for ds-01"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully created ssl keys for ds-01"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1939,13 +1936,13 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"ds-01"</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"certificate"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"some_key"</span><span class="p">,</span>
- <span class="s2">"csr"</span><span class="p">:</span> <span class="s2">"some_csr"</span><span class="p">,</span>
- <span class="s2">"crt"</span><span class="p">:</span> <span class="s2">"some_crt"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"ds-01"</span><span class="p">,</span>
+ <span class="s">"version"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"certificate"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"key"</span><span class="p">:</span> <span class="s">"some_key"</span><span class="p">,</span>
+ <span class="s">"csr"</span><span class="p">:</span> <span class="s">"some_csr"</span><span class="p">,</span>
+ <span class="s">"crt"</span><span class="p">:</span> <span class="s">"some_crt"</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -1980,8 +1977,8 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully added ssl keys for ds-01"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully added ssl keys for ds-01"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -2153,39 +2150,39 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"emailTo"</span><span class="p">:</span> <span class="s2">"foo@bar.com"</span><span class="p">,</span>
- <span class="s2">"details"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"customer"</span><span class="p">:</span> <span class="s2">"XYZ Corporation"</span><span class="p">,</span>
- <span class="s2">"contentType"</span><span class="p">:</span> <span class="s2">"video-on-demand"</span><span class="p">,</span>
- <span class="s2">"deliveryProtocol"</span><span class="p">:</span> <span class="s2">"http"</span><span class="p">,</span>
- <span class="s2">"routingType"</span><span class="p">:</span> <span class="s2">"dns"</span><span class="p">,</span>
- <span class="s2">"serviceDesc"</span><span class="p">:</span> <span class="s2">"service description goes here"</span><span class="p">,</span>
- <span class="s2">"peakBPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-5-Gbps"</span><span class="p">,</span>
- <span class="s2">"peakTPSEstimate"</span><span class="p">:</span> <span class="s2">"less-than-1000-TPS"</span><span class="p">,</span>
- <span class="s2">"maxLibrarySizeEstimate"</span><span class="p">:</span> <span class="s2">"less-than-200-GB"</span><span class="p">,</span>
- <span class="s2">"originURL"</span><span class="p">:</span> <span class="s2">"http://myorigin.com"</span><span class="p">,</span>
- <span class="s2">"hasOriginDynamicRemap"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"originTestFile"</span><span class="p">:</span> <span class="s2">"http://myorigin.com/crossdomain.xml"</span><span class="p">,</span>
- <span class="s2">"hasOriginACLWhitelist"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"originHeaders"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"otherOriginSecurity"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"queryStringHandling"</span><span class="p">:</span> <span class="s2">"ignore-in-cache-key-and-pass-up"</span><span class="p">,</span>
- <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"range-requests-not-used"</span><span class="p">,</span>
- <span class="s2">"hasSignedURLs"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"hasNegativeCachingCustomization"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"negativeCachingCustomizationNote"</span><span class="p">:</span> <span class="s2">"negative caching instructions"</span><span class="p">,</span>
- <span class="s2">"serviceAliases"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"http://alias1.com"</span><span class="p">,</span>
- <span class="s2">"http://alias2.com"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"emailTo"</span><span class="p">:</span> <span class="s">"foo@bar.com"</span><span class="p">,</span>
+ <span class="s">"details"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"customer"</span><span class="p">:</span> <span class="s">"XYZ Corporation"</span><span class="p">,</span>
+ <span class="s">"contentType"</span><span class="p">:</span> <span class="s">"video-on-demand"</span><span class="p">,</span>
+ <span class="s">"deliveryProtocol"</span><span class="p">:</span> <span class="s">"http"</span><span class="p">,</span>
+ <span class="s">"routingType"</span><span class="p">:</span> <span class="s">"dns"</span><span class="p">,</span>
+ <span class="s">"serviceDesc"</span><span class="p">:</span> <span class="s">"service description goes here"</span><span class="p">,</span>
+ <span class="s">"peakBPSEstimate"</span><span class="p">:</span> <span class="s">"less-than-5-Gbps"</span><span class="p">,</span>
+ <span class="s">"peakTPSEstimate"</span><span class="p">:</span> <span class="s">"less-than-1000-TPS"</span><span class="p">,</span>
+ <span class="s">"maxLibrarySizeEstimate"</span><span class="p">:</span> <span class="s">"less-than-200-GB"</span><span class="p">,</span>
+ <span class="s">"originURL"</span><span class="p">:</span> <span class="s">"http://myorigin.com"</span><span class="p">,</span>
+ <span class="s">"hasOriginDynamicRemap"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"originTestFile"</span><span class="p">:</span> <span class="s">"http://myorigin.com/crossdomain.xml"</span><span class="p">,</span>
+ <span class="s">"hasOriginACLWhitelist"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"originHeaders"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"otherOriginSecurity"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"queryStringHandling"</span><span class="p">:</span> <span class="s">"ignore-in-cache-key-and-pass-up"</span><span class="p">,</span>
+ <span class="s">"rangeRequestHandling"</span><span class="p">:</span> <span class="s">"range-requests-not-used"</span><span class="p">,</span>
+ <span class="s">"hasSignedURLs"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"hasNegativeCachingCustomization"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"negativeCachingCustomizationNote"</span><span class="p">:</span> <span class="s">"negative caching instructions"</span><span class="p">,</span>
+ <span class="s">"serviceAliases"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"http://alias1.com"</span><span class="p">,</span>
+ <span class="s">"http://alias2.com"</span>
<span class="p">],</span>
- <span class="s2">"rateLimitingGBPS"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
- <span class="s2">"rateLimitingTPS"</span><span class="p">:</span> <span class="mi">5000</span><span class="p">,</span>
- <span class="s2">"overflowService"</span><span class="p">:</span> <span class="s2">"http://overflowcdn.com"</span><span class="p">,</span>
- <span class="s2">"headerRewriteEdge"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"headerRewriteMid"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"headerRewriteRedirectRouter"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"notes"</span><span class="p">:</span> <span class="s2">""</span>
+ <span class="s">"rateLimitingGBPS"</span><span class="p">:</span> <span class="mi">50</span><span class="p">,</span>
+ <span class="s">"rateLimitingTPS"</span><span class="p">:</span> <span class="mi">5000</span><span class="p">,</span>
+ <span class="s">"overflowService"</span><span class="p">:</span> <span class="s">"http://overflowcdn.com"</span><span class="p">,</span>
+ <span class="s">"headerRewriteEdge"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"headerRewriteMid"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"headerRewriteRedirectRouter"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"notes"</span><span class="p">:</span> <span class="s">""</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -2228,11 +2225,11 @@ client to the overflow CDN.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Delivery Service request sent to foo@bar.com."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Delivery Service request sent to foo@bar.com."</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -2283,7 +2280,7 @@ client to the overflow CDN.</td>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/hwinfo.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/hwinfo.html b/docs/latest/development/traffic_ops_api/v11/hwinfo.html
index 4f022c5..b77a0b4 100644
--- a/docs/latest/development/traffic_ops_api/v11/hwinfo.html
+++ b/docs/latest/development/traffic_ops_api/v11/hwinfo.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Hardware Info — Traffic Control 1.8.1 documentation </title>
+ <title>Hardware Info — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Parameter" href="parameter.html"/>
<link rel="prev" title="Delivery Service" href="deliveryservice.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Hardware Info</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/hwinfo.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/hwinfo.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -234,19 +231,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
- <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:0"</span>
+ <span class="s">"serverId"</span><span class="p">:</span> <span class="s">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s">"val"</span><span class="p">:</span> <span class="s">"D1S4"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Physical Disk 0:1:0"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"odol-atsmid-cen-09"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-05-27 09:06:02"</span><span class="p">,</span>
- <span class="s2">"val"</span><span class="p">:</span> <span class="s2">"D1S4"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Physical Disk 0:1:1"</span>
+ <span class="s">"serverId"</span><span class="p">:</span> <span class="s">"odol-atsmid-cen-09"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2014-05-27 09:06:02"</span><span class="p">,</span>
+ <span class="s">"val"</span><span class="p">:</span> <span class="s">"D1S4"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Physical Disk 0:1:1"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -294,7 +291,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[47/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_ops_using.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_using.txt b/docs/latest/_sources/admin/traffic_ops_using.txt
new file mode 100644
index 0000000..5b8525d
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops_using.txt
@@ -0,0 +1,1060 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. |graph| image:: ../../../traffic_ops/app/public/images/graph.png
+.. |info| image:: ../../../traffic_ops/app/public/images/info.png
+.. |checkmark| image:: ../../../traffic_ops/app/public/images/good.png
+.. |X| image:: ../../../traffic_ops/app/public/images/bad.png
+.. |clock| image:: ../../../traffic_ops/app/public/images/clock-black.png
+
+Using Traffic Ops
+%%%%%%%%%%%%%%%%%
+
+
+The Traffic Ops Menu
+====================
+
+.. image:: 12m.png
+
+The following tabs are available in the menu at the top of the Traffic Ops user interface.
+
+.. index::
+ Health Tab
+
+* **Health**
+
+ Information on the health of the system. Hover over this tab to get to the following options:
+
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +===============+====================================================================================================================================+
+ | Table View | A real time view into the main performance indicators of the CDNs managed by Traffic Control. |
+ | | This view is sourced directly by the Traffic Monitor data and is updated every 10 seconds. |
+ | | This is the default screen of Traffic Ops. |
+ | | See :ref:`rl-health-table` for details. |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Graph View | A real graphical time view into the main performance indicators of the CDNs managed by Traffic Control. |
+ | | This view is sourced by the Traffic Monitor data and is updated every 10 seconds. |
+ | | On loading, this screen will show a history of 24 hours of data from Traffic Stats |
+ | | See :ref:`rl-health-graph` for details. |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Server Checks | A table showing the results of the periodic check extension scripts that are run. See :ref:`rl-server-checks` |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+ | Daily Summary | A graph displaying the daily peaks of bandwidth, overall bytes served per day, and overall bytes served since initial installation |
+ | | per CDN. |
+ +---------------+------------------------------------------------------------------------------------------------------------------------------------+
+
+* **Delivery Services**
+
+ The main Delivery Service table. This is where you Create/Read/Update/Delete Delivery Services of all types. Hover over to get the following sub option:
+
+ +-------------+--------------------------------------+
+ | Option | Description |
+ +=============+======================================+
+ | Federations | Add/Edit/Delete Federation Mappings. |
+ +-------------+--------------------------------------+
+
+* **Servers**
+
+ The main Servers table. This is where you Create/Read/Update/Delete servers of all types. Click the main tab to get to the main table, and hover over to get these sub options:
+
+ +-------------------+------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +===================+==========================================================================================+
+ | Upload Server CSV | Bulk add of servers from a csv file. See :ref:`rl-bulkserver` |
+ +-------------------+------------------------------------------------------------------------------------------+
+
+* **Parameters**
+
+ Parameters and Profiles can be edited here. Hover over the tab to get the following options:
+
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +=====================+=====================================================================================================================================================================+
+ | Global Profile | The table of global parameters. See :ref:`rl-param-prof`. This is where you Create/Read/Update/Delete parameters in the Global profile |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | All Cache Groups | The table of all parameters *that are assgined to a cachegroup* - this may be slow to pull up, as there can be thousands of parameters. |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | All Profiles | The table of all parameters *that are assgined to a profile* - this may be slow to pull up, as there can be thousands of parameters. |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Select Profile | Select the parameter list by profile first, then get a table of just the parameters for that profile. |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+ | Orphaned Parameters | A table of parameters that are not associated to any profile of cache group. These parameters either should be deleted or associated with a profile of cache group. |
+ +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+* **Tools**
+
+ Tools for working with Traffic Ops and it's servers. Hover over this tab to get the following options:
+
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +====================+===================================================================================================================================+
+ | Generate ISO | Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See :ref:`rl-generate-iso` |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Queue Updates | Send Updates to the caches. See :ref:`rl-queue-updates` |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | DB Dump | Backup the Database to a .sql file. |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Snapshot CRConfig | Send updates to the Traffic Monitor / Traffic Router servers. See :ref:`rl-queue-updates` |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Invalidate Content | Invalidate or purge content from all caches in the CDN. See :ref:`rl-purge` |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+ | Manage DNSSEC keys | Manage DNSSEC Keys for a chosen CDN. |
+ +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
+
+
+* **Misc**
+
+ Miscellaneous editing options. Hover over this tab to get the following options:
+
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Option | Description |
+ +====================+===========================================================================================+
+ | Cache Groups | Create/Read/Update/Delete cache groups |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Users | Create/Read/Update/Delete users |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Profiles | Create/Read/Update/Delete profiles. See :ref:`rl-working-with-profiles` |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Networks(ASNs) | Create/Read/Update/Delete Autonomous System Numbers See :ref:`rl-asn-czf` |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Hardware | Get detailed hardware information (note: this should be moved to a Traffic Ops Extension) |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Data Types | Create/Read/Update/Delete data types |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Divisions | Create/Read/Update/Delete divisions |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Regions | Create/Read/Update/Delete regions |
+ +--------------------+-------------------------------------------------------------------------------------------+
+ | Physical Locations | Create/Read/Update/Delete locations |
+ +--------------------+-------------------------------------------------------------------------------------------+
+
+.. index::
+ Change Log
+
+* **ChangeLog**
+
+ The Changelog table displays the changes that are being made to the Traffic Ops database through the Traffic Ops user interface. This tab will show the number of changes since you last visited this tab in (brackets) since the last time you visited this tab. There are currently no sub menus for this tab.
+
+
+* **Help**
+
+ Help for Traffic Ops and Traffic Control. Hover over this tab to get the following options:
+
+ +---------------+---------------------------------------------------------------------+
+ | Option | Description |
+ +===============+=====================================================================+
+ | About | Traffic Ops information, such as version, database information, etc |
+ +---------------+---------------------------------------------------------------------+
+ | Release Notes | Release notes for the most recent releases of Traffic Ops |
+ +---------------+---------------------------------------------------------------------+
+ | Logout | Logout from Traffic Ops |
+ +---------------+---------------------------------------------------------------------+
+
+
+.. index::
+ Edge Health
+ Health
+
+Health
+======
+
+.. _rl-health-table:
+
+The Health Table
+++++++++++++++++
+The Health table is the default landing screen for Traffic Ops, it displays the status of the EDGE caches in a table form directly from Traffic Monitor (bypassing Traffic Stats), sorted by Mbps Out. The columns in this table are:
+
+
+* **Profile**: the Profile of this server or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.
+* **Host Name**: the host name of the server or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.
+* **Edge Cache Group**: the edge cache group short name or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.
+* **Healthy**: indicates if this cache is healthy according to the Health Protocol. A row with ALL in any of the columns will always show a |checkmark|, this column is valid only for individual EDGE caches.
+* **Admin**: shows the administrative status of the server.
+* **Connections**: the number of connections this cache (or group of caches) has open (``ats.proxy.process.http.current_client_connections`` from ATS).
+* **Mbps Out**: the bandwidth being served out if this cache (or group of caches)
+
+Since the top line has ALL, ALL, ALL, it shows the total connections and bandwidth for all caches managed by this instance of Traffic Ops.
+
+.. _rl-health-graph:
+
+Graph View
+++++++++++
+The Graph View shows a live view of the last 24 hours of bits per seconds served and open connections at the edge in a graph. This data is sourced from Traffic Stats. If there are 2 CDNs configured, this view will show the statistis for both, and the graphs are stacked. On the left-hand side, the totals and immediate values as well as the percentage of total possible capacity are displayed. This view is update every 10 seconds.
+
+
+.. _rl-server-checks:
+
+Server Checks
++++++++++++++
+The server checks page is inteded to give an overview of the Servers managed by Traffic Control as well as their status. This data comes from `Traffic Ops extensions <traffic_ops_extensions.html>`_.
+
++------+-----------------------------------------------------------------------+
+| Name | Description |
++======+=======================================================================+
+| ILO | Ping the iLO interface for EDGE or MID servers |
++------+-----------------------------------------------------------------------+
+| 10G | Ping the IPv4 address of the EDGE or MID servers |
++------+-----------------------------------------------------------------------+
+| 10G6 | Ping the IPv6 address of the EDGE or MID servers |
++------+-----------------------------------------------------------------------+
+| MTU | Ping the EDGE or MID using the configured MTU from Traffic Ops |
++------+-----------------------------------------------------------------------+
+| FQDN | DNS check that matches what the DNS servers responds with compared to |
+| | what Traffic Ops has. |
++------+-----------------------------------------------------------------------+
+| DSCP | Checks the DSCP value of packets from the edge server to the Traffic |
+| | Ops server. |
++------+-----------------------------------------------------------------------+
+| RTR | Content Router checks. Checks the health of the Content Routers. |
+| | Checks the health of the caches using the Content Routers. |
++------+-----------------------------------------------------------------------+
+| CHR | Cache Hit Ratio in percent. |
++------+-----------------------------------------------------------------------+
+| CDU | Total Cache Disk Usage in percent. |
++------+-----------------------------------------------------------------------+
+| ORT | Operational Readiness Test. Uses the ORT script on the edge and mid |
+| | servers to determine if the configuration in Traffic Ops matches the |
+| | configuration on the edge or mid. The user that this script runs as |
+| | must have an ssh key on the edge servers. |
++------+-----------------------------------------------------------------------+
+
+Daily Summary
++++++++++++++
+Displays daily max gbps and bytes served for all CDNs. In order for the graphs to appear, the 'daily_bw_url' and 'daily_served_url' parameters need to be be created, assigned to the global profile, and have a value of a grafana graph. For more information on configuring grafana, see the `Traffic Stats <traffic_stats.html>`_ section.
+
+.. _rl-server:
+
+Server
+======
+This view shows a table of all the servers in Traffic Ops. The table columns show the most important details of the server. The **IPAddrr** column is clickable to launch an ``ssh://`` link to this server. The |graph| icon will link to a Traffic Stats graph of this server for caches, and the |info| will link to the server status pages for other server types.
+
+
+Server Types
+++++++++++++
+These are the types of servers that can be managed in Traffic Ops:
+
++---------------+---------------------------------------------+
+| Name | Description |
++===============+=============================================+
+| EDGE | Edge Cache |
++---------------+---------------------------------------------+
+| MID | Mid Tier Cache |
++---------------+---------------------------------------------+
+| ORG | Origin |
++---------------+---------------------------------------------+
+| CCR | Comcast Content Router |
++---------------+---------------------------------------------+
+| RASCAL | Rascal health polling & reporting |
++---------------+---------------------------------------------+
+| TOOLS_SERVER | Ops hosts for managment |
++---------------+---------------------------------------------+
+| RIAK | Riak keystore |
++---------------+---------------------------------------------+
+| SPLUNK | SPLUNK indexer search head etc |
++---------------+---------------------------------------------+
+| TRAFFIC_STATS | traffic_stats server |
++---------------+---------------------------------------------+
+| INFLUXDB | influxDb server |
++---------------+---------------------------------------------+
+
+
+.. index::
+ Bulk Upload Server
+
+.. _rl-bulkserver:
+
+Bulk Upload Server
+++++++++++++++++++
+
+
+
+Delivery Service
+================
+The fields in the Delivery Service view are:
+
+.. Sorry for the width of this table, don't know how to make the bullet lists work otherwise. Just set your monitor to 2560*1600, and put on your glasses.
+
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++==================================================+=====================================================================================================================================================================================================================+
+| XML ID | A unique string that identifies this delivery service. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Content Routing Type | The type of content routing this delivery service will use. See :ref:`rl-ds-types`. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Protocol | The protocol to serve this delivery service to the clients with: |
+| | |
+| | - 0 http |
+| | - 1 https |
+| | - 2 both http and https |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DSCP Tag | The DSCP value to mark IP packets to the client with. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Signed URLs | Use Signed URLs? See :ref:`rl-signed-urls`. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Query String Handling | How to treat query strings: |
+| | |
+| | - 0 use in cache key and hand up to origin -this means each unique query string Is treated as a unique URL. |
+| | - 1 Do not use in cache key, but pass up to origin - this means a 2 URLs that are the same except for the query string will match, and cache HIT, while the origin still sees original query string in the request. |
+| | - 2 Drop at edge - this means a 2 URLs that are the same except for the query string will match, and cache HIT, while the origin will not see original query string in the request. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit? | Some services are intended to be limited by geography. The possible settings are are: |
+| | |
+| | - None - Do not limit by geography. |
+| | - CZF only - If the requesting IP is not in the Coverage Zone File, do not serve the request. |
+| | - CZF + US - If the requesting IP is not in the Coverage Zone File or not in the United States, do not serve the request. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Limit Redirect URL | (for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See :ref:`geolimit-failure-redirect-feature` |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Bypass FQDN | (for HTTP routed delivery services only) This is the FQDN Traffic Router will redirect to (with the same path) when the max Bps or Max Tps for this deliveryservice are exceeded. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Bypass Ipv4 | (For DNS routed delivery services only) This is the address to respond to A requests with when the the max Bps or Max Tps for this delivery service are exceeded. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Bypass IPv6 | (For DNS routed delivery services only) This is the address to respond to AAAA requests with when the the max Bps or Max Tps for this delivery service are exceeded. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| IPv6 Routing Enabled? | When set to yes, the Traffic Router will respond to AAAA DNS requests for the tr. and edge. names of this delivery service. Otherwise, only A records will be served. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Range Request Handling | (experimental) How to treat range requests: |
+| | |
+| | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+| | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html>`_ plugin. |
+| | - 2 Use the cache_range_requests plugin. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Delivery Service DNS TTL | The Time To Live on the DNS record for the Traffic Router A and AAAA records (``tr.<deliveryservice>.<cdn-domain>``) for a HTTP delivery service *or* for the A and |
+| | AAAA records of the edge name (``edge.<deliveryservice>.<cdn-domain>``). |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Origin Server Base URL | The Origin Server's base URL. This includes the protocol (http or https). Example: ``http://movies.origin.com`` |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Use Multi Site Origin Feature | Enable the Multi Site Origin feature for this delivery service. See :ref:`rl-multi-site-origin` |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Multi Site Origin Algorithm | - 1 Consistent Hash spreads requests across multiple parents simultaneously based on hash of content URL. |
+| | - 2 Strict Round Robin spreads requests across multiple parents simultaneously based on order of requests. |
+| | - 3 IP Based Round Robin spreads requests across multiple parents simultaneously based on order of requests, but ensures that requests from the same IP always go to the same parent if available. |
+| | - 4 Latched uses only a single parent at any given time and switches to a new parent only if the current parent fails. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| CCR profile | The Traffic Router profile for this delivery service. See :ref:`rl-ccr-profile`. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Maximum Bits per Second allowed globally | The maximum bits per second this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used |
+| | (depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Maximum Transactions per Second allowed globally | The maximum transactions per se this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used |
+| | (depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Miss Default Latitude | Default Latitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this lat. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Geo Miss Default Longitude | Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this long. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Edge Header Rewrite Rules | Header Rewrite rules to apply for this delivery service at the EDGE tier. See :ref:`rl-header-rewrite`. [1]_ |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Mid Header Rewrite Rules | Header Rewrite rules to apply for this delivery service at the MID tier. See :ref:`rl-header-rewrite`. [1]_ |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Regex Remap Expression | Regex Remap rule to apply to this delivery service at the Edge tier. See `ATS documentation on regex_remap <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html>`_. [1]_ |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Cache URL expression | Cache URL rule to apply to this delivery service. See `ATS documentation on cacheurl <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cacheurl.en.html>`_. [1]_ |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Raw remap text | For HTTP and DNS deliveryservices, this will get added to the end of the remap line on the cache verbatim. For ANY_MAP deliveryservices this is the remap line. [1]_ |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Long Description | Long description for this delivery service. To be consumed from the APIs by downstream tools (Portal). |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Customer | Customer description for this delivery service. To be consumed from the APIs by downstream tools (Portal). |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Service | Service description for this delivery service. To be consumed from the APIs by downstream tools (Portal). |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Info URL | Info URL for this delivery service. To be consumed from the APIs by downstream tools (Portal). |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Check Path | A path (ex: /crossdomain.xml) to verify the connection to the origin server with. This can be used by Check Extension scripts to do periodic health checks against the delivery service. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Origin Shield (Pipe Delimited String) | Experimental. Origin Shield string. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Active | When this is set to no Traffic Router will not serve DNS or HTTP responses for this delivery service. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Last Updated | (Read Only) The last time this delivery service was updated. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Number of edges assigned | (Read Only - change by clicking the **Server Assignments** button at the bottom) The number of EDGE caches assigned to this delivery service. See :ref:`rl-assign-edges`. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Number of static DNS entries | (Read Only - change by clicking the **Static DNS** button at the bottom) The number of static DNS entries for this delivery service. See :ref:`rl-static-dns`. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Example delivery URL | (Read Only) An example of how the delivery URL may start. This could be multiple rows if multiple HOST_REGEXP entries have been entered. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Regular expressions for this delivery service | A subtable of the regular expressions to use when routing traffic for this delivery service. See :ref:`rl-ds-regexp`. |
++--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. [1] These fields are not validated by Traffic Ops to be correct syntactically, and can cause Traffic Server to not start if invalid. Please use with caution.
+
+
+.. index::
+ Delivery Service Type
+
+.. _rl-ds-types:
+
+Delivery Service Types
+++++++++++++++++++++++
+One of the most important settings when creating the delivery service is the selection of the delivery service *type*. This type determines the routing method and the primary storage for the delivery service.
+
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Description |
++=================+==============================================================================================================================================================================================================================================================================================================================+
+| HTTP | HTTP Content Routing - The Traffic Router DNS auth server returns its own IP address on DNS queries, and the client gets redirected to a specific cache |
+| | in the nearest cache group using HTTP 302. Use this for long sessions like HLS/HDS/Smooth live streaming, where a longer setup time is not a. |
+| | problem. |
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS | DNS Content Routing - The Traffic Router DNS auth server returns an edge cache IP address to the client right away. The client will find the cache quickly |
+| | but the Traffic Router can not route to a cache that already has this content in the cache group. Use this for smaller objects like web page images / objects. |
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP_NO_CACHE | HTTP Content Routing, but the caches will not actually cache the content, they act as just proxies. The MID tier is bypassed. |
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP_LIVE | HTTP Content routing, but where for "standard" HTTP content routing the objects are stored on disk, for this delivery service type the objects are stored |
+| | on the RAM disks. Use this for linear TV. The MID tier is bypassed for this type. |
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| HTTP_LIVE_NATNL | HTTP Content routing, same as HTTP_LIVE, but the MID tier is NOT bypassed. |
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS_LIVE_NATNL | DNS Content routing, ut where for "standard" DNS content routing the objects are stored on disk, for this delivery service type the objects are stored |
+| | on the RAM disks. Use this for linear TV. The MID tier is NOT bypassed for this type. |
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| DNS_LIVE | DNS Content routing, same as DNS_LIVE_NATIONAL, but the MID tier is bypassed. |
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| ANY_MAP | ANY_MAP is not known to Traffic Router. For this deliveryservice, the "Raw remap text" field in the input form will be used as the remap line on the cache. |
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| STEERING | The Delivery Service will be used to route to other delivery services. The target delivery services Traffic Router and the routing weights for those delivery services will be defined by an admin or steering user. For more information see the `steering feature <traffic_router.html#steering-feature>`_ documentation |
++-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+
+.. Note:: Once created, the Traffic Ops user interface does not allow you to change the delivery service type; the drop down is greyed out. There are many things that can go wrong when changing the type, and it is safer to delete the delivery service, and recreate it.
+
+Federations
++++++++++++
+ Federations allow for other (federated) CDNs (at a different ISP, MSO, etc) to add a list of resolvers and a CNAME to a delivery service Traffic Ops. When a request is made from one of federated CDN's clients, Traffic Router will return the CNAME configured in the federation mapping. This allows the federated CDN to serve the content without the content provider changing the URL, or having to manage multiple URLs.
+
+ Before adding a federation in the Traffic Ops UI, a user with the federations role needs to be created. This user will be assigned to the federation and will be able to add resolvers to the federation via the Traffic Ops `Federation API <../development/traffic_ops_api/v12/federation.html>`_.
+
+.. index::
+ Header Rewrite
+
+.. _rl-header-rewrite:
+
+Header Rewrite Options and DSCP
++++++++++++++++++++++++++++++++
+Most header manipulation and per-delivery service configuration overrides are done using the `ATS Header Rewrite Plugin <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/header_rewrite.en.html>`_. Traffic Control allows you to enter header rewrite rules to be applied at the edge and at the mid level. The syntax used in Traffic Ops is the same as the one described in the ATS documentation, except for some special strings that will get replaced:
+
++-------------------+--------------------------+
+| Traffic Ops Entry | Gets Replaced with |
++===================+==========================+
+| __RETURN__ | A newline |
++-------------------+--------------------------+
+| __CACHE_IPV4__ | The cache's IPv4 address |
++-------------------+--------------------------+
+
+The deliveryservice screen also allows you to set the DSCP value of traffic sent to the client. This setting also results in a header_rewrite rule to be generated and applied to at the edge.
+
+.. Note:: The DSCP setting in the UI is *only* for setting traffic towards the client, and gets applied *after* the initial TCP handshake is complete, and the HTTP request is received (before that the cache can't determine what deliveryservice this request is for, and what DSCP to apply), so the DSCP feature can not be used for security settings - the TCP SYN-ACK is not going to be DSCP marked.
+
+
+.. index::
+ Token Based Authentication
+ Signed URLs
+
+.. _rl-signed-urls:
+
+Token Based Authentication
+++++++++++++++++++++++++++
+Token based authentication or *signed URLs* is implemented using the Traffic Server ``url_sig`` plugin. To sign a URL at the signing portal take the full URL, without any query string, and add on a query string with the following parameters:
+
+Client IP address
+ The client IP address that this signature is valid for.
+
+ ``C=<client IP address>``
+
+Expiration
+ The Expiration time (seconds since epoch) of this signature.
+
+ ``E=<expiration time in secs since unix epoch>``
+
+Algorithm
+ The Algorithm used to create the signature. Only 1 (HMAC_SHA1)
+ and 2 (HMAC_MD5) are supported at this time
+
+ ``A=<algorithm number>``
+
+Key index
+ Index of the key used. This is the index of the key in the
+ configuration file on the cache. The set of keys is a shared
+ secret between the signing portal and the edge caches. There
+ is one set of keys per reverse proxy domain (fqdn).
+
+ ``K=<key index used>``
+Parts
+ Parts to use for the signature, always excluding the scheme
+ (http://). parts0 = fqdn, parts1..x is the directory parts
+ of the path, if there are more parts to the path than letters
+ in the parts param, the last one is repeated for those.
+ Examples:
+
+ 1: use fqdn and all of URl path
+ 0110: use part1 and part 2 of path only
+ 01: use everything except the fqdn
+
+ ``P=<parts string (0's and 1's>``
+
+Signature
+ The signature over the parts + the query string up to and
+ including "S=".
+
+ ``S=<signature>``
+
+.. seealso:: The url_sig `README <https://github.com/apache/trafficserver/blob/master/plugins/experimental/url_sig/README>`_.
+
+Generate URL Sig Keys
+^^^^^^^^^^^^^^^^^^^^^
+To generate a set of random signed url keys for this delivery service and store them in Traffic Vault, click the **Generate URL Sig Keys** button at the bottom of the delivery service details screen.
+
+
+.. rl-parent-selection:
+
+Parent Selection
+++++++++++++++++
+
+Parameters in the Edge (child) profile that influence this feature:
+
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| Name | Filename | Default | Description |
++===============================================+================+===============+=======================================================+
+| CONFIG proxy.config. | records.config | INT 1 | enable parent selection. This is a required setting. |
+| http.parent_proxy_routing_enable | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 1 | required for parent selection. |
+| url_remap.remap_required | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 0 | See |
+| http.no_dns_just_forward_to_parent | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 1 | |
+| http.uncacheable_requests_bypass_parent | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 1 | |
+| http.parent_proxy_routing_enable | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 300 | |
+| http.parent_proxy.retry_time | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 10 | |
+| http.parent_proxy.fail_threshold | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 4 | |
+| http.parent_proxy.total_connect_attempts | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 2 | |
+| http.parent_proxy.per_parent_connect_attempts | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 30 | |
+| http.parent_proxy.connect_attempts_timeout | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 0 | |
+| http.forward.proxy_auth_to_parent | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 0 | |
+| http.parent_proxy_routing_enable | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | STRING | |
+| http.parent_proxy.file | | parent.config | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| CONFIG proxy.config. | records.config | INT 3 | |
+| http.parent_proxy.connect_attempts_timeout | | | |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+| algorithm | parent.config | urlhash | The algorithm to use. |
++-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
+
+
+Parameters in the Mid (parent) profile that influence this feature:
+
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Filename | Default | Description |
++================+===============+=========+===================================================================================================================================================================================+
+| domain_name | CRConfig.json | - | Only parents with the same value as the edge are going to be used as parents (to keep separation between CDNs) |
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| weight | parent.config | 1.0 | The weight of this parent, translates to the number of replicas in the consistent hash ring. This parameter only has effect with algorithm at the client set to "consistent_hash" |
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| port | parent.config | 80 | The port this parent is listening on as a forward proxy. |
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| use_ip_address | parent.config | 0 | 1 means use IP(v4) address of this parent in the parent.config, 0 means use the host_name.domain_name concatenation. |
++----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+.. _rl-multi-site-origin:
+
+Multi Site Origin
++++++++++++++++++
+.. Note:: The Multi Site Origin feature is based upon a feature n ATS that has yet to be submitted to Traffic Server upstream, until it is, set this to 0, or use the ATS rpm supplied on the trafficcontrol.apache.org website.
+
+Normally, the mid servers are not aware of any redundancy at the origin layer. With Multi Site Origin enabled this changes - Traffic Server (and Traffic Ops) are now made aware of the fact there are multiple origins, and can be configured to do more advanced failover and loadbalancing actions.
+
+With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is ""
+
+
+Parameters in the Origin profile that influence this feature:
+
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| Name | Filename | Default | Description |
++==========================================================================+================+============+====================================================================================================+
+| CONFIG proxy.config. http.parent_proxy_routing_enable | records.config | INT 1 | enable parent selection. This is a required setting. |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| CONFIG proxy.config. url_remap.remap_required | records.config | INT 1 | required for parent selection. |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| CONFIG proxy.config. http.parent_proxy.per_parent_connect_attempts | records.config | INT 5 | maximum of 5 connection attempts per parent (parent.config list) within a transaction. |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| CONFIG proxy.config. http.parent_proxy.total_connect_attempts | records.config | INT 10 | maximum of 10 total connection attempts within a transaction. |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| CONFIG proxy.config. http.parent_origin.simple_retry_enabled | records.config | INT 1 | enables simple retry. |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| CONFIG proxy.config. http.parent_origin.simple_retry_response_codes | records.config | STRING 404 | the response code that invokes simple retry. May be a comman separated list of response codes. |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| CONFIG proxy.config. http.parent_origin.dead_server_retry_response_codes | records.config | STRING 503 | the response code that invokes dead server retry. May be a comma separated list of response codes |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| CONFIG proxy.config. http.parent_origin.dead_server_retry_enabled | records.config | INT 1 | enables dead server retry. |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+| CONFIG proxy.config. diags.debug.enabled | records.config | INT 1 | enable debugging for testing only |
++--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
+
+see :ref:`rl-multi-site-origin-qht` for a *quick how to* on this feature.
+
+.. _rl-ccr-profile:
+
+CCR Profile or Traffic Router Profile
++++++++++++++++++++++++++++++++++++++
+
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Name | Config_file | Description |
++=========================================+========================+===========================================================================================================================================================================================================+
+| location | dns.zone | Location to store the DNS zone files in the local file system of Traffic Router. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| location | http-log4j.properties | Location to find the log4j.properties file for Traffic Router. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| location | dns-log4j.properties | Location to find the dns-log4j.properties file for Traffic Router. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| location | geolocation.properties | Location to find the log4j.properties file for Traffic Router. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| CDN_name | rascal-config.txt | The human readable name of the CDN for this profile. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| CoverageZoneJsonURL | CRConfig.xml | The location (URL) to retrieve the coverage zone map file in JSON format from. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| geolocation.polling.url | CRConfig.json | The location (URL) to retrieve the geo database file from. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| geolocation.polling.interval | CRConfig.json | How often to refresh the coverage geo location database in ms |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| coveragezone.polling.interval | CRConfig.json | How often to refresh the coverage zone map in ms |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| coveragezone.polling.url | CRConfig.json | The location (URL) to retrieve the coverage zone map file in XML format from. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| domain_name | CRConfig.json | The top level domain of this Traffic Router instance. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.expire | CRConfig.json | The value for the expire field the Traffic Router DNS Server will respond with on Start of Authority (SOA) records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.minimum | CRConfig.json | The value for the minimum field the Traffic Router DNS Server will respond with on SOA records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.admin | CRConfig.json | The DNS Start of Authority admin. Should be a valid support email address for support if DNS is not working correctly. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.retry | CRConfig.json | The value for the retry field the Traffic Router DNS Server will respond with on SOA records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.soa.refresh | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on A records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.ttls.NS | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on NS records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.ttls.SOA | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on SOA records. |
++-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| tld.ttls.AAAA | CRConfig.json | The Time To Live (TTL) the Traffic Router DNS Server will respond with on AAAA records. |
<TRUNCATED>
[18/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/fonts/fontawesome-webfont.svg
----------------------------------------------------------------------
diff --git a/docs/latest/_static/fonts/fontawesome-webfont.svg b/docs/latest/_static/fonts/fontawesome-webfont.svg
new file mode 100644
index 0000000..45fdf33
--- /dev/null
+++ b/docs/latest/_static/fonts/fontawesome-webfont.svg
@@ -0,0 +1,414 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd" >
+<svg xmlns="http://www.w3.org/2000/svg">
+<metadata></metadata>
+<defs>
+<font id="fontawesomeregular" horiz-adv-x="1536" >
+<font-face units-per-em="1792" ascent="1536" descent="-256" />
+<missing-glyph horiz-adv-x="448" />
+<glyph unicode=" " horiz-adv-x="448" />
+<glyph unicode="	" horiz-adv-x="448" />
+<glyph unicode=" " horiz-adv-x="448" />
+<glyph unicode="¨" horiz-adv-x="1792" />
+<glyph unicode="©" horiz-adv-x="1792" />
+<glyph unicode="®" horiz-adv-x="1792" />
+<glyph unicode="´" horiz-adv-x="1792" />
+<glyph unicode="Æ" horiz-adv-x="1792" />
+<glyph unicode=" " horiz-adv-x="768" />
+<glyph unicode=" " />
+<glyph unicode=" " horiz-adv-x="768" />
+<glyph unicode=" " />
+<glyph unicode=" " horiz-adv-x="512" />
+<glyph unicode=" " horiz-adv-x="384" />
+<glyph unicode=" " horiz-adv-x="256" />
+<glyph unicode=" " horiz-adv-x="256" />
+<glyph unicode=" " horiz-adv-x="192" />
+<glyph unicode=" " horiz-adv-x="307" />
+<glyph unicode=" " horiz-adv-x="85" />
+<glyph unicode=" " horiz-adv-x="307" />
+<glyph unicode=" " horiz-adv-x="384" />
+<glyph unicode="™" horiz-adv-x="1792" />
+<glyph unicode="∞" horiz-adv-x="1792" />
+<glyph unicode="≠" horiz-adv-x="1792" />
+<glyph unicode="" horiz-adv-x="500" d="M0 0z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1699 1350q0 -35 -43 -78l-632 -632v-768h320q26 0 45 -19t19 -45t-19 -45t-45 -19h-896q-26 0 -45 19t-19 45t19 45t45 19h320v768l-632 632q-43 43 -43 78q0 23 18 36.5t38 17.5t43 4h1408q23 0 43 -4t38 -17.5t18 -36.5z" />
+<glyph unicode="" d="M1536 1312v-1120q0 -50 -34 -89t-86 -60.5t-103.5 -32t-96.5 -10.5t-96.5 10.5t-103.5 32t-86 60.5t-34 89t34 89t86 60.5t103.5 32t96.5 10.5q105 0 192 -39v537l-768 -237v-709q0 -50 -34 -89t-86 -60.5t-103.5 -32t-96.5 -10.5t-96.5 10.5t-103.5 32t-86 60.5t-34 89 t34 89t86 60.5t103.5 32t96.5 10.5q105 0 192 -39v967q0 31 19 56.5t49 35.5l832 256q12 4 28 4q40 0 68 -28t28 -68z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1152 704q0 185 -131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5t316.5 131.5t131.5 316.5zM1664 -128q0 -52 -38 -90t-90 -38q-54 0 -90 38l-343 342q-179 -124 -399 -124q-143 0 -273.5 55.5t-225 150t-150 225t-55.5 273.5 t55.5 273.5t150 225t225 150t273.5 55.5t273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -220 -124 -399l343 -343q37 -37 37 -90z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1664 32v768q-32 -36 -69 -66q-268 -206 -426 -338q-51 -43 -83 -67t-86.5 -48.5t-102.5 -24.5h-1h-1q-48 0 -102.5 24.5t-86.5 48.5t-83 67q-158 132 -426 338q-37 30 -69 66v-768q0 -13 9.5 -22.5t22.5 -9.5h1472q13 0 22.5 9.5t9.5 22.5zM1664 1083v11v13.5t-0.5 13 t-3 12.5t-5.5 9t-9 7.5t-14 2.5h-1472q-13 0 -22.5 -9.5t-9.5 -22.5q0 -168 147 -284q193 -152 401 -317q6 -5 35 -29.5t46 -37.5t44.5 -31.5t50.5 -27.5t43 -9h1h1q20 0 43 9t50.5 27.5t44.5 31.5t46 37.5t35 29.5q208 165 401 317q54 43 100.5 115.5t46.5 131.5z M1792 1120v-1088q0 -66 -47 -113t-113 -47h-1472q-66 0 -113 47t-47 113v1088q0 66 47 113t113 47h1472q66 0 113 -47t47 -113z" />
+<glyph unicode="" horiz-adv-x="1792" d="M896 -128q-26 0 -44 18l-624 602q-10 8 -27.5 26t-55.5 65.5t-68 97.5t-53.5 121t-23.5 138q0 220 127 344t351 124q62 0 126.5 -21.5t120 -58t95.5 -68.5t76 -68q36 36 76 68t95.5 68.5t120 58t126.5 21.5q224 0 351 -124t127 -344q0 -221 -229 -450l-623 -600 q-18 -18 -44 -18z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1664 889q0 -22 -26 -48l-363 -354l86 -500q1 -7 1 -20q0 -21 -10.5 -35.5t-30.5 -14.5q-19 0 -40 12l-449 236l-449 -236q-22 -12 -40 -12q-21 0 -31.5 14.5t-10.5 35.5q0 6 2 20l86 500l-364 354q-25 27 -25 48q0 37 56 46l502 73l225 455q19 41 49 41t49 -41l225 -455 l502 -73q56 -9 56 -46z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1137 532l306 297l-422 62l-189 382l-189 -382l-422 -62l306 -297l-73 -421l378 199l377 -199zM1664 889q0 -22 -26 -48l-363 -354l86 -500q1 -7 1 -20q0 -50 -41 -50q-19 0 -40 12l-449 236l-449 -236q-22 -12 -40 -12q-21 0 -31.5 14.5t-10.5 35.5q0 6 2 20l86 500 l-364 354q-25 27 -25 48q0 37 56 46l502 73l225 455q19 41 49 41t49 -41l225 -455l502 -73q56 -9 56 -46z" />
+<glyph unicode="" horiz-adv-x="1408" d="M1408 131q0 -120 -73 -189.5t-194 -69.5h-874q-121 0 -194 69.5t-73 189.5q0 53 3.5 103.5t14 109t26.5 108.5t43 97.5t62 81t85.5 53.5t111.5 20q9 0 42 -21.5t74.5 -48t108 -48t133.5 -21.5t133.5 21.5t108 48t74.5 48t42 21.5q61 0 111.5 -20t85.5 -53.5t62 -81 t43 -97.5t26.5 -108.5t14 -109t3.5 -103.5zM1088 1024q0 -159 -112.5 -271.5t-271.5 -112.5t-271.5 112.5t-112.5 271.5t112.5 271.5t271.5 112.5t271.5 -112.5t112.5 -271.5z" />
+<glyph unicode="" horiz-adv-x="1920" d="M384 -64v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM384 320v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM384 704v128q0 26 -19 45t-45 19h-128 q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1408 -64v512q0 26 -19 45t-45 19h-768q-26 0 -45 -19t-19 -45v-512q0 -26 19 -45t45 -19h768q26 0 45 19t19 45zM384 1088v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45 t45 -19h128q26 0 45 19t19 45zM1792 -64v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1408 704v512q0 26 -19 45t-45 19h-768q-26 0 -45 -19t-19 -45v-512q0 -26 19 -45t45 -19h768q26 0 45 19t19 45zM1792 320v128 q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1792 704v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t1
9 45zM1792 1088v128q0 26 -19 45t-45 19h-128q-26 0 -45 -19 t-19 -45v-128q0 -26 19 -45t45 -19h128q26 0 45 19t19 45zM1920 1248v-1344q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1344q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" />
+<glyph unicode="" horiz-adv-x="1664" d="M768 512v-384q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90zM768 1280v-384q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90zM1664 512v-384q0 -52 -38 -90t-90 -38 h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90zM1664 1280v-384q0 -52 -38 -90t-90 -38h-512q-52 0 -90 38t-38 90v384q0 52 38 90t90 38h512q52 0 90 -38t38 -90z" />
+<glyph unicode="" horiz-adv-x="1792" d="M512 288v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM512 800v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1152 288v-192q0 -40 -28 -68t-68 -28h-320 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM512 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1152 800v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28 h320q40 0 68 -28t28 -68zM1792 288v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1152 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 800v-192 q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28
t28 -68z" />
+<glyph unicode="" horiz-adv-x="1792" d="M512 288v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM512 800v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 288v-192q0 -40 -28 -68t-68 -28h-960 q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h960q40 0 68 -28t28 -68zM512 1312v-192q0 -40 -28 -68t-68 -28h-320q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h320q40 0 68 -28t28 -68zM1792 800v-192q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v192q0 40 28 68t68 28 h960q40 0 68 -28t28 -68zM1792 1312v-192q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h960q40 0 68 -28t28 -68z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1671 970q0 -40 -28 -68l-724 -724l-136 -136q-28 -28 -68 -28t-68 28l-136 136l-362 362q-28 28 -28 68t28 68l136 136q28 28 68 28t68 -28l294 -295l656 657q28 28 68 28t68 -28l136 -136q28 -28 28 -68z" />
+<glyph unicode="" horiz-adv-x="1408" d="M1298 214q0 -40 -28 -68l-136 -136q-28 -28 -68 -28t-68 28l-294 294l-294 -294q-28 -28 -68 -28t-68 28l-136 136q-28 28 -28 68t28 68l294 294l-294 294q-28 28 -28 68t28 68l136 136q28 28 68 28t68 -28l294 -294l294 294q28 28 68 28t68 -28l136 -136q28 -28 28 -68 t-28 -68l-294 -294l294 -294q28 -28 28 -68z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1024 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-224v-224q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v224h-224q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h224v224q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5v-224h224 q13 0 22.5 -9.5t9.5 -22.5zM1152 704q0 185 -131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5t316.5 131.5t131.5 316.5zM1664 -128q0 -53 -37.5 -90.5t-90.5 -37.5q-54 0 -90 38l-343 342q-179 -124 -399 -124q-143 0 -273.5 55.5 t-225 150t-150 225t-55.5 273.5t55.5 273.5t150 225t225 150t273.5 55.5t273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -220 -124 -399l343 -343q37 -37 37 -90z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1024 736v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-576q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h576q13 0 22.5 -9.5t9.5 -22.5zM1152 704q0 185 -131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5t316.5 131.5t131.5 316.5z M1664 -128q0 -53 -37.5 -90.5t-90.5 -37.5q-54 0 -90 38l-343 342q-179 -124 -399 -124q-143 0 -273.5 55.5t-225 150t-150 225t-55.5 273.5t55.5 273.5t150 225t225 150t273.5 55.5t273.5 -55.5t225 -150t150 -225t55.5 -273.5q0 -220 -124 -399l343 -343q37 -37 37 -90z " />
+<glyph unicode="" d="M1536 640q0 -156 -61 -298t-164 -245t-245 -164t-298 -61t-298 61t-245 164t-164 245t-61 298q0 182 80.5 343t226.5 270q43 32 95.5 25t83.5 -50q32 -42 24.5 -94.5t-49.5 -84.5q-98 -74 -151.5 -181t-53.5 -228q0 -104 40.5 -198.5t109.5 -163.5t163.5 -109.5 t198.5 -40.5t198.5 40.5t163.5 109.5t109.5 163.5t40.5 198.5q0 121 -53.5 228t-151.5 181q-42 32 -49.5 84.5t24.5 94.5q31 43 84 50t95 -25q146 -109 226.5 -270t80.5 -343zM896 1408v-640q0 -52 -38 -90t-90 -38t-90 38t-38 90v640q0 52 38 90t90 38t90 -38t38 -90z" />
+<glyph unicode="" horiz-adv-x="1792" d="M256 96v-192q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM640 224v-320q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v320q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1024 480v-576q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23 v576q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1408 864v-960q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v960q0 14 9 23t23 9h192q14 0 23 -9t9 -23zM1792 1376v-1472q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v1472q0 14 9 23t23 9h192q14 0 23 -9t9 -23z" />
+<glyph unicode="" d="M1024 640q0 106 -75 181t-181 75t-181 -75t-75 -181t75 -181t181 -75t181 75t75 181zM1536 749v-222q0 -12 -8 -23t-20 -13l-185 -28q-19 -54 -39 -91q35 -50 107 -138q10 -12 10 -25t-9 -23q-27 -37 -99 -108t-94 -71q-12 0 -26 9l-138 108q-44 -23 -91 -38 q-16 -136 -29 -186q-7 -28 -36 -28h-222q-14 0 -24.5 8.5t-11.5 21.5l-28 184q-49 16 -90 37l-141 -107q-10 -9 -25 -9q-14 0 -25 11q-126 114 -165 168q-7 10 -7 23q0 12 8 23q15 21 51 66.5t54 70.5q-27 50 -41 99l-183 27q-13 2 -21 12.5t-8 23.5v222q0 12 8 23t19 13 l186 28q14 46 39 92q-40 57 -107 138q-10 12 -10 24q0 10 9 23q26 36 98.5 107.5t94.5 71.5q13 0 26 -10l138 -107q44 23 91 38q16 136 29 186q7 28 36 28h222q14 0 24.5 -8.5t11.5 -21.5l28 -184q49 -16 90 -37l142 107q9 9 24 9q13 0 25 -10q129 -119 165 -170q7 -8 7 -22 q0 -12 -8 -23q-15 -21 -51 -66.5t-54 -70.5q26 -50 41 -98l183 -28q13 -2 21 -12.5t8 -23.5z" />
+<glyph unicode="" horiz-adv-x="1408" d="M512 800v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM768 800v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1024 800v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576 q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1152 76v948h-896v-948q0 -22 7 -40.5t14.5 -27t10.5 -8.5h832q3 0 10.5 8.5t14.5 27t7 40.5zM480 1152h448l-48 117q-7 9 -17 11h-317q-10 -2 -17 -11zM1408 1120v-64q0 -14 -9 -23t-23 -9h-96v-948q0 -83 -47 -143.5t-113 -60.5h-832 q-66 0 -113 58.5t-47 141.5v952h-96q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h309l70 167q15 37 54 63t79 26h320q40 0 79 -26t54 -63l70 -167h309q14 0 23 -9t9 -23z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1408 544v-480q0 -26 -19 -45t-45 -19h-384v384h-256v-384h-384q-26 0 -45 19t-19 45v480q0 1 0.5 3t0.5 3l575 474l575 -474q1 -2 1 -6zM1631 613l-62 -74q-8 -9 -21 -11h-3q-13 0 -21 7l-692 577l-692 -577q-12 -8 -24 -7q-13 2 -21 11l-62 74q-8 10 -7 23.5t11 21.5 l719 599q32 26 76 26t76 -26l244 -204v195q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-408l219 -182q10 -8 11 -21.5t-7 -23.5z" />
+<glyph unicode="" horiz-adv-x="1280" d="M128 0h1024v768h-416q-40 0 -68 28t-28 68v416h-512v-1280zM768 896h376q-10 29 -22 41l-313 313q-12 12 -41 22v-376zM1280 864v-896q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v1344q0 40 28 68t68 28h640q40 0 88 -20t76 -48l312 -312q28 -28 48 -76t20 -88z " />
+<glyph unicode="" d="M896 992v-448q0 -14 -9 -23t-23 -9h-320q-14 0 -23 9t-9 23v64q0 14 9 23t23 9h224v352q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" horiz-adv-x="1920" d="M1111 540v4l-24 320q-1 13 -11 22.5t-23 9.5h-186q-13 0 -23 -9.5t-11 -22.5l-24 -320v-4q-1 -12 8 -20t21 -8h244q12 0 21 8t8 20zM1870 73q0 -73 -46 -73h-704q13 0 22 9.5t8 22.5l-20 256q-1 13 -11 22.5t-23 9.5h-272q-13 0 -23 -9.5t-11 -22.5l-20 -256 q-1 -13 8 -22.5t22 -9.5h-704q-46 0 -46 73q0 54 26 116l417 1044q8 19 26 33t38 14h339q-13 0 -23 -9.5t-11 -22.5l-15 -192q-1 -14 8 -23t22 -9h166q13 0 22 9t8 23l-15 192q-1 13 -11 22.5t-23 9.5h339q20 0 38 -14t26 -33l417 -1044q26 -62 26 -116z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1280 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1536 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 416v-320q0 -40 -28 -68t-68 -28h-1472q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h465l135 -136 q58 -56 136 -56t136 56l136 136h464q40 0 68 -28t28 -68zM1339 985q17 -41 -14 -70l-448 -448q-18 -19 -45 -19t-45 19l-448 448q-31 29 -14 70q17 39 59 39h256v448q0 26 19 45t45 19h256q26 0 45 -19t19 -45v-448h256q42 0 59 -39z" />
+<glyph unicode="" d="M1120 608q0 -12 -10 -24l-319 -319q-11 -9 -23 -9t-23 9l-320 320q-15 16 -7 35q8 20 30 20h192v352q0 14 9 23t23 9h192q14 0 23 -9t9 -23v-352h192q14 0 23 -9t9 -23zM768 1184q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273 t-73 273t-198 198t-273 73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1118 660q-8 -20 -30 -20h-192v-352q0 -14 -9 -23t-23 -9h-192q-14 0 -23 9t-9 23v352h-192q-14 0 -23 9t-9 23q0 12 10 24l319 319q11 9 23 9t23 -9l320 -320q15 -16 7 -35zM768 1184q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198 t73 273t-73 273t-198 198t-273 73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1023 576h316q-1 3 -2.5 8t-2.5 8l-212 496h-708l-212 -496q-1 -2 -2.5 -8t-2.5 -8h316l95 -192h320zM1536 546v-482q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v482q0 62 25 123l238 552q10 25 36.5 42t52.5 17h832q26 0 52.5 -17t36.5 -42l238 -552 q25 -61 25 -123z" />
+<glyph unicode="" d="M1184 640q0 -37 -32 -55l-544 -320q-15 -9 -32 -9q-16 0 -32 8q-32 19 -32 56v640q0 37 32 56q33 18 64 -1l544 -320q32 -18 32 -55zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1536 1280v-448q0 -26 -19 -45t-45 -19h-448q-42 0 -59 40q-17 39 14 69l138 138q-148 137 -349 137q-104 0 -198.5 -40.5t-163.5 -109.5t-109.5 -163.5t-40.5 -198.5t40.5 -198.5t109.5 -163.5t163.5 -109.5t198.5 -40.5q119 0 225 52t179 147q7 10 23 12q14 0 25 -9 l137 -138q9 -8 9.5 -20.5t-7.5 -22.5q-109 -132 -264 -204.5t-327 -72.5q-156 0 -298 61t-245 164t-164 245t-61 298t61 298t164 245t245 164t298 61q147 0 284.5 -55.5t244.5 -156.5l130 129q29 31 70 14q39 -17 39 -59z" />
+<glyph unicode="" d="M1511 480q0 -5 -1 -7q-64 -268 -268 -434.5t-478 -166.5q-146 0 -282.5 55t-243.5 157l-129 -129q-19 -19 -45 -19t-45 19t-19 45v448q0 26 19 45t45 19h448q26 0 45 -19t19 -45t-19 -45l-137 -137q71 -66 161 -102t187 -36q134 0 250 65t186 179q11 17 53 117 q8 23 30 23h192q13 0 22.5 -9.5t9.5 -22.5zM1536 1280v-448q0 -26 -19 -45t-45 -19h-448q-26 0 -45 19t-19 45t19 45l138 138q-148 137 -349 137q-134 0 -250 -65t-186 -179q-11 -17 -53 -117q-8 -23 -30 -23h-199q-13 0 -22.5 9.5t-9.5 22.5v7q65 268 270 434.5t480 166.5 q146 0 284 -55.5t245 -156.5l130 129q19 19 45 19t45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1792" d="M384 352v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM384 608v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5z M384 864v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h64q13 0 22.5 -9.5t9.5 -22.5zM1536 352v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h960q13 0 22.5 -9.5t9.5 -22.5z M1536 608v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h960q13 0 22.5 -9.5t9.5 -22.5zM1536 864v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h960q13 0 22.5 -9.5 t9.5 -22.5zM1664 160v832q0 13 -9.5 22.5t-22.5 9.5h-1472q-13 0 -22.5 -9.5t-9.5 -22.5v-832q0 -13 9.5 -22.5t22.5 -9.5h1472q13 0 22.5 9.5t9.5 22.5zM1792 1248v-1088q0 -66 -47 -113t-113 -47h-1472q-66 0 -1
13 47t-47 113v1088q0 66 47 113t113 47h1472q66 0 113 -47 t47 -113z" />
+<glyph unicode="" horiz-adv-x="1152" d="M320 768h512v192q0 106 -75 181t-181 75t-181 -75t-75 -181v-192zM1152 672v-576q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v576q0 40 28 68t68 28h32v192q0 184 132 316t316 132t316 -132t132 -316v-192h32q40 0 68 -28t28 -68z" />
+<glyph unicode="" horiz-adv-x="1792" d="M320 1280q0 -72 -64 -110v-1266q0 -13 -9.5 -22.5t-22.5 -9.5h-64q-13 0 -22.5 9.5t-9.5 22.5v1266q-64 38 -64 110q0 53 37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1792 1216v-763q0 -25 -12.5 -38.5t-39.5 -27.5q-215 -116 -369 -116q-61 0 -123.5 22t-108.5 48 t-115.5 48t-142.5 22q-192 0 -464 -146q-17 -9 -33 -9q-26 0 -45 19t-19 45v742q0 32 31 55q21 14 79 43q236 120 421 120q107 0 200 -29t219 -88q38 -19 88 -19q54 0 117.5 21t110 47t88 47t54.5 21q26 0 45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1664 650q0 -166 -60 -314l-20 -49l-185 -33q-22 -83 -90.5 -136.5t-156.5 -53.5v-32q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v576q0 14 9 23t23 9h64q14 0 23 -9t9 -23v-32q71 0 130 -35.5t93 -95.5l68 12q29 95 29 193q0 148 -88 279t-236.5 209t-315.5 78 t-315.5 -78t-236.5 -209t-88 -279q0 -98 29 -193l68 -12q34 60 93 95.5t130 35.5v32q0 14 9 23t23 9h64q14 0 23 -9t9 -23v-576q0 -14 -9 -23t-23 -9h-64q-14 0 -23 9t-9 23v32q-88 0 -156.5 53.5t-90.5 136.5l-185 33l-20 49q-60 148 -60 314q0 151 67 291t179 242.5 t266 163.5t320 61t320 -61t266 -163.5t179 -242.5t67 -291z" />
+<glyph unicode="" horiz-adv-x="768" d="M768 1184v-1088q0 -26 -19 -45t-45 -19t-45 19l-333 333h-262q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h262l333 333q19 19 45 19t45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1152" d="M768 1184v-1088q0 -26 -19 -45t-45 -19t-45 19l-333 333h-262q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h262l333 333q19 19 45 19t45 -19t19 -45zM1152 640q0 -76 -42.5 -141.5t-112.5 -93.5q-10 -5 -25 -5q-26 0 -45 18.5t-19 45.5q0 21 12 35.5t29 25t34 23t29 35.5 t12 57t-12 57t-29 35.5t-34 23t-29 25t-12 35.5q0 27 19 45.5t45 18.5q15 0 25 -5q70 -27 112.5 -93t42.5 -142z" />
+<glyph unicode="" horiz-adv-x="1664" d="M768 1184v-1088q0 -26 -19 -45t-45 -19t-45 19l-333 333h-262q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h262l333 333q19 19 45 19t45 -19t19 -45zM1152 640q0 -76 -42.5 -141.5t-112.5 -93.5q-10 -5 -25 -5q-26 0 -45 18.5t-19 45.5q0 21 12 35.5t29 25t34 23t29 35.5 t12 57t-12 57t-29 35.5t-34 23t-29 25t-12 35.5q0 27 19 45.5t45 18.5q15 0 25 -5q70 -27 112.5 -93t42.5 -142zM1408 640q0 -153 -85 -282.5t-225 -188.5q-13 -5 -25 -5q-27 0 -46 19t-19 45q0 39 39 59q56 29 76 44q74 54 115.5 135.5t41.5 173.5t-41.5 173.5 t-115.5 135.5q-20 15 -76 44q-39 20 -39 59q0 26 19 45t45 19q13 0 26 -5q140 -59 225 -188.5t85 -282.5zM1664 640q0 -230 -127 -422.5t-338 -283.5q-13 -5 -26 -5q-26 0 -45 19t-19 45q0 36 39 59q7 4 22.5 10.5t22.5 10.5q46 25 82 51q123 91 192 227t69 289t-69 289 t-192 227q-36 26 -82 51q-7 4 -22.5 10.5t-22.5 10.5q-39 23 -39 59q0 26 19 45t45 19q13 0 26 -5q211 -91 338 -283.5t127 -422.5z" />
+<glyph unicode="" horiz-adv-x="1408" d="M384 384v-128h-128v128h128zM384 1152v-128h-128v128h128zM1152 1152v-128h-128v128h128zM128 129h384v383h-384v-383zM128 896h384v384h-384v-384zM896 896h384v384h-384v-384zM640 640v-640h-640v640h640zM1152 128v-128h-128v128h128zM1408 128v-128h-128v128h128z M1408 640v-384h-384v128h-128v-384h-128v640h384v-128h128v128h128zM640 1408v-640h-640v640h640zM1408 1408v-640h-640v640h640z" />
+<glyph unicode="" horiz-adv-x="1792" d="M63 0h-63v1408h63v-1408zM126 1h-32v1407h32v-1407zM220 1h-31v1407h31v-1407zM377 1h-31v1407h31v-1407zM534 1h-62v1407h62v-1407zM660 1h-31v1407h31v-1407zM723 1h-31v1407h31v-1407zM786 1h-31v1407h31v-1407zM943 1h-63v1407h63v-1407zM1100 1h-63v1407h63v-1407z M1226 1h-63v1407h63v-1407zM1352 1h-63v1407h63v-1407zM1446 1h-63v1407h63v-1407zM1635 1h-94v1407h94v-1407zM1698 1h-32v1407h32v-1407zM1792 0h-63v1408h63v-1408z" />
+<glyph unicode="" d="M448 1088q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1515 512q0 -53 -37 -90l-491 -492q-39 -37 -91 -37q-53 0 -90 37l-715 716q-38 37 -64.5 101t-26.5 117v416q0 52 38 90t90 38h416q53 0 117 -26.5t102 -64.5 l715 -714q37 -39 37 -91z" />
+<glyph unicode="" horiz-adv-x="1920" d="M448 1088q0 53 -37.5 90.5t-90.5 37.5t-90.5 -37.5t-37.5 -90.5t37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1515 512q0 -53 -37 -90l-491 -492q-39 -37 -91 -37q-53 0 -90 37l-715 716q-38 37 -64.5 101t-26.5 117v416q0 52 38 90t90 38h416q53 0 117 -26.5t102 -64.5 l715 -714q37 -39 37 -91zM1899 512q0 -53 -37 -90l-491 -492q-39 -37 -91 -37q-36 0 -59 14t-53 45l470 470q37 37 37 90q0 52 -37 91l-715 714q-38 38 -102 64.5t-117 26.5h224q53 0 117 -26.5t102 -64.5l715 -714q37 -39 37 -91z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1639 1058q40 -57 18 -129l-275 -906q-19 -64 -76.5 -107.5t-122.5 -43.5h-923q-77 0 -148.5 53.5t-99.5 131.5q-24 67 -2 127q0 4 3 27t4 37q1 8 -3 21.5t-3 19.5q2 11 8 21t16.5 23.5t16.5 23.5q23 38 45 91.5t30 91.5q3 10 0.5 30t-0.5 28q3 11 17 28t17 23 q21 36 42 92t25 90q1 9 -2.5 32t0.5 28q4 13 22 30.5t22 22.5q19 26 42.5 84.5t27.5 96.5q1 8 -3 25.5t-2 26.5q2 8 9 18t18 23t17 21q8 12 16.5 30.5t15 35t16 36t19.5 32t26.5 23.5t36 11.5t47.5 -5.5l-1 -3q38 9 51 9h761q74 0 114 -56t18 -130l-274 -906 q-36 -119 -71.5 -153.5t-128.5 -34.5h-869q-27 0 -38 -15q-11 -16 -1 -43q24 -70 144 -70h923q29 0 56 15.5t35 41.5l300 987q7 22 5 57q38 -15 59 -43zM575 1056q-4 -13 2 -22.5t20 -9.5h608q13 0 25.5 9.5t16.5 22.5l21 64q4 13 -2 22.5t-20 9.5h-608q-13 0 -25.5 -9.5 t-16.5 -22.5zM492 800q-4 -13 2 -22.5t20 -9.5h608q13 0 25.5 9.5t16.5 22.5l21 64q4 13 -2 22.5t-20 9.5h-608q-13 0 -25.5 -9.5t-16.5 -22.5z" />
+<glyph unicode="" horiz-adv-x="1280" d="M1164 1408q23 0 44 -9q33 -13 52.5 -41t19.5 -62v-1289q0 -34 -19.5 -62t-52.5 -41q-19 -8 -44 -8q-48 0 -83 32l-441 424l-441 -424q-36 -33 -83 -33q-23 0 -44 9q-33 13 -52.5 41t-19.5 62v1289q0 34 19.5 62t52.5 41q21 9 44 9h1048z" />
+<glyph unicode="" horiz-adv-x="1664" d="M384 0h896v256h-896v-256zM384 640h896v384h-160q-40 0 -68 28t-28 68v160h-640v-640zM1536 576q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 576v-416q0 -13 -9.5 -22.5t-22.5 -9.5h-224v-160q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68 v160h-224q-13 0 -22.5 9.5t-9.5 22.5v416q0 79 56.5 135.5t135.5 56.5h64v544q0 40 28 68t68 28h672q40 0 88 -20t76 -48l152 -152q28 -28 48 -76t20 -88v-256h64q79 0 135.5 -56.5t56.5 -135.5z" />
+<glyph unicode="" horiz-adv-x="1920" d="M960 864q119 0 203.5 -84.5t84.5 -203.5t-84.5 -203.5t-203.5 -84.5t-203.5 84.5t-84.5 203.5t84.5 203.5t203.5 84.5zM1664 1280q106 0 181 -75t75 -181v-896q0 -106 -75 -181t-181 -75h-1408q-106 0 -181 75t-75 181v896q0 106 75 181t181 75h224l51 136 q19 49 69.5 84.5t103.5 35.5h512q53 0 103.5 -35.5t69.5 -84.5l51 -136h224zM960 128q185 0 316.5 131.5t131.5 316.5t-131.5 316.5t-316.5 131.5t-316.5 -131.5t-131.5 -316.5t131.5 -316.5t316.5 -131.5z" />
+<glyph unicode="" horiz-adv-x="1664" d="M725 977l-170 -450q73 -1 153.5 -2t119 -1.5t52.5 -0.5l29 2q-32 95 -92 241q-53 132 -92 211zM21 -128h-21l2 79q22 7 80 18q89 16 110 31q20 16 48 68l237 616l280 724h75h53l11 -21l205 -480q103 -242 124 -297q39 -102 96 -235q26 -58 65 -164q24 -67 65 -149 q22 -49 35 -57q22 -19 69 -23q47 -6 103 -27q6 -39 6 -57q0 -14 -1 -26q-80 0 -192 8q-93 8 -189 8q-79 0 -135 -2l-200 -11l-58 -2q0 45 4 78l131 28q56 13 68 23q12 12 12 27t-6 32l-47 114l-92 228l-450 2q-29 -65 -104 -274q-23 -64 -23 -84q0 -31 17 -43 q26 -21 103 -32q3 0 13.5 -2t30 -5t40.5 -6q1 -28 1 -58q0 -17 -2 -27q-66 0 -349 20l-48 -8q-81 -14 -167 -14z" />
+<glyph unicode="" horiz-adv-x="1408" d="M555 15q76 -32 140 -32q131 0 216 41t122 113q38 70 38 181q0 114 -41 180q-58 94 -141 126q-80 32 -247 32q-74 0 -101 -10v-144l-1 -173l3 -270q0 -15 12 -44zM541 761q43 -7 109 -7q175 0 264 65t89 224q0 112 -85 187q-84 75 -255 75q-52 0 -130 -13q0 -44 2 -77 q7 -122 6 -279l-1 -98q0 -43 1 -77zM0 -128l2 94q45 9 68 12q77 12 123 31q17 27 21 51q9 66 9 194l-2 497q-5 256 -9 404q-1 87 -11 109q-1 4 -12 12q-18 12 -69 15q-30 2 -114 13l-4 83l260 6l380 13l45 1q5 0 14 0.5t14 0.5q1 0 21.5 -0.5t40.5 -0.5h74q88 0 191 -27 q43 -13 96 -39q57 -29 102 -76q44 -47 65 -104t21 -122q0 -70 -32 -128t-95 -105q-26 -20 -150 -77q177 -41 267 -146q92 -106 92 -236q0 -76 -29 -161q-21 -62 -71 -117q-66 -72 -140 -108q-73 -36 -203 -60q-82 -15 -198 -11l-197 4q-84 2 -298 -11q-33 -3 -272 -11z" />
+<glyph unicode="" horiz-adv-x="1024" d="M0 -126l17 85q4 1 77 20q76 19 116 39q29 37 41 101l27 139l56 268l12 64q8 44 17 84.5t16 67t12.5 46.5t9 30.5t3.5 11.5l29 157l16 63l22 135l8 50v38q-41 22 -144 28q-28 2 -38 4l19 103l317 -14q39 -2 73 -2q66 0 214 9q33 2 68 4.5t36 2.5q-2 -19 -6 -38 q-7 -29 -13 -51q-55 -19 -109 -31q-64 -16 -101 -31q-12 -31 -24 -88q-9 -44 -13 -82q-44 -199 -66 -306l-61 -311l-38 -158l-43 -235l-12 -45q-2 -7 1 -27q64 -15 119 -21q36 -5 66 -10q-1 -29 -7 -58q-7 -31 -9 -41q-18 0 -23 -1q-24 -2 -42 -2q-9 0 -28 3q-19 4 -145 17 l-198 2q-41 1 -174 -11q-74 -7 -98 -9z" />
+<glyph unicode="" horiz-adv-x="1792" d="M81 1407l54 -27q20 -5 211 -5h130l19 3l115 1l215 -1h293l34 -2q14 -1 28 7t21 16l7 8l42 1q15 0 28 -1v-104.5t1 -131.5l1 -100l-1 -58q0 -32 -4 -51q-39 -15 -68 -18q-25 43 -54 128q-8 24 -15.5 62.5t-11.5 65.5t-6 29q-13 15 -27 19q-7 2 -42.5 2t-103.5 -1t-111 -1 q-34 0 -67 -5q-10 -97 -8 -136l1 -152v-332l3 -359l-1 -147q-1 -46 11 -85q49 -25 89 -32q2 0 18 -5t44 -13t43 -12q30 -8 50 -18q5 -45 5 -50q0 -10 -3 -29q-14 -1 -34 -1q-110 0 -187 10q-72 8 -238 8q-88 0 -233 -14q-48 -4 -70 -4q-2 22 -2 26l-1 26v9q21 33 79 49 q139 38 159 50q9 21 12 56q8 192 6 433l-5 428q-1 62 -0.5 118.5t0.5 102.5t-2 57t-6 15q-6 5 -14 6q-38 6 -148 6q-43 0 -100 -13.5t-73 -24.5q-13 -9 -22 -33t-22 -75t-24 -84q-6 -19 -19.5 -32t-20.5 -13q-44 27 -56 44v297v86zM1744 128q33 0 42 -18.5t-11 -44.5 l-126 -162q-20 -26 -49 -26t-49 26l-126 162q-20 26 -11 44.5t42 18.5h80v1024h-80q-33 0 -42 18.5t11 44.5l126 162q20 26 49 26t49 -26l126 -162q20 -26 11 -44.5t-42 -18.5h-80v-1024h80z" />
+<glyph unicode="" d="M81 1407l54 -27q20 -5 211 -5h130l19 3l115 1l446 -1h318l34 -2q14 -1 28 7t21 16l7 8l42 1q15 0 28 -1v-104.5t1 -131.5l1 -100l-1 -58q0 -32 -4 -51q-39 -15 -68 -18q-25 43 -54 128q-8 24 -15.5 62.5t-11.5 65.5t-6 29q-13 15 -27 19q-7 2 -58.5 2t-138.5 -1t-128 -1 q-94 0 -127 -5q-10 -97 -8 -136l1 -152v52l3 -359l-1 -147q-1 -46 11 -85q49 -25 89 -32q2 0 18 -5t44 -13t43 -12q30 -8 50 -18q5 -45 5 -50q0 -10 -3 -29q-14 -1 -34 -1q-110 0 -187 10q-72 8 -238 8q-82 0 -233 -13q-45 -5 -70 -5q-2 22 -2 26l-1 26v9q21 33 79 49 q139 38 159 50q9 21 12 56q6 137 6 433l-5 44q0 265 -2 278q-2 11 -6 15q-6 5 -14 6q-38 6 -148 6q-50 0 -168.5 -14t-132.5 -24q-13 -9 -22 -33t-22 -75t-24 -84q-6 -19 -19.5 -32t-20.5 -13q-44 27 -56 44v297v86zM1505 113q26 -20 26 -49t-26 -49l-162 -126 q-26 -20 -44.5 -11t-18.5 42v80h-1024v-80q0 -33 -18.5 -42t-44.5 11l-162 126q-26 20 -26 49t26 49l162 126q26 20 44.5 11t18.5 -42v-80h1024v80q0 33 18.5 42t44.5 -11z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1408 576v-128q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1280q26 0 45 -19t19 -45zM1664 960v-128q0 -26 -19 -45 t-45 -19h-1536q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1536q26 0 45 -19t19 -45zM1280 1344v-128q0 -26 -19 -45t-45 -19h-1152q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1408 576v-128q0 -26 -19 -45t-45 -19h-896q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h896q26 0 45 -19t19 -45zM1664 960v-128q0 -26 -19 -45t-45 -19 h-1408q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1408q26 0 45 -19t19 -45zM1280 1344v-128q0 -26 -19 -45t-45 -19h-640q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h640q26 0 45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 576v-128q0 -26 -19 -45t-45 -19h-1280q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1280q26 0 45 -19t19 -45zM1792 960v-128q0 -26 -19 -45 t-45 -19h-1536q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1536q26 0 45 -19t19 -45zM1792 1344v-128q0 -26 -19 -45t-45 -19h-1152q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1152q26 0 45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1792 192v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 576v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 960v-128q0 -26 -19 -45 t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45zM1792 1344v-128q0 -26 -19 -45t-45 -19h-1664q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h1664q26 0 45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1792" d="M256 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5t9.5 -22.5zM256 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5 t9.5 -22.5zM256 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5t9.5 -22.5zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1344 q13 0 22.5 -9.5t9.5 -22.5zM256 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-192q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h192q13 0 22.5 -9.5t9.5 -22.5zM1792 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5 t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5zM1792 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5zM1792 1376v-192q0 -13 -9.5 -22.5t
-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v192 q0 13 9.5 22.5t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5z" />
+<glyph unicode="" horiz-adv-x="1792" d="M384 992v-576q0 -13 -9.5 -22.5t-22.5 -9.5q-14 0 -23 9l-288 288q-9 9 -9 23t9 23l288 288q9 9 23 9q13 0 22.5 -9.5t9.5 -22.5zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5 t9.5 -22.5zM1792 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088q13 0 22.5 -9.5t9.5 -22.5zM1792 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088 q13 0 22.5 -9.5t9.5 -22.5zM1792 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5t9.5 -22.5z" />
+<glyph unicode="" horiz-adv-x="1792" d="M352 704q0 -14 -9 -23l-288 -288q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5v576q0 13 9.5 22.5t22.5 9.5q14 0 23 -9l288 -288q9 -9 9 -23zM1792 224v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5 t9.5 -22.5zM1792 608v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088q13 0 22.5 -9.5t9.5 -22.5zM1792 992v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1088q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1088 q13 0 22.5 -9.5t9.5 -22.5zM1792 1376v-192q0 -13 -9.5 -22.5t-22.5 -9.5h-1728q-13 0 -22.5 9.5t-9.5 22.5v192q0 13 9.5 22.5t22.5 9.5h1728q13 0 22.5 -9.5t9.5 -22.5z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1792 1184v-1088q0 -42 -39 -59q-13 -5 -25 -5q-27 0 -45 19l-403 403v-166q0 -119 -84.5 -203.5t-203.5 -84.5h-704q-119 0 -203.5 84.5t-84.5 203.5v704q0 119 84.5 203.5t203.5 84.5h704q119 0 203.5 -84.5t84.5 -203.5v-165l403 402q18 19 45 19q12 0 25 -5 q39 -17 39 -59z" />
+<glyph unicode="" horiz-adv-x="1920" d="M640 960q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM1664 576v-448h-1408v192l320 320l160 -160l512 512zM1760 1280h-1600q-13 0 -22.5 -9.5t-9.5 -22.5v-1216q0 -13 9.5 -22.5t22.5 -9.5h1600q13 0 22.5 9.5t9.5 22.5v1216 q0 13 -9.5 22.5t-22.5 9.5zM1920 1248v-1216q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" />
+<glyph unicode="" d="M363 0l91 91l-235 235l-91 -91v-107h128v-128h107zM886 928q0 22 -22 22q-10 0 -17 -7l-542 -542q-7 -7 -7 -17q0 -22 22 -22q10 0 17 7l542 542q7 7 7 17zM832 1120l416 -416l-832 -832h-416v416zM1515 1024q0 -53 -37 -90l-166 -166l-416 416l166 165q36 38 90 38 q53 0 91 -38l235 -234q37 -39 37 -91z" />
+<glyph unicode="" horiz-adv-x="1024" d="M768 896q0 106 -75 181t-181 75t-181 -75t-75 -181t75 -181t181 -75t181 75t75 181zM1024 896q0 -109 -33 -179l-364 -774q-16 -33 -47.5 -52t-67.5 -19t-67.5 19t-46.5 52l-365 774q-33 70 -33 179q0 212 150 362t362 150t362 -150t150 -362z" />
+<glyph unicode="" d="M768 96v1088q-148 0 -273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" horiz-adv-x="1024" d="M512 384q0 36 -20 69q-1 1 -15.5 22.5t-25.5 38t-25 44t-21 50.5q-4 16 -21 16t-21 -16q-7 -23 -21 -50.5t-25 -44t-25.5 -38t-15.5 -22.5q-20 -33 -20 -69q0 -53 37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1024 512q0 -212 -150 -362t-362 -150t-362 150t-150 362 q0 145 81 275q6 9 62.5 90.5t101 151t99.5 178t83 201.5q9 30 34 47t51 17t51.5 -17t33.5 -47q28 -93 83 -201.5t99.5 -178t101 -151t62.5 -90.5q81 -127 81 -275z" />
+<glyph unicode="" horiz-adv-x="1792" d="M888 352l116 116l-152 152l-116 -116v-56h96v-96h56zM1328 1072q-16 16 -33 -1l-350 -350q-17 -17 -1 -33t33 1l350 350q17 17 1 33zM1408 478v-190q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832 q63 0 117 -25q15 -7 18 -23q3 -17 -9 -29l-49 -49q-14 -14 -32 -8q-23 6 -45 6h-832q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v126q0 13 9 22l64 64q15 15 35 7t20 -29zM1312 1216l288 -288l-672 -672h-288v288zM1756 1084l-92 -92 l-288 288l92 92q28 28 68 28t68 -28l152 -152q28 -28 28 -68t-28 -68z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1408 547v-259q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h255v0q13 0 22.5 -9.5t9.5 -22.5q0 -27 -26 -32q-77 -26 -133 -60q-10 -4 -16 -4h-112q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832 q66 0 113 47t47 113v214q0 19 18 29q28 13 54 37q16 16 35 8q21 -9 21 -29zM1645 1043l-384 -384q-18 -19 -45 -19q-12 0 -25 5q-39 17 -39 59v192h-160q-323 0 -438 -131q-119 -137 -74 -473q3 -23 -20 -34q-8 -2 -12 -2q-16 0 -26 13q-10 14 -21 31t-39.5 68.5t-49.5 99.5 t-38.5 114t-17.5 122q0 49 3.5 91t14 90t28 88t47 81.5t68.5 74t94.5 61.5t124.5 48.5t159.5 30.5t196.5 11h160v192q0 42 39 59q13 5 25 5q26 0 45 -19l384 -384q19 -19 19 -45t-19 -45z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1408 606v-318q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832q63 0 117 -25q15 -7 18 -23q3 -17 -9 -29l-49 -49q-10 -10 -23 -10q-3 0 -9 2q-23 6 -45 6h-832q-66 0 -113 -47t-47 -113v-832 q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v254q0 13 9 22l64 64q10 10 23 10q6 0 12 -3q20 -8 20 -29zM1639 1095l-814 -814q-24 -24 -57 -24t-57 24l-430 430q-24 24 -24 57t24 57l110 110q24 24 57 24t57 -24l263 -263l647 647q24 24 57 24t57 -24l110 -110 q24 -24 24 -57t-24 -57z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1792 640q0 -26 -19 -45l-256 -256q-19 -19 -45 -19t-45 19t-19 45v128h-384v-384h128q26 0 45 -19t19 -45t-19 -45l-256 -256q-19 -19 -45 -19t-45 19l-256 256q-19 19 -19 45t19 45t45 19h128v384h-384v-128q0 -26 -19 -45t-45 -19t-45 19l-256 256q-19 19 -19 45 t19 45l256 256q19 19 45 19t45 -19t19 -45v-128h384v384h-128q-26 0 -45 19t-19 45t19 45l256 256q19 19 45 19t45 -19l256 -256q19 -19 19 -45t-19 -45t-45 -19h-128v-384h384v128q0 26 19 45t45 19t45 -19l256 -256q19 -19 19 -45z" />
+<glyph unicode="" horiz-adv-x="1024" d="M979 1395q19 19 32 13t13 -32v-1472q0 -26 -13 -32t-32 13l-710 710q-9 9 -13 19v-678q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-678q4 11 13 19z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1747 1395q19 19 32 13t13 -32v-1472q0 -26 -13 -32t-32 13l-710 710q-9 9 -13 19v-710q0 -26 -13 -32t-32 13l-710 710q-9 9 -13 19v-678q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-678q4 11 13 19l710 710 q19 19 32 13t13 -32v-710q4 11 13 19z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1619 1395q19 19 32 13t13 -32v-1472q0 -26 -13 -32t-32 13l-710 710q-8 9 -13 19v-710q0 -26 -13 -32t-32 13l-710 710q-19 19 -19 45t19 45l710 710q19 19 32 13t13 -32v-710q5 11 13 19z" />
+<glyph unicode="" horiz-adv-x="1408" d="M1384 609l-1328 -738q-23 -13 -39.5 -3t-16.5 36v1472q0 26 16.5 36t39.5 -3l1328 -738q23 -13 23 -31t-23 -31z" />
+<glyph unicode="" d="M1536 1344v-1408q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h512q26 0 45 -19t19 -45zM640 1344v-1408q0 -26 -19 -45t-45 -19h-512q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h512q26 0 45 -19t19 -45z" />
+<glyph unicode="" d="M1536 1344v-1408q0 -26 -19 -45t-45 -19h-1408q-26 0 -45 19t-19 45v1408q0 26 19 45t45 19h1408q26 0 45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1664" d="M45 -115q-19 -19 -32 -13t-13 32v1472q0 26 13 32t32 -13l710 -710q8 -8 13 -19v710q0 26 13 32t32 -13l710 -710q19 -19 19 -45t-19 -45l-710 -710q-19 -19 -32 -13t-13 32v710q-5 -10 -13 -19z" />
+<glyph unicode="" horiz-adv-x="1792" d="M45 -115q-19 -19 -32 -13t-13 32v1472q0 26 13 32t32 -13l710 -710q8 -8 13 -19v710q0 26 13 32t32 -13l710 -710q8 -8 13 -19v678q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-1408q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v678q-5 -10 -13 -19l-710 -710 q-19 -19 -32 -13t-13 32v710q-5 -10 -13 -19z" />
+<glyph unicode="" horiz-adv-x="1024" d="M45 -115q-19 -19 -32 -13t-13 32v1472q0 26 13 32t32 -13l710 -710q8 -8 13 -19v678q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-1408q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v678q-5 -10 -13 -19z" />
+<glyph unicode="" horiz-adv-x="1538" d="M14 557l710 710q19 19 45 19t45 -19l710 -710q19 -19 13 -32t-32 -13h-1472q-26 0 -32 13t13 32zM1473 0h-1408q-26 0 -45 19t-19 45v256q0 26 19 45t45 19h1408q26 0 45 -19t19 -45v-256q0 -26 -19 -45t-45 -19z" />
+<glyph unicode="" horiz-adv-x="1152" d="M742 -37l-652 651q-37 37 -37 90.5t37 90.5l652 651q37 37 90.5 37t90.5 -37l75 -75q37 -37 37 -90.5t-37 -90.5l-486 -486l486 -485q37 -38 37 -91t-37 -90l-75 -75q-37 -37 -90.5 -37t-90.5 37z" />
+<glyph unicode="" horiz-adv-x="1152" d="M1099 704q0 -52 -37 -91l-652 -651q-37 -37 -90 -37t-90 37l-76 75q-37 39 -37 91q0 53 37 90l486 486l-486 485q-37 39 -37 91q0 53 37 90l76 75q36 38 90 38t90 -38l652 -651q37 -37 37 -90z" />
+<glyph unicode="" d="M1216 576v128q0 26 -19 45t-45 19h-256v256q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-256h-256q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h256v-256q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v256h256q26 0 45 19t19 45zM1536 640q0 -209 -103 -385.5 t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1216 576v128q0 26 -19 45t-45 19h-768q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h768q26 0 45 19t19 45zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5 t103 -385.5z" />
+<glyph unicode="" d="M1149 414q0 26 -19 45l-181 181l181 181q19 19 19 45q0 27 -19 46l-90 90q-19 19 -46 19q-26 0 -45 -19l-181 -181l-181 181q-19 19 -45 19q-27 0 -46 -19l-90 -90q-19 -19 -19 -46q0 -26 19 -45l181 -181l-181 -181q-19 -19 -19 -45q0 -27 19 -46l90 -90q19 -19 46 -19 q26 0 45 19l181 181l181 -181q19 -19 45 -19q27 0 46 19l90 90q19 19 19 46zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1284 802q0 28 -18 46l-91 90q-19 19 -45 19t-45 -19l-408 -407l-226 226q-19 19 -45 19t-45 -19l-91 -90q-18 -18 -18 -46q0 -27 18 -45l362 -362q19 -19 45 -19q27 0 46 19l543 543q18 18 18 45zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103 t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M896 160v192q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-192q0 -14 9 -23t23 -9h192q14 0 23 9t9 23zM1152 832q0 88 -55.5 163t-138.5 116t-170 41q-243 0 -371 -213q-15 -24 8 -42l132 -100q7 -6 19 -6q16 0 25 12q53 68 86 92q34 24 86 24q48 0 85.5 -26t37.5 -59 q0 -38 -20 -61t-68 -45q-63 -28 -115.5 -86.5t-52.5 -125.5v-36q0 -14 9 -23t23 -9h192q14 0 23 9t9 23q0 19 21.5 49.5t54.5 49.5q32 18 49 28.5t46 35t44.5 48t28 60.5t12.5 81zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5 t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1024 160v160q0 14 -9 23t-23 9h-96v512q0 14 -9 23t-23 9h-320q-14 0 -23 -9t-9 -23v-160q0 -14 9 -23t23 -9h96v-320h-96q-14 0 -23 -9t-9 -23v-160q0 -14 9 -23t23 -9h448q14 0 23 9t9 23zM896 1056v160q0 14 -9 23t-23 9h-192q-14 0 -23 -9t-9 -23v-160q0 -14 9 -23 t23 -9h192q14 0 23 9t9 23zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1197 512h-109q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h109q-32 108 -112.5 188.5t-188.5 112.5v-109q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v109q-108 -32 -188.5 -112.5t-112.5 -188.5h109q26 0 45 -19t19 -45v-128q0 -26 -19 -45t-45 -19h-109 q32 -108 112.5 -188.5t188.5 -112.5v109q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-109q108 32 188.5 112.5t112.5 188.5zM1536 704v-128q0 -26 -19 -45t-45 -19h-143q-37 -161 -154.5 -278.5t-278.5 -154.5v-143q0 -26 -19 -45t-45 -19h-128q-26 0 -45 19t-19 45v143 q-161 37 -278.5 154.5t-154.5 278.5h-143q-26 0 -45 19t-19 45v128q0 26 19 45t45 19h143q37 161 154.5 278.5t278.5 154.5v143q0 26 19 45t45 19h128q26 0 45 -19t19 -45v-143q161 -37 278.5 -154.5t154.5 -278.5h143q26 0 45 -19t19 -45z" />
+<glyph unicode="" d="M1097 457l-146 -146q-10 -10 -23 -10t-23 10l-137 137l-137 -137q-10 -10 -23 -10t-23 10l-146 146q-10 10 -10 23t10 23l137 137l-137 137q-10 10 -10 23t10 23l146 146q10 10 23 10t23 -10l137 -137l137 137q10 10 23 10t23 -10l146 -146q10 -10 10 -23t-10 -23 l-137 -137l137 -137q10 -10 10 -23t-10 -23zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5 t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1171 723l-422 -422q-19 -19 -45 -19t-45 19l-294 294q-19 19 -19 45t19 45l102 102q19 19 45 19t45 -19l147 -147l275 275q19 19 45 19t45 -19l102 -102q19 -19 19 -45t-19 -45zM1312 640q0 148 -73 273t-198 198t-273 73t-273 -73t-198 -198t-73 -273t73 -273t198 -198 t273 -73t273 73t198 198t73 273zM1536 640q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1312 643q0 161 -87 295l-754 -753q137 -89 297 -89q111 0 211.5 43.5t173.5 116.5t116 174.5t43 212.5zM313 344l755 754q-135 91 -300 91q-148 0 -273 -73t-198 -199t-73 -274q0 -162 89 -299zM1536 643q0 -157 -61 -300t-163.5 -246t-245 -164t-298.5 -61t-298.5 61 t-245 164t-163.5 246t-61 300t61 299.5t163.5 245.5t245 164t298.5 61t298.5 -61t245 -164t163.5 -245.5t61 -299.5z" />
+<glyph unicode="" d="M1536 640v-128q0 -53 -32.5 -90.5t-84.5 -37.5h-704l293 -294q38 -36 38 -90t-38 -90l-75 -76q-37 -37 -90 -37q-52 0 -91 37l-651 652q-37 37 -37 90q0 52 37 91l651 650q38 38 91 38q52 0 90 -38l75 -74q38 -38 38 -91t-38 -91l-293 -293h704q52 0 84.5 -37.5 t32.5 -90.5z" />
+<glyph unicode="" d="M1472 576q0 -54 -37 -91l-651 -651q-39 -37 -91 -37q-51 0 -90 37l-75 75q-38 38 -38 91t38 91l293 293h-704q-52 0 -84.5 37.5t-32.5 90.5v128q0 53 32.5 90.5t84.5 37.5h704l-293 294q-38 36 -38 90t38 90l75 75q38 38 90 38q53 0 91 -38l651 -651q37 -35 37 -90z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1611 565q0 -51 -37 -90l-75 -75q-38 -38 -91 -38q-54 0 -90 38l-294 293v-704q0 -52 -37.5 -84.5t-90.5 -32.5h-128q-53 0 -90.5 32.5t-37.5 84.5v704l-294 -293q-36 -38 -90 -38t-90 38l-75 75q-38 38 -38 90q0 53 38 91l651 651q35 37 90 37q54 0 91 -37l651 -651 q37 -39 37 -91z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1611 704q0 -53 -37 -90l-651 -652q-39 -37 -91 -37q-53 0 -90 37l-651 652q-38 36 -38 90q0 53 38 91l74 75q39 37 91 37q53 0 90 -37l294 -294v704q0 52 38 90t90 38h128q52 0 90 -38t38 -90v-704l294 294q37 37 90 37q52 0 91 -37l75 -75q37 -39 37 -91z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1792 896q0 -26 -19 -45l-512 -512q-19 -19 -45 -19t-45 19t-19 45v256h-224q-98 0 -175.5 -6t-154 -21.5t-133 -42.5t-105.5 -69.5t-80 -101t-48.5 -138.5t-17.5 -181q0 -55 5 -123q0 -6 2.5 -23.5t2.5 -26.5q0 -15 -8.5 -25t-23.5 -10q-16 0 -28 17q-7 9 -13 22 t-13.5 30t-10.5 24q-127 285 -127 451q0 199 53 333q162 403 875 403h224v256q0 26 19 45t45 19t45 -19l512 -512q19 -19 19 -45z" />
+<glyph unicode="" d="M755 480q0 -13 -10 -23l-332 -332l144 -144q19 -19 19 -45t-19 -45t-45 -19h-448q-26 0 -45 19t-19 45v448q0 26 19 45t45 19t45 -19l144 -144l332 332q10 10 23 10t23 -10l114 -114q10 -10 10 -23zM1536 1344v-448q0 -26 -19 -45t-45 -19t-45 19l-144 144l-332 -332 q-10 -10 -23 -10t-23 10l-114 114q-10 10 -10 23t10 23l332 332l-144 144q-19 19 -19 45t19 45t45 19h448q26 0 45 -19t19 -45z" />
+<glyph unicode="" d="M768 576v-448q0 -26 -19 -45t-45 -19t-45 19l-144 144l-332 -332q-10 -10 -23 -10t-23 10l-114 114q-10 10 -10 23t10 23l332 332l-144 144q-19 19 -19 45t19 45t45 19h448q26 0 45 -19t19 -45zM1523 1248q0 -13 -10 -23l-332 -332l144 -144q19 -19 19 -45t-19 -45 t-45 -19h-448q-26 0 -45 19t-19 45v448q0 26 19 45t45 19t45 -19l144 -144l332 332q10 10 23 10t23 -10l114 -114q10 -10 10 -23z" />
+<glyph unicode="" horiz-adv-x="1408" d="M1408 800v-192q0 -40 -28 -68t-68 -28h-416v-416q0 -40 -28 -68t-68 -28h-192q-40 0 -68 28t-28 68v416h-416q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h416v416q0 40 28 68t68 28h192q40 0 68 -28t28 -68v-416h416q40 0 68 -28t28 -68z" />
+<glyph unicode="" horiz-adv-x="1408" d="M1408 800v-192q0 -40 -28 -68t-68 -28h-1216q-40 0 -68 28t-28 68v192q0 40 28 68t68 28h1216q40 0 68 -28t28 -68z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1482 486q46 -26 59.5 -77.5t-12.5 -97.5l-64 -110q-26 -46 -77.5 -59.5t-97.5 12.5l-266 153v-307q0 -52 -38 -90t-90 -38h-128q-52 0 -90 38t-38 90v307l-266 -153q-46 -26 -97.5 -12.5t-77.5 59.5l-64 110q-26 46 -12.5 97.5t59.5 77.5l266 154l-266 154 q-46 26 -59.5 77.5t12.5 97.5l64 110q26 46 77.5 59.5t97.5 -12.5l266 -153v307q0 52 38 90t90 38h128q52 0 90 -38t38 -90v-307l266 153q46 26 97.5 12.5t77.5 -59.5l64 -110q26 -46 12.5 -97.5t-59.5 -77.5l-266 -154z" />
+<glyph unicode="" d="M768 1408q209 0 385.5 -103t279.5 -279.5t103 -385.5t-103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103zM896 161v190q0 14 -9 23.5t-22 9.5h-192q-13 0 -23 -10t-10 -23v-190q0 -13 10 -23t23 -10h192 q13 0 22 9.5t9 23.5zM894 505l18 621q0 12 -10 18q-10 8 -24 8h-220q-14 0 -24 -8q-10 -6 -10 -18l17 -621q0 -10 10 -17.5t24 -7.5h185q14 0 23.5 7.5t10.5 17.5z" />
+<glyph unicode="" d="M928 180v56v468v192h-320v-192v-468v-56q0 -25 18 -38.5t46 -13.5h192q28 0 46 13.5t18 38.5zM472 1024h195l-126 161q-26 31 -69 31q-40 0 -68 -28t-28 -68t28 -68t68 -28zM1160 1120q0 40 -28 68t-68 28q-43 0 -69 -31l-125 -161h194q40 0 68 28t28 68zM1536 864v-320 q0 -14 -9 -23t-23 -9h-96v-416q0 -40 -28 -68t-68 -28h-1088q-40 0 -68 28t-28 68v416h-96q-14 0 -23 9t-9 23v320q0 14 9 23t23 9h440q-93 0 -158.5 65.5t-65.5 158.5t65.5 158.5t158.5 65.5q107 0 168 -77l128 -165l128 165q61 77 168 77q93 0 158.5 -65.5t65.5 -158.5 t-65.5 -158.5t-158.5 -65.5h440q14 0 23 -9t9 -23z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1280 832q0 26 -19 45t-45 19q-172 0 -318 -49.5t-259.5 -134t-235.5 -219.5q-19 -21 -19 -45q0 -26 19 -45t45 -19q24 0 45 19q27 24 74 71t67 66q137 124 268.5 176t313.5 52q26 0 45 19t19 45zM1792 1030q0 -95 -20 -193q-46 -224 -184.5 -383t-357.5 -268 q-214 -108 -438 -108q-148 0 -286 47q-15 5 -88 42t-96 37q-16 0 -39.5 -32t-45 -70t-52.5 -70t-60 -32q-30 0 -51 11t-31 24t-27 42q-2 4 -6 11t-5.5 10t-3 9.5t-1.5 13.5q0 35 31 73.5t68 65.5t68 56t31 48q0 4 -14 38t-16 44q-9 51 -9 104q0 115 43.5 220t119 184.5 t170.5 139t204 95.5q55 18 145 25.5t179.5 9t178.5 6t163.5 24t113.5 56.5l29.5 29.5t29.5 28t27 20t36.5 16t43.5 4.5q39 0 70.5 -46t47.5 -112t24 -124t8 -96z" />
+<glyph unicode="" horiz-adv-x="1408" d="M1408 -160v-64q0 -13 -9.5 -22.5t-22.5 -9.5h-1344q-13 0 -22.5 9.5t-9.5 22.5v64q0 13 9.5 22.5t22.5 9.5h1344q13 0 22.5 -9.5t9.5 -22.5zM1152 896q0 -78 -24.5 -144t-64 -112.5t-87.5 -88t-96 -77.5t-87.5 -72t-64 -81.5t-24.5 -96.5q0 -96 67 -224l-4 1l1 -1 q-90 41 -160 83t-138.5 100t-113.5 122.5t-72.5 150.5t-27.5 184q0 78 24.5 144t64 112.5t87.5 88t96 77.5t87.5 72t64 81.5t24.5 96.5q0 94 -66 224l3 -1l-1 1q90 -41 160 -83t138.5 -100t113.5 -122.5t72.5 -150.5t27.5 -184z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1664 576q-152 236 -381 353q61 -104 61 -225q0 -185 -131.5 -316.5t-316.5 -131.5t-316.5 131.5t-131.5 316.5q0 121 61 225q-229 -117 -381 -353q133 -205 333.5 -326.5t434.5 -121.5t434.5 121.5t333.5 326.5zM944 960q0 20 -14 34t-34 14q-125 0 -214.5 -89.5 t-89.5 -214.5q0 -20 14 -34t34 -14t34 14t14 34q0 86 61 147t147 61q20 0 34 14t14 34zM1792 576q0 -34 -20 -69q-140 -230 -376.5 -368.5t-499.5 -138.5t-499.5 139t-376.5 368q-20 35 -20 69t20 69q140 229 376.5 368t499.5 139t499.5 -139t376.5 -368q20 -35 20 -69z" />
+<glyph unicode="" horiz-adv-x="1792" d="M555 201l78 141q-87 63 -136 159t-49 203q0 121 61 225q-229 -117 -381 -353q167 -258 427 -375zM944 960q0 20 -14 34t-34 14q-125 0 -214.5 -89.5t-89.5 -214.5q0 -20 14 -34t34 -14t34 14t14 34q0 86 61 147t147 61q20 0 34 14t14 34zM1307 1151q0 -7 -1 -9 q-105 -188 -315 -566t-316 -567l-49 -89q-10 -16 -28 -16q-12 0 -134 70q-16 10 -16 28q0 12 44 87q-143 65 -263.5 173t-208.5 245q-20 31 -20 69t20 69q153 235 380 371t496 136q89 0 180 -17l54 97q10 16 28 16q5 0 18 -6t31 -15.5t33 -18.5t31.5 -18.5t19.5 -11.5 q16 -10 16 -27zM1344 704q0 -139 -79 -253.5t-209 -164.5l280 502q8 -45 8 -84zM1792 576q0 -35 -20 -69q-39 -64 -109 -145q-150 -172 -347.5 -267t-419.5 -95l74 132q212 18 392.5 137t301.5 307q-115 179 -282 294l63 112q95 -64 182.5 -153t144.5 -184q20 -34 20 -69z " />
+<glyph unicode="" horiz-adv-x="1792" d="M1024 161v190q0 14 -9.5 23.5t-22.5 9.5h-192q-13 0 -22.5 -9.5t-9.5 -23.5v-190q0 -14 9.5 -23.5t22.5 -9.5h192q13 0 22.5 9.5t9.5 23.5zM1022 535l18 459q0 12 -10 19q-13 11 -24 11h-220q-11 0 -24 -11q-10 -7 -10 -21l17 -457q0 -10 10 -16.5t24 -6.5h185 q14 0 23.5 6.5t10.5 16.5zM1008 1469l768 -1408q35 -63 -2 -126q-17 -29 -46.5 -46t-63.5 -17h-1536q-34 0 -63.5 17t-46.5 46q-37 63 -2 126l768 1408q17 31 47 49t65 18t65 -18t47 -49z" />
+<glyph unicode="" horiz-adv-x="1408" d="M1376 1376q44 -52 12 -148t-108 -172l-161 -161l160 -696q5 -19 -12 -33l-128 -96q-7 -6 -19 -6q-4 0 -7 1q-15 3 -21 16l-279 508l-259 -259l53 -194q5 -17 -8 -31l-96 -96q-9 -9 -23 -9h-2q-15 2 -24 13l-189 252l-252 189q-11 7 -13 23q-1 13 9 25l96 97q9 9 23 9 q6 0 8 -1l194 -53l259 259l-508 279q-14 8 -17 24q-2 16 9 27l128 128q14 13 30 8l665 -159l160 160q76 76 172 108t148 -12z" />
+<glyph unicode="" horiz-adv-x="1664" d="M128 -128h288v288h-288v-288zM480 -128h320v288h-320v-288zM128 224h288v320h-288v-320zM480 224h320v320h-320v-320zM128 608h288v288h-288v-288zM864 -128h320v288h-320v-288zM480 608h320v288h-320v-288zM1248 -128h288v288h-288v-288zM864 224h320v320h-320v-320z M512 1088v288q0 13 -9.5 22.5t-22.5 9.5h-64q-13 0 -22.5 -9.5t-9.5 -22.5v-288q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5zM1248 224h288v320h-288v-320zM864 608h320v288h-320v-288zM1248 608h288v288h-288v-288zM1280 1088v288q0 13 -9.5 22.5t-22.5 9.5h-64 q-13 0 -22.5 -9.5t-9.5 -22.5v-288q0 -13 9.5 -22.5t22.5 -9.5h64q13 0 22.5 9.5t9.5 22.5zM1664 1152v-1280q0 -52 -38 -90t-90 -38h-1408q-52 0 -90 38t-38 90v1280q0 52 38 90t90 38h128v96q0 66 47 113t113 47h64q66 0 113 -47t47 -113v-96h384v96q0 66 47 113t113 47 h64q66 0 113 -47t47 -113v-96h128q52 0 90 -38t38 -90z" />
+<glyph unicode="" horiz-adv-x="1792" d="M666 1055q-60 -92 -137 -273q-22 45 -37 72.5t-40.5 63.5t-51 56.5t-63 35t-81.5 14.5h-224q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h224q250 0 410 -225zM1792 256q0 -14 -9 -23l-320 -320q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5v192q-32 0 -85 -0.5t-81 -1t-73 1 t-71 5t-64 10.5t-63 18.5t-58 28.5t-59 40t-55 53.5t-56 69.5q59 93 136 273q22 -45 37 -72.5t40.5 -63.5t51 -56.5t63 -35t81.5 -14.5h256v192q0 14 9 23t23 9q12 0 24 -10l319 -319q9 -9 9 -23zM1792 1152q0 -14 -9 -23l-320 -320q-9 -9 -23 -9q-13 0 -22.5 9.5t-9.5 22.5 v192h-256q-48 0 -87 -15t-69 -45t-51 -61.5t-45 -77.5q-32 -62 -78 -171q-29 -66 -49.5 -111t-54 -105t-64 -100t-74 -83t-90 -68.5t-106.5 -42t-128 -16.5h-224q-14 0 -23 9t-9 23v192q0 14 9 23t23 9h224q48 0 87 15t69 45t51 61.5t45 77.5q32 62 78 171q29 66 49.5 111 t54 105t64 100t74 83t90 68.5t106.5 42t128 16.5h256v192q0 14 9 23t23 9q12 0 24 -10l319 -319q9 -9 9 -23z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1792 640q0 -174 -120 -321.5t-326 -233t-450 -85.5q-70 0 -145 8q-198 -175 -460 -242q-49 -14 -114 -22q-17 -2 -30.5 9t-17.5 29v1q-3 4 -0.5 12t2 10t4.5 9.5l6 9t7 8.5t8 9q7 8 31 34.5t34.5 38t31 39.5t32.5 51t27 59t26 76q-157 89 -247.5 220t-90.5 281 q0 130 71 248.5t191 204.5t286 136.5t348 50.5q244 0 450 -85.5t326 -233t120 -321.5z" />
+<glyph unicode="" d="M1536 704v-128q0 -201 -98.5 -362t-274 -251.5t-395.5 -90.5t-395.5 90.5t-274 251.5t-98.5 362v128q0 26 19 45t45 19h384q26 0 45 -19t19 -45v-128q0 -52 23.5 -90t53.5 -57t71 -30t64 -13t44 -2t44 2t64 13t71 30t53.5 57t23.5 90v128q0 26 19 45t45 19h384 q26 0 45 -19t19 -45zM512 1344v-384q0 -26 -19 -45t-45 -19h-384q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h384q26 0 45 -19t19 -45zM1536 1344v-384q0 -26 -19 -45t-45 -19h-384q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h384q26 0 45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1611 320q0 -53 -37 -90l-75 -75q-38 -38 -91 -38q-54 0 -90 38l-486 485l-486 -485q-36 -38 -90 -38t-90 38l-75 75q-38 36 -38 90q0 53 38 91l651 651q37 37 90 37q52 0 91 -37l650 -651q38 -38 38 -91z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1611 832q0 -53 -37 -90l-651 -651q-38 -38 -91 -38q-54 0 -90 38l-651 651q-38 36 -38 90q0 53 38 91l74 75q39 37 91 37q53 0 90 -37l486 -486l486 486q37 37 90 37q52 0 91 -37l75 -75q37 -39 37 -91z" />
+<glyph unicode="" horiz-adv-x="1920" d="M1280 32q0 -13 -9.5 -22.5t-22.5 -9.5h-960q-8 0 -13.5 2t-9 7t-5.5 8t-3 11.5t-1 11.5v13v11v160v416h-192q-26 0 -45 19t-19 45q0 24 15 41l320 384q19 22 49 22t49 -22l320 -384q15 -17 15 -41q0 -26 -19 -45t-45 -19h-192v-384h576q16 0 25 -11l160 -192q7 -11 7 -21 zM1920 448q0 -24 -15 -41l-320 -384q-20 -23 -49 -23t-49 23l-320 384q-15 17 -15 41q0 26 19 45t45 19h192v384h-576q-16 0 -25 12l-160 192q-7 9 -7 20q0 13 9.5 22.5t22.5 9.5h960q8 0 13.5 -2t9 -7t5.5 -8t3 -11.5t1 -11.5v-13v-11v-160v-416h192q26 0 45 -19t19 -45z " />
+<glyph unicode="" horiz-adv-x="1664" d="M640 0q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1536 0q0 -53 -37.5 -90.5t-90.5 -37.5t-90.5 37.5t-37.5 90.5t37.5 90.5t90.5 37.5t90.5 -37.5t37.5 -90.5zM1664 1088v-512q0 -24 -16 -42.5t-41 -21.5 l-1044 -122q1 -7 4.5 -21.5t6 -26.5t2.5 -22q0 -16 -24 -64h920q26 0 45 -19t19 -45t-19 -45t-45 -19h-1024q-26 0 -45 19t-19 45q0 14 11 39.5t29.5 59.5t20.5 38l-177 823h-204q-26 0 -45 19t-19 45t19 45t45 19h256q16 0 28.5 -6.5t20 -15.5t13 -24.5t7.5 -26.5 t5.5 -29.5t4.5 -25.5h1201q26 0 45 -19t19 -45z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1664 928v-704q0 -92 -66 -158t-158 -66h-1216q-92 0 -158 66t-66 158v960q0 92 66 158t158 66h320q92 0 158 -66t66 -158v-32h672q92 0 158 -66t66 -158z" />
+<glyph unicode="" horiz-adv-x="1920" d="M1879 584q0 -31 -31 -66l-336 -396q-43 -51 -120.5 -86.5t-143.5 -35.5h-1088q-34 0 -60.5 13t-26.5 43q0 31 31 66l336 396q43 51 120.5 86.5t143.5 35.5h1088q34 0 60.5 -13t26.5 -43zM1536 928v-160h-832q-94 0 -197 -47.5t-164 -119.5l-337 -396l-5 -6q0 4 -0.5 12.5 t-0.5 12.5v960q0 92 66 158t158 66h320q92 0 158 -66t66 -158v-32h544q92 0 158 -66t66 -158z" />
+<glyph unicode="" horiz-adv-x="768" d="M704 1216q0 -26 -19 -45t-45 -19h-128v-1024h128q26 0 45 -19t19 -45t-19 -45l-256 -256q-19 -19 -45 -19t-45 19l-256 256q-19 19 -19 45t19 45t45 19h128v1024h-128q-26 0 -45 19t-19 45t19 45l256 256q19 19 45 19t45 -19l256 -256q19 -19 19 -45z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1792 640q0 -26 -19 -45l-256 -256q-19 -19 -45 -19t-45 19t-19 45v128h-1024v-128q0 -26 -19 -45t-45 -19t-45 19l-256 256q-19 19 -19 45t19 45l256 256q19 19 45 19t45 -19t19 -45v-128h1024v128q0 26 19 45t45 19t45 -19l256 -256q19 -19 19 -45z" />
+<glyph unicode="" horiz-adv-x="1920" d="M512 512v-384h-256v384h256zM896 1024v-896h-256v896h256zM1280 768v-640h-256v640h256zM1664 1152v-1024h-256v1024h256zM1792 32v1216q0 13 -9.5 22.5t-22.5 9.5h-1600q-13 0 -22.5 -9.5t-9.5 -22.5v-1216q0 -13 9.5 -22.5t22.5 -9.5h1600q13 0 22.5 9.5t9.5 22.5z M1920 1248v-1216q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1600q66 0 113 -47t47 -113z" />
+<glyph unicode="" d="M1280 926q-56 -25 -121 -34q68 40 93 117q-65 -38 -134 -51q-61 66 -153 66q-87 0 -148.5 -61.5t-61.5 -148.5q0 -29 5 -48q-129 7 -242 65t-192 155q-29 -50 -29 -106q0 -114 91 -175q-47 1 -100 26v-2q0 -75 50 -133.5t123 -72.5q-29 -8 -51 -8q-13 0 -39 4 q21 -63 74.5 -104t121.5 -42q-116 -90 -261 -90q-26 0 -50 3q148 -94 322 -94q112 0 210 35.5t168 95t120.5 137t75 162t24.5 168.5q0 18 -1 27q63 45 105 109zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5 t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" />
+<glyph unicode="" d="M1307 618l23 219h-198v109q0 49 15.5 68.5t71.5 19.5h110v219h-175q-152 0 -218 -72t-66 -213v-131h-131v-219h131v-635h262v635h175zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960 q119 0 203.5 -84.5t84.5 -203.5z" />
+<glyph unicode="" horiz-adv-x="1792" d="M928 704q0 14 -9 23t-23 9q-66 0 -113 -47t-47 -113q0 -14 9 -23t23 -9t23 9t9 23q0 40 28 68t68 28q14 0 23 9t9 23zM1152 574q0 -106 -75 -181t-181 -75t-181 75t-75 181t75 181t181 75t181 -75t75 -181zM128 0h1536v128h-1536v-128zM1280 574q0 159 -112.5 271.5 t-271.5 112.5t-271.5 -112.5t-112.5 -271.5t112.5 -271.5t271.5 -112.5t271.5 112.5t112.5 271.5zM256 1216h384v128h-384v-128zM128 1024h1536v118v138h-828l-64 -128h-644v-128zM1792 1280v-1280q0 -53 -37.5 -90.5t-90.5 -37.5h-1536q-53 0 -90.5 37.5t-37.5 90.5v1280 q0 53 37.5 90.5t90.5 37.5h1536q53 0 90.5 -37.5t37.5 -90.5z" />
+<glyph unicode="" horiz-adv-x="1792" d="M832 1024q0 80 -56 136t-136 56t-136 -56t-56 -136q0 -42 19 -83q-41 19 -83 19q-80 0 -136 -56t-56 -136t56 -136t136 -56t136 56t56 136q0 42 -19 83q41 -19 83 -19q80 0 136 56t56 136zM1683 320q0 -17 -49 -66t-66 -49q-9 0 -28.5 16t-36.5 33t-38.5 40t-24.5 26 l-96 -96l220 -220q28 -28 28 -68q0 -42 -39 -81t-81 -39q-40 0 -68 28l-671 671q-176 -131 -365 -131q-163 0 -265.5 102.5t-102.5 265.5q0 160 95 313t248 248t313 95q163 0 265.5 -102.5t102.5 -265.5q0 -189 -131 -365l355 -355l96 96q-3 3 -26 24.5t-40 38.5t-33 36.5 t-16 28.5q0 17 49 66t66 49q13 0 23 -10q6 -6 46 -44.5t82 -79.5t86.5 -86t73 -78t28.5 -41z" />
+<glyph unicode="" horiz-adv-x="1920" d="M896 640q0 106 -75 181t-181 75t-181 -75t-75 -181t75 -181t181 -75t181 75t75 181zM1664 128q0 52 -38 90t-90 38t-90 -38t-38 -90q0 -53 37.5 -90.5t90.5 -37.5t90.5 37.5t37.5 90.5zM1664 1152q0 52 -38 90t-90 38t-90 -38t-38 -90q0 -53 37.5 -90.5t90.5 -37.5 t90.5 37.5t37.5 90.5zM1280 731v-185q0 -10 -7 -19.5t-16 -10.5l-155 -24q-11 -35 -32 -76q34 -48 90 -115q7 -10 7 -20q0 -12 -7 -19q-23 -30 -82.5 -89.5t-78.5 -59.5q-11 0 -21 7l-115 90q-37 -19 -77 -31q-11 -108 -23 -155q-7 -24 -30 -24h-186q-11 0 -20 7.5t-10 17.5 l-23 153q-34 10 -75 31l-118 -89q-7 -7 -20 -7q-11 0 -21 8q-144 133 -144 160q0 9 7 19q10 14 41 53t47 61q-23 44 -35 82l-152 24q-10 1 -17 9.5t-7 19.5v185q0 10 7 19.5t16 10.5l155 24q11 35 32 76q-34 48 -90 115q-7 11 -7 20q0 12 7 20q22 30 82 89t79 59q11 0 21 -7 l115 -90q34 18 77 32q11 108 23 154q7 24 30 24h186q11 0 20 -7.5t10 -17.5l23 -153q34 -10 75 -31l118 89q8 7 20 7q11 0 21 -8q144 -133 144 -160q0 -9 -7 -19q-12 -16 -42 -54t-45 -60q23 -48 34 -82l152
-23q10 -2 17 -10.5t7 -19.5zM1920 198v-140q0 -16 -149 -31 q-12 -27 -30 -52q51 -113 51 -138q0 -4 -4 -7q-122 -71 -124 -71q-8 0 -46 47t-52 68q-20 -2 -30 -2t-30 2q-14 -21 -52 -68t-46 -47q-2 0 -124 71q-4 3 -4 7q0 25 51 138q-18 25 -30 52q-149 15 -149 31v140q0 16 149 31q13 29 30 52q-51 113 -51 138q0 4 4 7q4 2 35 20 t59 34t30 16q8 0 46 -46.5t52 -67.5q20 2 30 2t30 -2q51 71 92 112l6 2q4 0 124 -70q4 -3 4 -7q0 -25 -51 -138q17 -23 30 -52q149 -15 149 -31zM1920 1222v-140q0 -16 -149 -31q-12 -27 -30 -52q51 -113 51 -138q0 -4 -4 -7q-122 -71 -124 -71q-8 0 -46 47t-52 68 q-20 -2 -30 -2t-30 2q-14 -21 -52 -68t-46 -47q-2 0 -124 71q-4 3 -4 7q0 25 51 138q-18 25 -30 52q-149 15 -149 31v140q0 16 149 31q13 29 30 52q-51 113 -51 138q0 4 4 7q4 2 35 20t59 34t30 16q8 0 46 -46.5t52 -67.5q20 2 30 2t30 -2q51 71 92 112l6 2q4 0 124 -70 q4 -3 4 -7q0 -25 -51 -138q17 -23 30 -52q149 -15 149 -31z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1408 768q0 -139 -94 -257t-256.5 -186.5t-353.5 -68.5q-86 0 -176 16q-124 -88 -278 -128q-36 -9 -86 -16h-3q-11 0 -20.5 8t-11.5 21q-1 3 -1 6.5t0.5 6.5t2 6l2.5 5t3.5 5.5t4 5t4.5 5t4 4.5q5 6 23 25t26 29.5t22.5 29t25 38.5t20.5 44q-124 72 -195 177t-71 224 q0 139 94 257t256.5 186.5t353.5 68.5t353.5 -68.5t256.5 -186.5t94 -257zM1792 512q0 -120 -71 -224.5t-195 -176.5q10 -24 20.5 -44t25 -38.5t22.5 -29t26 -29.5t23 -25q1 -1 4 -4.5t4.5 -5t4 -5t3.5 -5.5l2.5 -5t2 -6t0.5 -6.5t-1 -6.5q-3 -14 -13 -22t-22 -7 q-50 7 -86 16q-154 40 -278 128q-90 -16 -176 -16q-271 0 -472 132q58 -4 88 -4q161 0 309 45t264 129q125 92 192 212t67 254q0 77 -23 152q129 -71 204 -178t75 -230z" />
+<glyph unicode="" d="M256 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 768q0 51 -39 89.5t-89 38.5h-352q0 58 48 159.5t48 160.5q0 98 -32 145t-128 47q-26 -26 -38 -85t-30.5 -125.5t-59.5 -109.5q-22 -23 -77 -91q-4 -5 -23 -30t-31.5 -41t-34.5 -42.5 t-40 -44t-38.5 -35.5t-40 -27t-35.5 -9h-32v-640h32q13 0 31.5 -3t33 -6.5t38 -11t35 -11.5t35.5 -12.5t29 -10.5q211 -73 342 -73h121q192 0 192 167q0 26 -5 56q30 16 47.5 52.5t17.5 73.5t-18 69q53 50 53 119q0 25 -10 55.5t-25 47.5q32 1 53.5 47t21.5 81zM1536 769 q0 -89 -49 -163q9 -33 9 -69q0 -77 -38 -144q3 -21 3 -43q0 -101 -60 -178q1 -139 -85 -219.5t-227 -80.5h-36h-93q-96 0 -189.5 22.5t-216.5 65.5q-116 40 -138 40h-288q-53 0 -90.5 37.5t-37.5 90.5v640q0 53 37.5 90.5t90.5 37.5h274q36 24 137 155q58 75 107 128 q24 25 35.5 85.5t30.5 126.5t62 108q39 37 90 37q84 0 151 -32.5t102 -101.5t35 -186q0 -93 -48 -192h176q104 0 180 -76t76 -179z" />
+<glyph unicode="" d="M256 1088q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 512q0 35 -21.5 81t-53.5 47q15 17 25 47.5t10 55.5q0 69 -53 119q18 32 18 69t-17.5 73.5t-47.5 52.5q5 30 5 56q0 85 -49 126t-136 41h-128q-131 0 -342 -73q-5 -2 -29 -10.5 t-35.5 -12.5t-35 -11.5t-38 -11t-33 -6.5t-31.5 -3h-32v-640h32q16 0 35.5 -9t40 -27t38.5 -35.5t40 -44t34.5 -42.5t31.5 -41t23 -30q55 -68 77 -91q41 -43 59.5 -109.5t30.5 -125.5t38 -85q96 0 128 47t32 145q0 59 -48 160.5t-48 159.5h352q50 0 89 38.5t39 89.5z M1536 511q0 -103 -76 -179t-180 -76h-176q48 -99 48 -192q0 -118 -35 -186q-35 -69 -102 -101.5t-151 -32.5q-51 0 -90 37q-34 33 -54 82t-25.5 90.5t-17.5 84.5t-31 64q-48 50 -107 127q-101 131 -137 155h-274q-53 0 -90.5 37.5t-37.5 90.5v640q0 53 37.5 90.5t90.5 37.5 h288q22 0 138 40q128 44 223 66t200 22h112q140 0 226.5 -79t85.5 -216v-5q60 -77 60 -178q0 -22 -3 -43q38 -67 38 -144q0 -36 -9 -69q49 -74 49 -163z" />
+<glyph unicode="" horiz-adv-x="896" d="M832 1504v-1339l-449 -236q-22 -12 -40 -12q-21 0 -31.5 14.5t-10.5 35.5q0 6 2 20l86 500l-364 354q-25 27 -25 48q0 37 56 46l502 73l225 455q19 41 49 41z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1664 940q0 81 -21.5 143t-55 98.5t-81.5 59.5t-94 31t-98 8t-112 -25.5t-110.5 -64t-86.5 -72t-60 -61.5q-18 -22 -49 -22t-49 22q-24 28 -60 61.5t-86.5 72t-110.5 64t-112 25.5t-98 -8t-94 -31t-81.5 -59.5t-55 -98.5t-21.5 -143q0 -168 187 -355l581 -560l580 559 q188 188 188 356zM1792 940q0 -221 -229 -450l-623 -600q-18 -18 -44 -18t-44 18l-624 602q-10 8 -27.5 26t-55.5 65.5t-68 97.5t-53.5 121t-23.5 138q0 220 127 344t351 124q62 0 126.5 -21.5t120 -58t95.5 -68.5t76 -68q36 36 76 68t95.5 68.5t120 58t126.5 21.5 q224 0 351 -124t127 -344z" />
+<glyph unicode="" horiz-adv-x="1664" d="M640 96q0 -4 1 -20t0.5 -26.5t-3 -23.5t-10 -19.5t-20.5 -6.5h-320q-119 0 -203.5 84.5t-84.5 203.5v704q0 119 84.5 203.5t203.5 84.5h320q13 0 22.5 -9.5t9.5 -22.5q0 -4 1 -20t0.5 -26.5t-3 -23.5t-10 -19.5t-20.5 -6.5h-320q-66 0 -113 -47t-47 -113v-704 q0 -66 47 -113t113 -47h288h11h13t11.5 -1t11.5 -3t8 -5.5t7 -9t2 -13.5zM1568 640q0 -26 -19 -45l-544 -544q-19 -19 -45 -19t-45 19t-19 45v288h-448q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h448v288q0 26 19 45t45 19t45 -19l544 -544q19 -19 19 -45z" />
+<glyph unicode="" d="M237 122h231v694h-231v-694zM483 1030q-1 52 -36 86t-93 34t-94.5 -34t-36.5 -86q0 -51 35.5 -85.5t92.5 -34.5h1q59 0 95 34.5t36 85.5zM1068 122h231v398q0 154 -73 233t-193 79q-136 0 -209 -117h2v101h-231q3 -66 0 -694h231v388q0 38 7 56q15 35 45 59.5t74 24.5 q116 0 116 -157v-371zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" />
+<glyph unicode="" horiz-adv-x="1152" d="M480 672v448q0 14 -9 23t-23 9t-23 -9t-9 -23v-448q0 -14 9 -23t23 -9t23 9t9 23zM1152 320q0 -26 -19 -45t-45 -19h-429l-51 -483q-2 -12 -10.5 -20.5t-20.5 -8.5h-1q-27 0 -32 27l-76 485h-404q-26 0 -45 19t-19 45q0 123 78.5 221.5t177.5 98.5v512q-52 0 -90 38 t-38 90t38 90t90 38h640q52 0 90 -38t38 -90t-38 -90t-90 -38v-512q99 0 177.5 -98.5t78.5 -221.5z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1408 608v-320q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h704q14 0 23 -9t9 -23v-64q0 -14 -9 -23t-23 -9h-704q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v320 q0 14 9 23t23 9h64q14 0 23 -9t9 -23zM1792 1472v-512q0 -26 -19 -45t-45 -19t-45 19l-176 176l-652 -652q-10 -10 -23 -10t-23 10l-114 114q-10 10 -10 23t10 23l652 652l-176 176q-19 19 -19 45t19 45t45 19h512q26 0 45 -19t19 -45z" />
+<glyph unicode="" d="M1184 640q0 -26 -19 -45l-544 -544q-19 -19 -45 -19t-45 19t-19 45v288h-448q-26 0 -45 19t-19 45v384q0 26 19 45t45 19h448v288q0 26 19 45t45 19t45 -19l544 -544q19 -19 19 -45zM1536 992v-704q0 -119 -84.5 -203.5t-203.5 -84.5h-320q-13 0 -22.5 9.5t-9.5 22.5 q0 4 -1 20t-0.5 26.5t3 23.5t10 19.5t20.5 6.5h320q66 0 113 47t47 113v704q0 66 -47 113t-113 47h-288h-11h-13t-11.5 1t-11.5 3t-8 5.5t-7 9t-2 13.5q0 4 -1 20t-0.5 26.5t3 23.5t10 19.5t20.5 6.5h320q119 0 203.5 -84.5t84.5 -203.5z" />
+<glyph unicode="" horiz-adv-x="1664" d="M458 653q-74 162 -74 371h-256v-96q0 -78 94.5 -162t235.5 -113zM1536 928v96h-256q0 -209 -74 -371q141 29 235.5 113t94.5 162zM1664 1056v-128q0 -71 -41.5 -143t-112 -130t-173 -97.5t-215.5 -44.5q-42 -54 -95 -95q-38 -34 -52.5 -72.5t-14.5 -89.5q0 -54 30.5 -91 t97.5 -37q75 0 133.5 -45.5t58.5 -114.5v-64q0 -14 -9 -23t-23 -9h-832q-14 0 -23 9t-9 23v64q0 69 58.5 114.5t133.5 45.5q67 0 97.5 37t30.5 91q0 51 -14.5 89.5t-52.5 72.5q-53 41 -95 95q-113 5 -215.5 44.5t-173 97.5t-112 130t-41.5 143v128q0 40 28 68t68 28h288v96 q0 66 47 113t113 47h576q66 0 113 -47t47 -113v-96h288q40 0 68 -28t28 -68z" />
+<glyph unicode="" d="M394 184q-8 -9 -20 3q-13 11 -4 19q8 9 20 -3q12 -11 4 -19zM352 245q9 -12 0 -19q-8 -6 -17 7t0 18q9 7 17 -6zM291 305q-5 -7 -13 -2q-10 5 -7 12q3 5 13 2q10 -5 7 -12zM322 271q-6 -7 -16 3q-9 11 -2 16q6 6 16 -3q9 -11 2 -16zM451 159q-4 -12 -19 -6q-17 4 -13 15 t19 7q16 -5 13 -16zM514 154q0 -11 -16 -11q-17 -2 -17 11q0 11 16 11q17 2 17 -11zM572 164q2 -10 -14 -14t-18 8t14 15q16 2 18 -9zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-224q-16 0 -24.5 1t-19.5 5t-16 14.5t-5 27.5v239q0 97 -52 142q57 6 102.5 18t94 39 t81 66.5t53 105t20.5 150.5q0 121 -79 206q37 91 -8 204q-28 9 -81 -11t-92 -44l-38 -24q-93 26 -192 26t-192 -26q-16 11 -42.5 27t-83.5 38.5t-86 13.5q-44 -113 -7 -204q-79 -85 -79 -206q0 -85 20.5 -150t52.5 -105t80.5 -67t94 -39t102.5 -18q-40 -36 -49 -103 q-21 -10 -45 -15t-57 -5t-65.5 21.5t-55.5 62.5q-19 32 -48.5 52t-49.5 24l-20 3q-21 0 -29 -4.5t-5 -11.5t9 -14t13 -12l7 -5q22 -10 43.5 -38t31.5 -51l10 -23q13 -38 44 -61.5t67 -30t69.5 -7t55.5 3.5l23 4q0 -38 0.5 -103t0.5
-68q0 -22 -11 -33.5t-22 -13t-33 -1.5 h-224q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1280 64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1536 64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 288v-320q0 -40 -28 -68t-68 -28h-1472q-40 0 -68 28t-28 68v320q0 40 28 68t68 28h427q21 -56 70.5 -92 t110.5 -36h256q61 0 110.5 36t70.5 92h427q40 0 68 -28t28 -68zM1339 936q-17 -40 -59 -40h-256v-448q0 -26 -19 -45t-45 -19h-256q-26 0 -45 19t-19 45v448h-256q-42 0 -59 40q-17 39 14 69l448 448q18 19 45 19t45 -19l448 -448q31 -30 14 -69z" />
+<glyph unicode="" d="M1407 710q0 44 -7 113.5t-18 96.5q-12 30 -17 44t-9 36.5t-4 48.5q0 23 5 68.5t5 67.5q0 37 -10 55q-4 1 -13 1q-19 0 -58 -4.5t-59 -4.5q-60 0 -176 24t-175 24q-43 0 -94.5 -11.5t-85 -23.5t-89.5 -34q-137 -54 -202 -103q-96 -73 -159.5 -189.5t-88 -236t-24.5 -248.5 q0 -40 12.5 -120t12.5 -121q0 -23 -11 -66.5t-11 -65.5t12 -36.5t34 -14.5q24 0 72.5 11t73.5 11q57 0 169.5 -15.5t169.5 -15.5q181 0 284 36q129 45 235.5 152.5t166 245.5t59.5 275zM1535 712q0 -165 -70 -327.5t-196 -288t-281 -180.5q-124 -44 -326 -44 q-57 0 -170 14.5t-169 14.5q-24 0 -72.5 -14.5t-73.5 -14.5q-73 0 -123.5 55.5t-50.5 128.5q0 24 11 68t11 67q0 40 -12.5 120.5t-12.5 121.5q0 111 18 217.5t54.5 209.5t100.5 194t150 156q78 59 232 120q194 78 316 78q60 0 175.5 -24t173.5 -24q19 0 57 5t58 5 q81 0 118 -50.5t37 -134.5q0 -23 -5 -68t-5 -68q0 -10 1 -18.5t3 -17t4 -13.5t6.5 -16t6.5 -17q16 -40 25 -118.5t9 -136.5z" />
+<glyph unicode="" horiz-adv-x="1408" d="M1408 296q0 -27 -10 -70.5t-21 -68.5q-21 -50 -122 -106q-94 -51 -186 -51q-27 0 -52.5 3.5t-57.5 12.5t-47.5 14.5t-55.5 20.5t-49 18q-98 35 -175 83q-128 79 -264.5 215.5t-215.5 264.5q-48 77 -83 175q-3 9 -18 49t-20.5 55.5t-14.5 47.5t-12.5 57.5t-3.5 52.5 q0 92 51 186q56 101 106 122q25 11 68.5 21t70.5 10q14 0 21 -3q18 -6 53 -76q11 -19 30 -54t35 -63.5t31 -53.5q3 -4 17.5 -25t21.5 -35.5t7 -28.5q0 -20 -28.5 -50t-62 -55t-62 -53t-28.5 -46q0 -9 5 -22.5t8.5 -20.5t14 -24t11.5 -19q76 -137 174 -235t235 -174 q2 -1 19 -11.5t24 -14t20.5 -8.5t22.5 -5q18 0 46 28.5t53 62t55 62t50 28.5q14 0 28.5 -7t35.5 -21.5t25 -17.5q25 -15 53.5 -31t63.5 -35t54 -30q70 -35 76 -53q3 -7 3 -21z" />
+<glyph unicode="" horiz-adv-x="1408" d="M1120 1280h-832q-66 0 -113 -47t-47 -113v-832q0 -66 47 -113t113 -47h832q66 0 113 47t47 113v832q0 66 -47 113t-113 47zM1408 1120v-832q0 -119 -84.5 -203.5t-203.5 -84.5h-832q-119 0 -203.5 84.5t-84.5 203.5v832q0 119 84.5 203.5t203.5 84.5h832 q119 0 203.5 -84.5t84.5 -203.5z" />
+<glyph unicode="" horiz-adv-x="1280" d="M1152 1280h-1024v-1242l423 406l89 85l89 -85l423 -406v1242zM1164 1408q23 0 44 -9q33 -13 52.5 -41t19.5 -62v-1289q0 -34 -19.5 -62t-52.5 -41q-19 -8 -44 -8q-48 0 -83 32l-441 424l-441 -424q-36 -33 -83 -33q-23 0 -44 9q-33 13 -52.5 41t-19.5 62v1289 q0 34 19.5 62t52.5 41q21 9 44 9h1048z" />
+<glyph unicode="" d="M1280 343q0 11 -2 16q-3 8 -38.5 29.5t-88.5 49.5l-53 29q-5 3 -19 13t-25 15t-21 5q-18 0 -47 -32.5t-57 -65.5t-44 -33q-7 0 -16.5 3.5t-15.5 6.5t-17 9.5t-14 8.5q-99 55 -170.5 126.5t-126.5 170.5q-2 3 -8.5 14t-9.5 17t-6.5 15.5t-3.5 16.5q0 13 20.5 33.5t45 38.5 t45 39.5t20.5 36.5q0 10 -5 21t-15 25t-13 19q-3 6 -15 28.5t-25 45.5t-26.5 47.5t-25 40.5t-16.5 18t-16 2q-48 0 -101 -22q-46 -21 -80 -94.5t-34 -130.5q0 -16 2.5 -34t5 -30.5t9 -33t10 -29.5t12.5 -33t11 -30q60 -164 216.5 -320.5t320.5 -216.5q6 -2 30 -11t33 -12.5 t29.5 -10t33 -9t30.5 -5t34 -2.5q57 0 130.5 34t94.5 80q22 53 22 101zM1536 1120v-960q0 -119 -84.5 -203.5t-203.5 -84.5h-960q-119 0 -203.5 84.5t-84.5 203.5v960q0 119 84.5 203.5t203.5 84.5h960q119 0 203.5 -84.5t84.5 -203.5z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1620 1128q-67 -98 -162 -167q1 -14 1 -42q0 -130 -38 -259.5t-115.5 -248.5t-184.5 -210.5t-258 -146t-323 -54.5q-271 0 -496 145q35 -4 78 -4q225 0 401 138q-105 2 -188 64.5t-114 159.5q33 -5 61 -5q43 0 85 11q-112 23 -185.5 111.5t-73.5 205.5v4q68 -38 146 -41 q-66 44 -105 115t-39 154q0 88 44 163q121 -149 294.5 -238.5t371.5 -99.5q-8 38 -8 74q0 134 94.5 228.5t228.5 94.5q140 0 236 -102q109 21 205 78q-37 -115 -142 -178q93 10 186 50z" />
+<glyph unicode="" horiz-adv-x="768" d="M511 980h257l-30 -284h-227v-824h-341v824h-170v284h170v171q0 182 86 275.5t283 93.5h227v-284h-142q-39 0 -62.5 -6.5t-34 -23.5t-13.5 -34.5t-3 -49.5v-142z" />
+<glyph unicode="" d="M1536 640q0 -251 -146.5 -451.5t-378.5 -277.5q-27 -5 -39.5 7t-12.5 30v211q0 97 -52 142q57 6 102.5 18t94 39t81 66.5t53 105t20.5 150.5q0 121 -79 206q37 91 -8 204q-28 9 -81 -11t-92 -44l-38 -24q-93 26 -192 26t-192 -26q-16 11 -42.5 27t-83.5 38.5t-86 13.5 q-44 -113 -7 -204q-79 -85 -79 -206q0 -85 20.5 -150t52.5 -105t80.5 -67t94 -39t102.5 -18q-40 -36 -49 -103q-21 -10 -45 -15t-57 -5t-65.5 21.5t-55.5 62.5q-19 32 -48.5 52t-49.5 24l-20 3q-21 0 -29 -4.5t-5 -11.5t9 -14t13 -12l7 -5q22 -10 43.5 -38t31.5 -51l10 -23 q13 -38 44 -61.5t67 -30t69.5 -7t55.5 3.5l23 4q0 -38 0.5 -89t0.5 -54q0 -18 -13 -30t-40 -7q-232 77 -378.5 277.5t-146.5 451.5q0 209 103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" horiz-adv-x="1664" d="M1664 960v-256q0 -26 -19 -45t-45 -19h-64q-26 0 -45 19t-19 45v256q0 106 -75 181t-181 75t-181 -75t-75 -181v-192h96q40 0 68 -28t28 -68v-576q0 -40 -28 -68t-68 -28h-960q-40 0 -68 28t-28 68v576q0 40 28 68t68 28h672v192q0 185 131.5 316.5t316.5 131.5 t316.5 -131.5t131.5 -316.5z" />
+<glyph unicode="" horiz-adv-x="1920" d="M1760 1408q66 0 113 -47t47 -113v-1216q0 -66 -47 -113t-113 -47h-1600q-66 0 -113 47t-47 113v1216q0 66 47 113t113 47h1600zM160 1280q-13 0 -22.5 -9.5t-9.5 -22.5v-224h1664v224q0 13 -9.5 22.5t-22.5 9.5h-1600zM1760 0q13 0 22.5 9.5t9.5 22.5v608h-1664v-608 q0 -13 9.5 -22.5t22.5 -9.5h1600zM256 128v128h256v-128h-256zM640 128v128h384v-128h-384z" />
+<glyph unicode="" horiz-adv-x="1408" d="M384 192q0 -80 -56 -136t-136 -56t-136 56t-56 136t56 136t136 56t136 -56t56 -136zM896 69q2 -28 -17 -48q-18 -21 -47 -21h-135q-25 0 -43 16.5t-20 41.5q-22 229 -184.5 391.5t-391.5 184.5q-25 2 -41.5 20t-16.5 43v135q0 29 21 47q17 17 43 17h5q160 -13 306 -80.5 t259 -181.5q114 -113 181.5 -259t80.5 -306zM1408 67q2 -27 -18 -47q-18 -20 -46 -20h-143q-26 0 -44.5 17.5t-19.5 42.5q-12 215 -101 408.5t-231.5 336t-336 231.5t-408.5 102q-25 1 -42.5 19.5t-17.5 43.5v143q0 28 20 46q18 18 44 18h3q262 -13 501.5 -120t425.5 -294 q187 -186 294 -425.5t120 -501.5z" />
+<glyph unicode="" d="M1040 320q0 -33 -23.5 -56.5t-56.5 -23.5t-56.5 23.5t-23.5 56.5t23.5 56.5t56.5 23.5t56.5 -23.5t23.5 -56.5zM1296 320q0 -33 -23.5 -56.5t-56.5 -23.5t-56.5 23.5t-23.5 56.5t23.5 56.5t56.5 23.5t56.5 -23.5t23.5 -56.5zM1408 160v320q0 13 -9.5 22.5t-22.5 9.5 h-1216q-13 0 -22.5 -9.5t-9.5 -22.5v-320q0 -13 9.5 -22.5t22.5 -9.5h1216q13 0 22.5 9.5t9.5 22.5zM178 640h1180l-157 482q-4 13 -16 21.5t-26 8.5h-782q-14 0 -26 -8.5t-16 -21.5zM1536 480v-320q0 -66 -47 -113t-113 -47h-1216q-66 0 -113 47t-47 113v320q0 25 16 75 l197 606q17 53 63 86t101 33h782q55 0 101 -33t63 -86l197 -606q16 -50 16 -75z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1664 896q53 0 90.5 -37.5t37.5 -90.5t-37.5 -90.5t-90.5 -37.5v-384q0 -52 -38 -90t-90 -38q-417 347 -812 380q-58 -19 -91 -66t-31 -100.5t40 -92.5q-20 -33 -23 -65.5t6 -58t33.5 -55t48 -50t61.5 -50.5q-29 -58 -111.5 -83t-168.5 -11.5t-132 55.5q-7 23 -29.5 87.5 t-32 94.5t-23 89t-15 101t3.5 98.5t22 110.5h-122q-66 0 -113 47t-47 113v192q0 66 47 113t113 47h480q435 0 896 384q52 0 90 -38t38 -90v-384zM1536 292v954q-394 -302 -768 -343v-270q377 -42 768 -341z" />
+<glyph unicode="" horiz-adv-x="1664" d="M848 -160q0 16 -16 16q-59 0 -101.5 42.5t-42.5 101.5q0 16 -16 16t-16 -16q0 -73 51.5 -124.5t124.5 -51.5q16 0 16 16zM183 128h1298q-164 181 -246.5 411.5t-82.5 484.5q0 256 -320 256t-320 -256q0 -254 -82.5 -484.5t-246.5 -411.5zM1664 128q0 -52 -38 -90t-90 -38 h-448q0 -106 -75 -181t-181 -75t-181 75t-75 181h-448q-52 0 -90 38t-38 90q190 161 287 397.5t97 498.5q0 165 96 262t264 117q-8 18 -8 37q0 40 28 68t68 28t68 -28t28 -68q0 -19 -8 -37q168 -20 264 -117t96 -262q0 -262 97 -498.5t287 -397.5z" />
+<glyph unicode="" d="M1376 640l138 -135q30 -28 20 -70q-12 -41 -52 -51l-188 -48l53 -186q12 -41 -19 -70q-29 -31 -70 -19l-186 53l-48 -188q-10 -40 -51 -52q-12 -2 -19 -2q-31 0 -51 22l-135 138l-135 -138q-28 -30 -70 -20q-41 11 -51 52l-48 188l-186 -53q-41 -12 -70 19q-31 29 -19 70 l53 186l-188 48q-40 10 -52 51q-10 42 20 70l138 135l-138 135q-30 28 -20 70q12 41 52 51l188 48l-53 186q-12 41 19 70q29 31 70 19l186 -53l48 188q10 41 51 51q41 12 70 -19l135 -139l135 139q29 30 70 19q41 -10 51 -51l48 -188l186 53q41 12 70 -19q31 -29 19 -70 l-53 -186l188 -48q40 -10 52 -51q10 -42 -20 -70z" />
+<glyph unicode="" horiz-adv-x="1792" d="M256 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1664 768q0 51 -39 89.5t-89 38.5h-576q0 20 15 48.5t33 55t33 68t15 84.5q0 67 -44.5 97.5t-115.5 30.5q-24 0 -90 -139q-24 -44 -37 -65q-40 -64 -112 -145q-71 -81 -101 -106 q-69 -57 -140 -57h-32v-640h32q72 0 167 -32t193.5 -64t179.5 -32q189 0 189 167q0 26 -5 56q30 16 47.5 52.5t17.5 73.5t-18 69q53 50 53 119q0 25 -10 55.5t-25 47.5h331q52 0 90 38t38 90zM1792 769q0 -105 -75.5 -181t-180.5 -76h-169q-4 -62 -37 -119q3 -21 3 -43 q0 -101 -60 -178q1 -139 -85 -219.5t-227 -80.5q-133 0 -322 69q-164 59 -223 59h-288q-53 0 -90.5 37.5t-37.5 90.5v640q0 53 37.5 90.5t90.5 37.5h288q10 0 21.5 4.5t23.5 14t22.5 18t24 22.5t20.5 21.5t19 21.5t14 17q65 74 100 129q13 21 33 62t37 72t40.5 63t55 49.5 t69.5 17.5q125 0 206.5 -67t81.5 -189q0 -68 -22 -128h374q104 0 180 -76t76 -179z" />
+<glyph unicode="" horiz-adv-x="1792" d="M1376 128h32v640h-32q-35 0 -67.5 12t-62.5 37t-50 46t-49 54q-2 3 -3.5 4.5t-4 4.5t-4.5 5q-72 81 -112 145q-14 22 -38 68q-1 3 -10.5 22.5t-18.5 36t-20 35.5t-21.5 30.5t-18.5 11.5q-71 0 -115.5 -30.5t-44.5 -97.5q0 -43 15 -84.5t33 -68t33 -55t15 -48.5h-576 q-50 0 -89 -38.5t-39 -89.5q0 -52 38 -90t90 -38h331q-15 -17 -25 -47.5t-10 -55.5q0 -69 53 -119q-18 -32 -18 -69t17.5 -73.5t47.5 -52.5q-4 -24 -4 -56q0 -85 48.5 -126t135.5 -41q84 0 183 32t194 64t167 32zM1664 192q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45 t45 -19t45 19t19 45zM1792 768v-640q0 -53 -37.5 -90.5t-90.5 -37.5h-288q-59 0 -223 -59q-190 -69 -317 -69q-142 0 -230 77.5t-87 217.5l1 5q-61 76 -61 178q0 22 3 43q-33 57 -37 119h-169q-105 0 -180.5 76t-75.5 181q0 103 76 179t180 76h374q-22 60 -22 128 q0 122 81.5 189t206.5 67q38 0 69.5 -17.5t55 -49.5t40.5 -63t37 -72t33 -62q35 -55 100 -129q2 -3 14 -17t19 -21.5t20.5 -21.5t24 -22.5t22.5 -18t23.5 -14t21.5 -4.5h288q53 0 90.5 -37.5t37.5 -90.5z" />
+<glyph unicode="" d="M1280 -64q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1408 700q0 189 -167 189q-26 0 -56 -5q-16 30 -52.5 47.5t-73.5 17.5t-69 -18q-50 53 -119 53q-25 0 -55.5 -10t-47.5 -25v331q0 52 -38 90t-90 38q-51 0 -89.5 -39t-38.5 -89v-576 q-20 0 -48.5 15t-55 33t-68 33t-84.5 15q-67 0 -97.5 -44.5t-30.5 -115.5q0 -24 139 -90q44 -24 65 -37q64 -40 145 -112q81 -71 106 -101q57 -69 57 -140v-32h640v32q0 72 32 167t64 193.5t32 179.5zM1536 705q0 -133 -69 -322q-59 -164 -59 -223v-288q0 -53 -37.5 -90.5 t-90.5 -37.5h-640q-53 0 -90.5 37.5t-37.5 90.5v288q0 10 -4.5 21.5t-14 23.5t-18 22.5t-22.5 24t-21.5 20.5t-21.5 19t-17 14q-74 65 -129 100q-21 13 -62 33t-72 37t-63 40.5t-49.5 55t-17.5 69.5q0 125 67 206.5t189 81.5q68 0 128 -22v374q0 104 76 180t179 76 q105 0 181 -75.5t76 -180.5v-169q62 -4 119 -37q21 3 43 3q101 0 178 -60q139 1 219.5 -85t80.5 -227z" />
+<glyph unicode="" d="M1408 576q0 84 -32 183t-64 194t-32 167v32h-640v-32q0 -35 -12 -67.5t-37 -62.5t-46 -50t-54 -49q-9 -8 -14 -12q-81 -72 -145 -112q-22 -14 -68 -38q-3 -1 -22.5 -10.5t-36 -18.5t-35.5 -20t-30.5 -21.5t-11.5 -18.5q0 -71 30.5 -115.5t97.5 -44.5q43 0 84.5 15t68 33 t55 33t48.5 15v-576q0 -50 38.5 -89t89.5 -39q52 0 90 38t38 90v331q46 -35 103 -35q69 0 119 53q32 -18 69 -18t73.5 17.5t52.5 47.5q24 -4 56 -4q85 0 126 48.5t41 135.5zM1280 1344q0 26 -19 45t-45 19t-45 -19t-19 -45t19 -45t45 -19t45 19t19 45zM1536 580 q0 -142 -77.5 -230t-217.5 -87l-5 1q-76 -61 -178 -61q-22 0 -43 3q-54 -30 -119 -37v-169q0 -105 -76 -180.5t-181 -75.5q-103 0 -179 76t-76 180v374q-54 -22 -128 -22q-121 0 -188.5 81.5t-67.5 206.5q0 38 17.5 69.5t49.5 55t63 40.5t72 37t62 33q55 35 129 100 q3 2 17 14t21.5 19t21.5 20.5t22.5 24t18 22.5t14 23.5t4.5 21.5v288q0 53 37.5 90.5t90.5 37.5h640q53 0 90.5 -37.5t37.5 -90.5v-288q0 -59 59 -223q69 -190 69 -317z" />
+<glyph unicode="" d="M1280 576v128q0 26 -19 45t-45 19h-502l189 189q19 19 19 45t-19 45l-91 91q-18 18 -45 18t-45 -18l-362 -362l-91 -91q-18 -18 -18 -45t18 -45l91 -91l362 -362q18 -18 45 -18t45 18l91 91q18 18 18 45t-18 45l-189 189h502q26 0 45 19t19 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1285 640q0 27 -18 45l-91 91l-362 362q-18 18 -45 18t-45 -18l-91 -91q-18 -18 -18 -45t18 -45l189 -189h-502q-26 0 -45 -19t-19 -45v-128q0 -26 19 -45t45 -19h502l-189 -189q-19 -19 -19 -45t19 -45l91 -91q18 -18 45 -18t45 18l362 362l91 91q18 18 18 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1284 641q0 27 -18 45l-362 362l-91 91q-18 18 -45 18t-45 -18l-91 -91l-362 -362q-18 -18 -18 -45t18 -45l91 -91q18 -18 45 -18t45 18l189 189v-502q0 -26 19 -45t45 -19h128q26 0 45 19t19 45v502l189 -189q19 -19 45 -19t45 19l91 91q18 18 18 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M1284 639q0 27 -18 45l-91 91q-18 18 -45 18t-45 -18l-189 -189v502q0 26 -19 45t-45 19h-128q-26 0 -45 -19t-19 -45v-502l-189 189q-19 19 -45 19t-45 -19l-91 -91q-18 -18 -18 -45t18 -45l362 -362l91 -91q18 -18 45 -18t45 18l91 91l362 362q18 18 18 45zM1536 640 q0 -209 -103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103t385.5 -103t279.5 -279.5t103 -385.5z" />
+<glyph unicode="" d="M768 1408q209 0 385.5 -103t279.5 -279.5t103 -385.5t-103 -385.5t-279.5 -279.5t-385.5 -103t-385.5 103t-279.5 279.5t-103 385.5t103 385.5t279.5 279.5t385.5 103zM1042 887q-2 -1 -9.5 -9.5t-13.5 -9.5q2 0 4.5 5t5 11t3.5 7q6 7 22 15q14 6 52 12q34 8 51 -11 q-2 2 9.5 13t14.5 12q3 2 15 4.5t15 7.5l2 22q-12 -1 -17.5 7t-6.5 21q0 -2 -6 -8q0 7 -4.5 8t-11.5 -1t-9 -1q-10 3 -15 7.5t-8 16.5t-4 15q-2 5 -9.5 10.5t-9.5 10.5q-1 2 -2.5 5.5t-3 6.5t-4 5.5t-5.5 2.5t-7 -5t-7.5 -10t-4.5 -5q-3 2 -6 1.5t-4.5 -1t-4.5 -3t-5 -3.5 q-3 -2 -8.5 -3t-8.5 -2q15 5 -1 11q-10 4 -16 3q9 4 7.5 12t-8.5 14h5q-1 4 -8.5 8.5t-17.5 8.5t-13 6q-8 5 -34 9.5t-33 0.5q-5 -6 -4.5 -10.5t4 -14t3.5 -12.5q1 -6 -5.5 -13t-6.5 -12q0 -7 14 -15.5t10 -21.5q-3 -8 -16 -16t-16 -12q-5 -8 -1.5 -18.5t10.5 -16.5 q2 -2 1.5 -4t-3.5 -4.5t-5.5 -4t-6.5 -3.5l-3 -2q-11 -5 -20.5 6t-13.5 26q-7 25 -16 30q-23 8 -29 -1q-5 13 -41 26q-25 9 -58 4q6 1 0 15q-7 15 -19 12q3 6 4 17.5t1 13.5q3 13 12 23q1 1 7 8.5t9.5 13.5t0.5 6q35 -4 50 11q5 5 11.5 17
t10.5 17q9 6 14 5.5t14.5 -5.5 t14.5 -5q14 -1 15.5 11t-7.5 20q12 -1 3 17q-5 7 -8 9q-12 4 -27 -5q-8 -4 2 -8q-1 1 -9.5 -10.5t-16.5 -17.5t-16 5q-1 1 -5.5 13.5t-9.5 13.5q-8 0 -16 -15q3 8 -11 15t-24 8q19 12 -8 27q-7 4 -20.5 5t-19.5 -4q-5 -7 -5.5 -11.5t5 -8t10.5 -5.5t11.5 -4t8.5 -3 q14 -10 8 -14q-2 -1 -8.5 -3.5t-11.5 -4.5t-6 -4q-3 -4 0 -14t-2 -14q-5 5 -9 17.5t-7 16.5q7 -9 -25 -6l-10 1q-4 0 -16 -2t-20.5 -1t-13.5 8q-4 8 0 20q1 4 4 2q-4 3 -11 9.5t-10 8.5q-46 -15 -94 -41q6 -1 12 1q5 2 13 6.5t10 5.5q34 14 42 7l5 5q14 -16 20 -25 q-7 4 -30 1q-20 -6 -22 -12q7 -12 5 -18q-4 3 -11.5 10t-14.5 11t-15 5q-16 0 -22 -1q-146 -80 -235 -222q7 -7 12 -8q4 -1 5 -9t2.5 -11t11.5 3q9 -8 3 -19q1 1 44 -27q19 -17 21 -21q3 -11 -10 -18q-1 2 -9 9t-9 4q-3 -5 0.5 -18.5t10.5 -12.5q-7 0 -9.5 -16t-2.5 -35.5 t-1 -23.5l2 -1q-3 -12 5.5 -34.5t21.5 -19.5q-13 -3 20 -43q6 -8 8 -9q3 -2 12 -7.5t15 -10t10 -10.5q4 -5 10 -22.5t14 -23.5q-2 -6 9.5 -20t10.5 -23q-1 0 -2.5 -1t-2.5 -1q3 -7 15.5 -14t15.5 -13q1 -3 2 -10t3 -11t8 -2q2 20 -24 62q-1
5 25 -17 29q-3 5 -5.5 15.5 t-4.5 14.5q2 0 6 -1.5t8.5 -3.5t7.5 -4t2 -3q-3 -7 2 -17.5t12 -18.5t17 -19t12 -13q6 -6 14 -19.5t0 -13.5q9 0 20 -10t17 -20q5 -8 8 -26t5 -24q2 -7 8.5 -13.5t12.5 -9.5l16 -8t13 -7q5 -2 18.5 -10.5t21.5 -11.5q10 -4 16 -4t14.5 2.5t13.5 3.5q15 2 29 -15t21 -21 q36 -19 55 -11q-2 -1 0.5 -7.5t8 -15.5t9 -14.5t5.5 -8.5q5 -6 18 -15t18 -15q6 4 7 9q-3 -8 7 -20t18 -10q14 3 14 32q-31 -15 -49 18q0 1 -2.5 5.5t-4 8.5t-2.5 8.5t0 7.5t5 3q9 0 10 3.5t-2 12.5t-4 13q-1 8 -11 20t-12 15q-5 -9 -16 -8t-16 9q0 -1 -1.5 -5.5t-1.5 -6.5 q-13 0 -15 1q1 3 2.5 17.5t3.5 22.5q1 4 5.5 12t7.5 14.5t4 12.5t-4.5 9.5t-17.5 2.5q-19 -1 -26 -20q-1 -3 -3 -10.5t-5 -11.5t-9 -7q-7 -3 -24 -2t-24 5q-13 8 -22.5 29t-9.5 37q0 10 2.5 26.5t3 25t-5.5 24.5q3 2 9 9.5t10 10.5q2 1 4.5 1.5t4.5 0t4 1.5t3 6q-1 1 -4 3 q-3 3 -4 3q7 -3 28.5 1.5t27.5 -1.5q15 -11 22 2q0 1 -2.5 9.5t-0.5 13.5q5 -27 29 -9q3 -3 15.5 -5t17.5 -5q3 -2 7 -5.5t5.5 -4.5t5 0.5t8.5 6.5q10 -14 12 -24q11 -40 19 -44q7 -3 11 -2t4.5 9.5t0 14t-1.5 12.5l-1 8v18l-1 8q
-15 3 -18.5 12t1.5 18.5t15 18.5q1 1 8 3.5 t15.5 6.5t12.5 8q21 19 15 35q7 0 11 9q-1 0 -5 3t-7.5 5t-4.5 2q9 5 2 16q5 3 7.5 11t7.5 10q9 -12 21 -2q7 8 1 16q5 7 20.5 10.5t18.5 9.5q7 -2 8 2t1 12t3 12q4 5 15 9t13 5l17 11q3 4 0 4q18 -2 31 11q10 11 -6 20q3 6 -3 9.5t-15 5.5q3 1 11.5 0.5t10.5 1.5 q15 10 -7 16q-17 5 -43 -12zM879 10q206 36 351 189q-3 3 -12.5 4.5t-12.5 3.5q-18 7 -24 8q1 7 -2.5 13t-8 9t-12.5 8t-11 7q-2 2 -7 6t-7 5.5t-7.5 4.5t-8.5 2t-10 -1l-3 -1q-3 -1 -5.5 -2.5t-5.5 -3t-4 -3t0 -2.5q-21 17 -36 22q-5 1 -11 5.5t-10.5 7t-10 1.5t-11.5 -7 q-5 -5 -6 -15t-2 -13q-7 5 0 17.5t2 18.5q-3 6 -10.5 4.5t-12 -4.5t-11.5 -8.5t-9 -6.5t-8.5 -5.5t-8.5 -7.5q-3 -4 -6 -12t-5 -11q-2 4 -11.5 6.5t-9.5 5.5q2 -10 4 -35t5 -38q7 -31 -12 -48q-27 -25 -29 -40q-4 -22 12 -26q0 -7 -8 -20.5t-7 -21.5q0 -6 2 -16z" />
+<glyph unicode="" horiz-adv-x="1664"
<TRUNCATED>
[14/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/plus.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/plus.png b/docs/latest/_static/plus.png
index 7107cec..0cfe084 100644
Binary files a/docs/latest/_static/plus.png and b/docs/latest/_static/plus.png differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/pygments.css
----------------------------------------------------------------------
diff --git a/docs/latest/_static/pygments.css b/docs/latest/_static/pygments.css
index 8213e90..57eadc0 100644
--- a/docs/latest/_static/pygments.css
+++ b/docs/latest/_static/pygments.css
@@ -4,10 +4,8 @@
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
-.highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
-.highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/searchtools.js
----------------------------------------------------------------------
diff --git a/docs/latest/_static/searchtools.js b/docs/latest/_static/searchtools.js
index bbfb3ac..0e794fd 100644
--- a/docs/latest/_static/searchtools.js
+++ b/docs/latest/_static/searchtools.js
@@ -2,15 +2,14 @@
* searchtools.js_t
* ~~~~~~~~~~~~~~~~
*
- * Sphinx JavaScript utilities for the full-text search.
+ * Sphinx JavaScript utilties for the full-text search.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
-/* Non-minified version JS is _stemmer.js if file is provided */
/**
* Porter Stemmer
*/
@@ -226,106 +225,6 @@ var Scorer = {
};
-
-
-
-var splitChars = (function() {
- var result = {};
- var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
- 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
- 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
- 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
- 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
- 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
- 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
- 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
- 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
- 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
- var i, j, start, end;
- for (i = 0; i < singles.length; i++) {
- result[singles[i]] = true;
- }
- var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
- [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
- [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
- [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
- [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
- [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
- [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
- [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
- [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
- [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
- [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
- [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
- [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
- [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
- [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
- [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
- [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
- [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
- [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
- [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
- [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
- [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
- [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
- [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
- [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
- [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
- [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
- [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
- [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
- [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
- [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
- [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
- [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
- [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
- [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
- [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
- [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
- [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
- [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
- [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
- [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
- [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
- [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
- [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
- [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
- [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
- [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
- [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
- [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
- for (i = 0; i < ranges.length; i++) {
- start = ranges[i][0];
- end = ranges[i][1];
- for (j = start; j <= end; j++) {
- result[j] = true;
- }
- }
- return result;
-})();
-
-function splitQuery(query) {
- var result = [];
- var start = -1;
- for (var i = 0; i < query.length; i++) {
- if (splitChars[query.charCodeAt(i)]) {
- if (start !== -1) {
- result.push(query.slice(start, i));
- start = -1;
- }
- } else if (start === -1) {
- start = i;
- }
- }
- if (start !== -1) {
- result.push(query.slice(start));
- }
- return result;
-}
-
-
-
-
/**
* Search Module
*/
@@ -424,7 +323,7 @@ var Search = {
var searchterms = [];
var excluded = [];
var hlterms = [];
- var tmp = splitQuery(query);
+ var tmp = query.split(/\s+/);
var objectterms = [];
for (i = 0; i < tmp.length; i++) {
if (tmp[i] !== "") {
@@ -438,10 +337,6 @@ var Search = {
}
// stem the word
var word = stemmer.stemWord(tmp[i].toLowerCase());
- // prevent stemmer from cutting word smaller than two chars
- if(word.length < 3 && tmp[i].length >= 3) {
- word = tmp[i];
- }
var toAppend;
// select the correct list
if (word[0] == '-') {
@@ -478,7 +373,8 @@ var Search = {
}
// lookup as search terms in fulltext
- results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
+ results = results.concat(this.performTermsSearch(searchterms, excluded, terms, Scorer.term))
+ .concat(this.performTermsSearch(searchterms, excluded, titleterms, Scorer.title));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
@@ -539,8 +435,7 @@ var Search = {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
- var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
- $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
+ $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[0] + '.txt',
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
@@ -579,7 +474,6 @@ var Search = {
*/
performObjectSearch : function(object, otherterms) {
var filenames = this._index.filenames;
- var docnames = this._index.docnames;
var objects = this._index.objects;
var objnames = this._index.objnames;
var titles = this._index.titles;
@@ -633,7 +527,7 @@ var Search = {
} else {
score += Scorer.objPrioDefault;
}
- results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
+ results.push([filenames[match[0]], fullname, '#'+anchor, descr, score]);
}
}
}
@@ -644,48 +538,23 @@ var Search = {
/**
* search for full-text terms in the index
*/
- performTermsSearch : function(searchterms, excluded, terms, titleterms) {
- var docnames = this._index.docnames;
+ performTermsSearch : function(searchterms, excluded, terms, score) {
var filenames = this._index.filenames;
var titles = this._index.titles;
- var i, j, file;
+ var i, j, file, files;
var fileMap = {};
- var scoreMap = {};
var results = [];
// perform the search on the required terms
for (i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
- var files = [];
- var _o = [
- {files: terms[word], score: Scorer.term},
- {files: titleterms[word], score: Scorer.title}
- ];
-
// no match but word was a required one
- if ($u.every(_o, function(o){return o.files === undefined;})) {
+ if ((files = terms[word]) === undefined)
break;
+ if (files.length === undefined) {
+ files = [files];
}
- // found search word in contents
- $u.each(_o, function(o) {
- var _files = o.files;
- if (_files === undefined)
- return
-
- if (_files.length === undefined)
- _files = [_files];
- files = files.concat(_files);
-
- // set score for the word in each file to Scorer.term
- for (j = 0; j < _files.length; j++) {
- file = _files[j];
- if (!(file in scoreMap))
- scoreMap[file] = {}
- scoreMap[file][word] = o.score;
- }
- });
-
// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
@@ -707,9 +576,7 @@ var Search = {
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
- titleterms[excluded[i]] == file ||
- $u.contains(terms[excluded[i]] || [], file) ||
- $u.contains(titleterms[excluded[i]] || [], file)) {
+ $u.contains(terms[excluded[i]] || [], file)) {
valid = false;
break;
}
@@ -717,10 +584,7 @@ var Search = {
// if we have still a valid result we can add it to the result list
if (valid) {
- // select one (max) score for the file.
- // for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
- var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
- results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
+ results.push([filenames[file], titles[file], '', null, score]);
}
}
return results;
@@ -730,7 +594,7 @@ var Search = {
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
- * words. the first one is used to find the occurrence, the
+ * words. the first one is used to find the occurance, the
* latter for highlighting it.
*/
makeSearchSummary : function(text, keywords, hlwords) {
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/up-pressed.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/up-pressed.png b/docs/latest/_static/up-pressed.png
index acee3b6..99e7210 100644
Binary files a/docs/latest/_static/up-pressed.png and b/docs/latest/_static/up-pressed.png differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/up.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/up.png b/docs/latest/_static/up.png
index 2a940a7..26de002 100644
Binary files a/docs/latest/_static/up.png and b/docs/latest/_static/up.png differ
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/websupport.js
----------------------------------------------------------------------
diff --git a/docs/latest/_static/websupport.js b/docs/latest/_static/websupport.js
index 98e7f40..28d65db 100644
--- a/docs/latest/_static/websupport.js
+++ b/docs/latest/_static/websupport.js
@@ -2,9 +2,9 @@
* websupport.js
* ~~~~~~~~~~~~~
*
- * sphinx.websupport utilities for all documentation.
+ * sphinx.websupport utilties for all documentation.
*
- * :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2015 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/index.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/index.html b/docs/latest/admin/index.html
index 4abf6f5..6a89fa6 100644
--- a/docs/latest/admin/index.html
+++ b/docs/latest/admin/index.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Administrator’s Guide — Traffic Control 1.8.1 documentation </title>
+ <title>Administrator’s Guide — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="next" title="Installing Traffic Ops" href="traffic_ops_install.html"/>
<link rel="prev" title="Traffic Vault" href="../overview/traffic_vault.html"/>
@@ -103,7 +100,7 @@
</li>
</ul>
<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">Administrator’s Guide</a><ul>
+<li class="toctree-l1 current"><a class="current reference internal" href="">Administrator’s Guide</a><ul>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
@@ -161,12 +158,12 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li>Administrator’s Guide</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/index.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/index.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -387,7 +384,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/quick_howto/dnssec.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/dnssec.html b/docs/latest/admin/quick_howto/dnssec.html
index 4b6fd46..ed42b2f 100644
--- a/docs/latest/admin/quick_howto/dnssec.html
+++ b/docs/latest/admin/quick_howto/dnssec.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure DNSSEC — Traffic Control 1.8.1 documentation </title>
+ <title>Configure DNSSEC — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../genindex.html"/>
- <link rel="search" title="Search" href="../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
<link rel="next" title="Configure Federations" href="federations.html"/>
<link rel="prev" title="Configure Multi Site Origin" href="multi_site.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../index.html">Administrator’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Configure DNSSEC</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/dnssec.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/dnssec.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -202,7 +199,7 @@
<ol class="arabic simple">
<li>Go to Tools->Manage DNSSEC Keys choose a CDN and click Manage DNSSEC Keys</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec01.png"><img alt="../../_images/dnssec01.png" class="align-center" src="../../_images/dnssec01.png" style="width: 1100.0px; height: 280.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec01.png"><img alt="../../_images/dnssec01.png" class="align-center" src="../../_images/dnssec01.png" /></a>
<ol class="arabic" start="2">
<li><p class="first">Generate keys for a CDN by clicking Generate Keys then entering the following information:</p>
<blockquote>
@@ -216,20 +213,20 @@
<p>Depending upon the number of Delivery Services in the CDN, generating DNSSEC keys may take serveral seconds.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" style="width: 747.0px; height: 454.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec02.png"><img alt="../../_images/dnssec02.png" class="align-center" src="../../_images/dnssec02.png" /></a>
<ol class="arabic" start="3">
<li><p class="first">In order for DNSSEC to work properly, the DS Record information needs to be added to the parent zone of the CDN’s domain (e.g. If the CDN’s domain is ‘cdn.kabletown.net’ the parent zone is ‘kabletown.net’).</p>
<p>If you control your parent zone you can enter this information yourself, otherwise you will need to work with your DNS team to get the DS Record added to the parent zone.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" style="width: 499.1px; height: 190.4px;" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec03.png"><img alt="../../_images/dnssec03.png" class="align-center" src="../../_images/dnssec03.png" /></a>
<ol class="arabic" start="4">
<li><p class="first">Once DS Record information has been added to the parent zone, DNSSEC needs to be activated for the CDN so that Traffic Router will sign responses.</p>
<p>Click on Tools -> Manage DNSSEC Keys -> Choose your CDN -> On the Manage DNSSEC Keys page click the activate DNSSEC Keys button.</p>
<p>This will add a ‘dnssec.enabled = “true”’ entry to CRConfig for the chosen CDN.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" style="width: 554.4px; height: 422.8px;" /></a>
+<a class="reference internal image-reference" href="../../_images/dnssec04.png"><img alt="../../_images/dnssec04.png" class="align-center" src="../../_images/dnssec04.png" /></a>
<ol class="arabic" start="5">
<li><p class="first">DNSSEC should now be active on your CDN and Traffic Router should be signing responses.</p>
<blockquote>
@@ -281,7 +278,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/quick_howto/federations.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/federations.html b/docs/latest/admin/quick_howto/federations.html
index 648b054..36ead69 100644
--- a/docs/latest/admin/quick_howto/federations.html
+++ b/docs/latest/admin/quick_howto/federations.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure Federations — Traffic Control 1.8.1 documentation </title>
+ <title>Configure Federations — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../genindex.html"/>
- <link rel="search" title="Search" href="../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
<link rel="next" title="Configure Regional Geo-blocking (RGB)" href="regionalgeo.html"/>
<link rel="prev" title="Configure DNSSEC" href="dnssec.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../index.html">Administrator’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Configure Federations</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/federations.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/federations.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -203,24 +200,24 @@
</div></blockquote>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" style="width: 804.0px; height: 690.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/federation01.png"><img alt="../../_images/federation01.png" class="align-center" src="../../_images/federation01.png" /></a>
<ol class="arabic simple" start="2">
<li>As a user with admin priveleges, create a Federation Mapping by going to Delivery Services -> Federations and then clicking ‘Add Federation Mapping’</li>
<li>Choose the Delivery Service for the federation to be mapped to and assign it to the Federation User; click Add.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" style="width: 766.0px; height: 494.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/federation02.png"><img alt="../../_images/federation02.png" class="align-center" src="../../_images/federation02.png" /></a>
<ol class="arabic" start="4">
<li><p class="first">After the Federation is added, Traffic Ops will display the Federation.</p>
<p>Changes can be made at this time or the Federation can be deleted. Notice that no resolvers have been added to the fedeation yet. This can only be done by the federation user created in step 1.</p>
<p>If no further action is necessary, the Close button will close the window and display the list of all Federations.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation03.png"><img alt="../../_images/federation03.png" class="align-center" src="../../_images/federation03.png" style="width: 806.0px; height: 886.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/federation03.png"><img alt="../../_images/federation03.png" class="align-center" src="../../_images/federation03.png" /></a>
<p><strong>The Federation user can now add resolvers to the Federation Mapping in Traffic Ops.</strong></p>
<ol class="arabic" start="5">
<li><p class="first">The federation user logs to traffic ops and stores the mojolicious cookie. The mojolicious cookie can be obtained manually using the debug tools on a web browser or via curl.</p>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
+<div class="highlight-python"><div class="highlight"><pre>$ curl -i -XPOST "http://localhost:3000/api/1.1/user/login" -H "Content-Type: application/json" -d '{ "u": "federation_user1", "p": "password" }'
HTTP/1.1 200 OK
Date: Wed, 02 Dec 2015 21:12:06 GMT
@@ -242,7 +239,7 @@ Access-Control-Allow-Origin: http://localhost:8080
<li><p class="first">The federation user sends a request to Traffic Ops to add IPV4 and/or IPV6 resolvers</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
+<div class="highlight-python"><div class="highlight"><pre>$ curl -ki -H "Cookie: mojolicious=eyJleHBpcmVzIjoxNDQ5MTA1MTI2LCJhdXRoX2RhdGEiOiJmZWRlcmF0aW9uX3VzZXIxIn0---06b4f870d809d82a91433e92eae8320875c3e8b0;" -XPUT 'http://localhost:3000/api/1.2/federations' -d '
{"federations": [
{ "deliveryService": "images-c1",
"mappings":
@@ -274,12 +271,12 @@ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
<li><p class="first">The resolvers added by the federation user will now visible in Traffic Ops.</p>
</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/federation04.png"><img alt="../../_images/federation04.png" class="align-center" src="../../_images/federation04.png" style="width: 802.0px; height: 875.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/federation04.png"><img alt="../../_images/federation04.png" class="align-center" src="../../_images/federation04.png" /></a>
<ol class="arabic" start="8">
<li><p class="first">Any requests made from a client that resolves to one of the federation resolvers will now be given a CNAME from Traffic Router.</p>
<blockquote>
<div><p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$ dig @tr.kabletown.net edge.images-c1.kabletown.net
+<div class="highlight-python"><div class="highlight"><pre>$ dig @tr.kabletown.net edge.images-c1.kabletown.net
; <<>> DiG 9.7.3-RedHat-9.7.3-2.el6 <<>> @tr.kabletown.net edge.images-c1.kabletown.net
; (1 server found)
@@ -344,7 +341,7 @@ edge.images-c1.kabletown.net. 30 IN CNAME img.mega-cdn.net.
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/quick_howto/index.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/index.html b/docs/latest/admin/quick_howto/index.html
index d30e2e6..d91758e 100644
--- a/docs/latest/admin/quick_howto/index.html
+++ b/docs/latest/admin/quick_howto/index.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Quick How To Guides — Traffic Control 1.8.1 documentation </title>
+ <title>Quick How To Guides — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../genindex.html"/>
- <link rel="search" title="Search" href="../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../index.html"/>
<link rel="up" title="Administrator’s Guide" href="../index.html"/>
<link rel="next" title="Configure Multi Site Origin" href="multi_site.html"/>
<link rel="prev" title="Traffic Vault Administration" href="../traffic_vault.html"/>
@@ -115,7 +112,7 @@
<li class="toctree-l2"><a class="reference internal" href="../traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_server.html">Traffic Server Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../traffic_vault.html">Traffic Vault Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Quick How To Guides</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Quick How To Guides</a></li>
</ul>
</li>
</ul>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../index.html">Administrator’s Guide</a> »</li>
<li>Quick How To Guides</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/index.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/index.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -239,7 +236,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/quick_howto/multi_site.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/multi_site.html b/docs/latest/admin/quick_howto/multi_site.html
index c8a4bf7..10a1c16 100644
--- a/docs/latest/admin/quick_howto/multi_site.html
+++ b/docs/latest/admin/quick_howto/multi_site.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure Multi Site Origin — Traffic Control 1.8.1 documentation </title>
+ <title>Configure Multi Site Origin — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../genindex.html"/>
- <link rel="search" title="Search" href="../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
<link rel="next" title="Configure DNSSEC" href="dnssec.html"/>
<link rel="prev" title="Quick How To Guides" href="index.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../index.html">Administrator’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Configure Multi Site Origin</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/multi_site.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/multi_site.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -194,23 +191,23 @@
<ol class="arabic simple">
<li>Create “cachegroups” for the origin locations, and assign the appropriate parent-child relationship between the mid cg’s and org cgs (click the image to see full size):</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png"><img alt="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" class="align-center" src="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" style="width: 1472.0px; height: 210.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png"><img alt="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" class="align-center" src="../../_images/C5C4CD22-949A-48FD-8976-C673083E2177.png" /></a>
<ol class="arabic simple" start="2">
<li>Create a profile to assign to each of the origins:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png"><img alt="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" class="align-center" src="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" style="width: 1470.0px; height: 219.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png"><img alt="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" class="align-center" src="../../_images/19BB6EC1-B6E8-4D22-BFA0-B7D6A9708B42.png" /></a>
<ol class="arabic simple" start="3">
<li>Create server entries for the origination vips:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png"><img alt="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" class="align-center" src="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" style="width: 1468.0px; height: 166.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png"><img alt="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" class="align-center" src="../../_images/D28614AA-9758-45ED-9EFD-3A284FC4218E.png" /></a>
<ol class="arabic simple" start="4">
<li>Check the multi-site check box in the delivery service screen and make sure that Content Routing Type is set to HTTP_LIVE_NATL:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/mso-enable.png"><img alt="../../_images/mso-enable.png" class="align-center" src="../../_images/mso-enable.png" style="width: 1695.0px; height: 1079.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/mso-enable.png"><img alt="../../_images/mso-enable.png" class="align-center" src="../../_images/mso-enable.png" /></a>
<ol class="arabic simple" start="5">
<li>Assign the org servers to the delivery service that will have the multi site feature:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png"><img alt="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" class="align-center" src="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" style="width: 580.0px; height: 343.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png"><img alt="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" class="align-center" src="../../_images/066CEF4F-C1A3-4A89-8B52-4F72B0531367.png" /></a>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">“Origin Server Base URL” uniqueness: In order to enable MID caches to distinguish delivery services by different MSO algorithms while performing parent failover, it requires that “Origin Server Base URL” (OFQDN) for each MSO enabled delivery service is unique unless the exceptions listed afterwards. This means that the OFQDN of a MSO enabled delivery service should be different with the OFQDNs of any other delivery service, regardless of whether they are MSO enabled or not. The exceptions are:
@@ -257,14 +254,14 @@ round-robin</td>
<ol class="arabic simple" start="7">
<li>Optionally, there are two configuration options that can set the order of the origins used if “Primary/backup” is selected for “Multi Site Origin Algorithm”. By creating location-based cachegroups and assigning the origin servers accordingly and defining these cachegroups as parents for specific mids, location-based primary/secondary selection can be made. If primary/secondary selection should be the same for all mids, then a new parameter “rank” should be configured for each origin server profile. Origin servers with lower values of rank have higher ranking in the origin server list on MID caches, e.g. OS with rank of “2” precedes OS with the rank of “5”. For any OS, if rank value is not defined in its profile, its rank value will default to “1”. In the event that both location based cachegroups are used alongside rank, sorting will be by cachegroup first and rank second. In this way it is possible to have specific bac
kup servers for use at specific locations.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/mso-rank.png"><img alt="../../_images/mso-rank.png" class="align-center" src="../../_images/mso-rank.png" style="width: 585.0px; height: 105.6px;" /></a>
+<a class="reference internal image-reference" href="../../_images/mso-rank.png"><img alt="../../_images/mso-rank.png" class="align-center" src="../../_images/mso-rank.png" /></a>
<ol class="arabic simple" start="8">
<li>Assign the parent.config location parameter to the MID profile:</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png"><img alt="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" class="align-center" src="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" style="width: 658.0px; height: 601.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png"><img alt="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" class="align-center" src="../../_images/D22DCAA3-18CC-48F4-965B-5312993F9820.png" /></a>
<ol class="arabic" start="9">
<li><p class="first">Configure the mid hdr_rewrite on the delivery service, example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cond</span> <span class="o">%</span><span class="p">{</span><span class="n">REMAP_PSEUDO_HOOK</span><span class="p">}</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_enabled</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_enabled</span> <sp
an class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">simple_retry_response_codes</span> <span class="s2">"400,404,412"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">parent_origin</span><span class="o">.</span><span class="n">dead_server_retry_response_codes</span> <span class="s2">"502,503"</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span
> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_timeout</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries</span> <span class="mi">2</span> <span class="n">__RETURN__</span> <span class="nb">set</span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">connect_attempts_max_retries_dead_server</span> <span class="mi">1</span> <span class="n">__RETURN__</span> <span class="nb">set<
/span><span class="o">-</span><span class="n">config</span> <span class="n">proxy</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">http</span><span class="o">.</span><span class="n">transaction_active_timeout_in</span> <span class="mi">5</span> <span class="p">[</span><span class="n">L</span><span class="p">]</span> <span class="n">__RETURN__</span>
+<div class="highlight-python"><div class="highlight"><pre>cond %{REMAP_PSEUDO_HOOK} __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_enabled 1 __RETURN__ set-config proxy.config.http.parent_origin.simple_retry_response_codes "400,404,412" __RETURN__ set-config proxy.config.http.parent_origin.dead_server_retry_response_codes "502,503" __RETURN__ set-config proxy.config.http.connect_attempts_timeout 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries 2 __RETURN__ set-config proxy.config.http.connect_attempts_max_retries_dead_server 1 __RETURN__ set-config proxy.config.http.transaction_active_timeout_in 5 [L] __RETURN__
</pre></div>
</div>
</li>
@@ -311,7 +308,7 @@ round-robin</td>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/quick_howto/regionalgeo.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/regionalgeo.html b/docs/latest/admin/quick_howto/regionalgeo.html
index ee335d4..7e20d52 100644
--- a/docs/latest/admin/quick_howto/regionalgeo.html
+++ b/docs/latest/admin/quick_howto/regionalgeo.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure Regional Geo-blocking (RGB) — Traffic Control 1.8.1 documentation </title>
+ <title>Configure Regional Geo-blocking (RGB) — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../genindex.html"/>
- <link rel="search" title="Search" href="../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
<link rel="next" title="Configure Delivery Service Steering" href="steering.html"/>
<link rel="prev" title="Configure Federations" href="federations.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../index.html">Administrator’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Configure Regional Geo-blocking (RGB)</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/regionalgeo.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/regionalgeo.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -199,24 +196,24 @@
<li>Prepare RGB configuration file</li>
</ol>
<p>RGB uses a configuration file in JSON format to define regional geo-blocking rules for delivery services. The file needs to be put on an HTTP server accessible to Traffic Router. An example of the JSON is as follows:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
-<span class="s2">"deliveryServices"</span><span class="p">:</span>
- <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="s2">"hls-live"</span><span class="p">,</span>
- <span class="s2">"urlRegex"</span><span class="p">:</span> <span class="s2">".*live4</span><span class="se">\\</span><span class="s2">.m3u8"</span><span class="p">,</span>
- <span class="s2">"geoLocation"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"includePostalCode"</span><span class="p">:[</span><span class="s2">"N0H"</span><span class="p">,</span> <span class="s2">"L9V"</span><span class="p">,</span> <span class="s2">"L9W"</span><span class="p">]},</span>
- <span class="s2">"redirectUrl"</span><span class="p">:</span> <span class="s2">"http://third-party.com/blacked_out.html"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"deliveryServiceId"</span><span class="p">:</span> <span class="s2">"hls-live"</span><span class="p">,</span>
- <span class="s2">"urlRegex"</span><span class="p">:</span> <span class="s2">".*live5</span><span class="se">\\</span><span class="s2">.m3u8"</span><span class="p">,</span>
- <span class="s2">"ipWhiteList"</span><span class="p">:</span> <span class="p">[</span><span class="mf">185.68</span><span class="o">.</span><span class="mf">71.9</span><span class="o">/</span><span class="mi">22</span><span class="s2">","</span><span class="mf">142.232</span><span class="o">.</span><span class="mf">0.79</span><span class="o">/</span><span class="mi">24</span><span class="s2">"],</span>
- <span class="s2">"geoLocation"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"excludePostalCode"</span><span class="p">:[</span><span class="s2">"N0H"</span><span class="p">,</span> <span class="s2">"L9V"</span><span class="p">]},</span>
- <span class="s2">"redirectUrl"</span><span class="p">:</span> <span class="s2">"/live5_low_bitrate.m3u8"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+"deliveryServices":
+ [
+ {
+ "deliveryServiceId": "hls-live",
+ "urlRegex": ".*live4\\.m3u8",
+ "geoLocation": {"includePostalCode":["N0H", "L9V", "L9W"]},
+ "redirectUrl": "http://third-party.com/blacked_out.html"
+ },
+ {
+ "deliveryServiceId": "hls-live",
+ "urlRegex": ".*live5\\.m3u8",
+ "ipWhiteList": [185.68.71.9/22","142.232.0.79/24"],
+ "geoLocation": {"excludePostalCode":["N0H", "L9V"]},
+ "redirectUrl": "/live5_low_bitrate.m3u8"
+ }
+ ]
+}
</pre></div>
</div>
<ul class="simple">
@@ -234,23 +231,23 @@
<li>“regional_geoblocking.polling.url”: the HTTP URL of RGB configuration file. Traffic Router will fetch the file from this URL.</li>
<li>“regional_geoblocking.polling.interval”: the interval that Traffic Router polls the RGB configuration file.</li>
</ul>
-<a class="reference internal image-reference" href="../../_images/regionalgeo01.png"><img alt="../../_images/regionalgeo01.png" class="align-center" src="../../_images/regionalgeo01.png" style="width: 1234.0px; height: 430.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/regionalgeo01.png"><img alt="../../_images/regionalgeo01.png" class="align-center" src="../../_images/regionalgeo01.png" /></a>
<ol class="arabic simple" start="3">
<li>Enable RGB for a delivery service</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/regionalgeo02.png"><img alt="../../_images/regionalgeo02.png" class="align-center" src="../../_images/regionalgeo02.png" style="width: 1046.0px; height: 1054.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/regionalgeo02.png"><img alt="../../_images/regionalgeo02.png" class="align-center" src="../../_images/regionalgeo02.png" /></a>
<ol class="arabic simple" start="4">
<li>Make configuration effective</li>
</ol>
<p>Go to Tools->Snapshot CRConfig, perform “Diff CRConfig” and click “Write CRConfig”.</p>
-<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" style="width: 464.8px; height: 128.8px;" /></a>
+<a class="reference internal image-reference" href="../../_images/regionalgeo03.png"><img alt="../../_images/regionalgeo03.png" class="align-center" src="../../_images/regionalgeo03.png" /></a>
<ol class="arabic simple" start="5">
<li>Traffic Router access log with RGB</li>
</ol>
<p>RGB extends the field of “rtype” and adds a new field “rgb” in Traffic Router access.log to help to monitor the working of this feature.</p>
<p>For “rtype”, RGALT indicates that a request is redirected to an alternate URL by RGB; RGDENY indicates that a request is denied by RGB because there is no matching rule in JSON for this request.</p>
<p>For “rgb”, when RGB is enabled, it will be non-empty with following format:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span><span class="n">FSA</span><span class="p">}:{</span><span class="n">allowed</span><span class="o">/</span><span class="n">disallowed</span><span class="p">}:{</span><span class="n">include</span><span class="o">/</span><span class="n">exclude</span> <span class="n">postal</span><span class="p">}:{</span><span class="n">fallback</span> <span class="n">config</span><span class="o">/</span><span class="n">current</span> <span class="n">config</span><span class="p">}:{</span><span class="n">allowed</span> <span class="n">by</span> <span class="n">whitelist</span><span class="o">/</span><span class="n">otherwise</span><span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{FSA}:{allowed/disallowed}:{include/exclude postal}:{fallback config/current config}:{allowed by whitelist/otherwise}
</pre></div>
</div>
<ul class="simple">
@@ -261,11 +258,11 @@
<li>{allowed by whitelist/otherwise}: If a request is allowed by whitelist, this flag is set to 1; for all other cases, it is 0.</li>
</ul>
<p>Example:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="mf">1446442214.685</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">129.100</span><span class="o">.</span><span class="mf">254.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">GEO</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span
class="o">=</span><span class="s2">"N6G:1:X:0:0"</span> <span class="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">live5</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
+<div class="highlight-python"><div class="highlight"><pre>1446442214.685 qtype=HTTP chi=129.100.254.79 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="-" rdtl=- rerr="-" rgb="N6G:1:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/live5.m3u8 rh="-"
-<span class="mf">1446442219.181</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">184.68</span><span class="o">.</span><span class="mf">71.9</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live5.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGALT</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"-:0:X:0:0"</span> <span cl
ass="n">pssc</span><span class="o">=</span><span class="mi">302</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">cent6</span><span class="o">-</span><span class="mf">44.</span><span class="n">geo2</span><span class="o">.</span><span class="n">cdn</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">low_bitrate</span><span class="o">.</span><span class="n">m3u8</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
+1446442219.181 qtype=HTTP chi=184.68.71.9 url="http://ccr.geo2.cdn.com/live5.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGALT rloc="-" rdtl=- rerr="-" rgb="-:0:X:0:0" pssc=302 ttms=3 rurl=http://cent6-44.geo2.cdn.com/low_bitrate.m3u8 rh="-"
-<span class="mf">1446445521.677</span> <span class="n">qtype</span><span class="o">=</span><span class="n">HTTP</span> <span class="n">chi</span><span class="o">=</span><span class="mf">24.114</span><span class="o">.</span><span class="mf">29.79</span> <span class="n">url</span><span class="o">=</span><span class="s2">"http://ccr.geo2.cdn.com/live51.m3u8"</span> <span class="n">cqhm</span><span class="o">=</span><span class="n">GET</span> <span class="n">cqhv</span><span class="o">=</span><span class="n">HTTP</span><span class="o">/</span><span class="mf">1.1</span> <span class="n">rtype</span><span class="o">=</span><span class="n">RGDENY</span> <span class="n">rloc</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rdtl</span><span class="o">=-</span> <span class="n">rerr</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rgb</span><span class="o">=</span><span class="s2">"L4S:0:-:0:0"</span> <sp
an class="n">pssc</span><span class="o">=</span><span class="mi">520</span> <span class="n">ttms</span><span class="o">=</span><span class="mi">3</span> <span class="n">rurl</span><span class="o">=</span><span class="s2">"-"</span> <span class="n">rh</span><span class="o">=</span><span class="s2">"-"</span>
+1446445521.677 qtype=HTTP chi=24.114.29.79 url="http://ccr.geo2.cdn.com/live51.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=RGDENY rloc="-" rdtl=- rerr="-" rgb="L4S:0:-:0:0" pssc=520 ttms=3 rurl="-" rh="-"
</pre></div>
</div>
</div>
@@ -308,7 +305,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/quick_howto/steering.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/quick_howto/steering.html b/docs/latest/admin/quick_howto/steering.html
index 7b694ce..ac51eac 100644
--- a/docs/latest/admin/quick_howto/steering.html
+++ b/docs/latest/admin/quick_howto/steering.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configure Delivery Service Steering — Traffic Control 1.8.1 documentation </title>
+ <title>Configure Delivery Service Steering — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../genindex.html"/>
- <link rel="search" title="Search" href="../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../index.html"/>
<link rel="up" title="Quick How To Guides" href="index.html"/>
<link rel="next" title="Developer’s Guide" href="../../development/index.html"/>
<link rel="prev" title="Configure Regional Geo-blocking (RGB)" href="regionalgeo.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../index.html">Administrator’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Configure Delivery Service Steering</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../_sources/admin/quick_howto/steering.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../_sources/admin/quick_howto/steering.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -194,19 +191,19 @@
<ol class="arabic simple">
<li>Create two target delivery services in Traffic Ops. They must both be HTTP delivery services that are part of the same CDN.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering01.png"><img alt="../../_images/steering01.png" class="align-center" src="../../_images/steering01.png" style="width: 1172.0px; height: 232.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/steering01.png"><img alt="../../_images/steering01.png" class="align-center" src="../../_images/steering01.png" /></a>
<ol class="arabic simple" start="2">
<li>Create a delivery service with type STEERING in Traffic Ops.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering02.png"><img alt="../../_images/steering02.png" class="align-center" src="../../_images/steering02.png" style="width: 811.0px; height: 617.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/steering02.png"><img alt="../../_images/steering02.png" class="align-center" src="../../_images/steering02.png" /></a>
<ol class="arabic simple" start="3">
<li>Click the ‘Manage Steering Assignments’ button on the delivery service screen to assign targets.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering03.png"><img alt="../../_images/steering03.png" class="align-center" src="../../_images/steering03.png" style="width: 757.0px; height: 598.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/steering03.png"><img alt="../../_images/steering03.png" class="align-center" src="../../_images/steering03.png" /></a>
<ol class="arabic simple" start="4">
<li>Create a user with the role of Steering.</li>
</ol>
-<a class="reference internal image-reference" href="../../_images/steering04.png"><img alt="../../_images/steering04.png" class="align-center" src="../../_images/steering04.png" style="width: 650.0px; height: 487.0px;" /></a>
+<a class="reference internal image-reference" href="../../_images/steering04.png"><img alt="../../_images/steering04.png" class="align-center" src="../../_images/steering04.png" /></a>
<ol class="arabic" start="5">
<li><p class="first">As the steering user, assign weights to target delivery services. This will require logging in to Traffic Ops first via <code class="docutils literal"><span class="pre">http://to.kabletown.net/api/1.2/user/login</span></code> and storing the mojolicious cookie.</p>
<blockquote>
@@ -215,15 +212,15 @@
</div></blockquote>
</li>
</ol>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"targets"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"targets"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"1000"</span><span class="p">,</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
+ <span class="s">"weight"</span><span class="p">:</span> <span class="s">"1000"</span><span class="p">,</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-2"</span>
+ <span class="s">"weight"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-2"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -237,21 +234,21 @@
</div></blockquote>
</li>
</ol>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"filters"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"filters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">gototarget1</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
+ <span class="s">"pattern"</span><span class="p">:</span> <span class="s">".*</span><span class="se">\\</span><span class="s">gototarget1</span><span class="se">\\</span><span class="s">..*"</span><span class="p">,</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-1"</span>
<span class="p">}</span>
<span class="p">],</span>
- <span class="s2">"targets"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"targets"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"1000"</span><span class="p">,</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-1"</span>
+ <span class="s">"weight"</span><span class="p">:</span> <span class="s">"1000"</span><span class="p">,</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-1"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"weight"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
- <span class="s2">"deliveryService"</span><span class="p">:</span> <span class="s2">"target-deliveryservice-2"</span>
+ <span class="s">"weight"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
+ <span class="s">"deliveryService"</span><span class="p">:</span> <span class="s">"target-deliveryservice-2"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -300,7 +297,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_monitor.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_monitor.html b/docs/latest/admin/traffic_monitor.html
index 996a524..1ff0ce8 100644
--- a/docs/latest/admin/traffic_monitor.html
+++ b/docs/latest/admin/traffic_monitor.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Traffic Monitor Administration — Traffic Control 1.8.1 documentation </title>
+ <title>Traffic Monitor Administration — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Router Administration" href="traffic_router.html"/>
<link rel="prev" title="Traffic Portal Administration" href="traffic_portal.html"/>
@@ -110,7 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Traffic Monitor Administration</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_stats.html">Traffic Stats Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_server.html">Traffic Server Administration</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Traffic Monitor Administration</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_monitor.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_monitor.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -213,7 +210,7 @@
<li><p class="first">Take the config from Traffic Ops - run : <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">/opt/traffic_monitor/bin/traffic_monitor_config.pl</span></code></p>
<blockquote>
<div><p>Sample output:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
+<div class="highlight-python"><div class="highlight"><pre>traffic_mon # /opt/traffic_monitor/bin/traffic_monitor_config.pl https://traffic-ops.cdn.kabletown.net admin:password prompt
DEBUG: traffic_ops selected: https://traffic-ops.cdn.kabletown.net
DEBUG: traffic_ops login: admin:kl0tevax
DEBUG: Config write mode: prompt
@@ -296,13 +293,13 @@ traffic_mon #
</div></blockquote>
</li>
<li><p class="first">Start Tomcat: <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">service</span> <span class="pre">tomcat</span> <span class="pre">start</span></code></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Using</span> <span class="n">CATALINA_BASE</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
-<span class="n">Using</span> <span class="n">CATALINA_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span>
-<span class="n">Using</span> <span class="n">CATALINA_TMPDIR</span><span class="p">:</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">temp</span>
-<span class="n">Using</span> <span class="n">JRE_HOME</span><span class="p">:</span> <span class="o">/</span><span class="n">usr</span>
-<span class="n">Using</span> <span class="n">CLASSPATH</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">bootstrap</span><span class="o">.</span><span class="n">jar</span>
-<span class="n">Using</span> <span class="n">CATALINA_PID</span><span class="p">:</span><span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">run</span><span class="o">/</span><span class="n">tomcat</span><span class="o">/</span><span class="n">tomcat</span><span class="o">.</span><span class="n">pid</span>
-<span class="n">Starting</span> <span class="n">tomcat</span> <span class="p">[</span> <span class="n">OK</span> <span class="p">]</span>
+<div class="highlight-python"><div class="highlight"><pre>Using CATALINA_BASE: /opt/tomcat
+Using CATALINA_HOME: /opt/tomcat
+Using CATALINA_TMPDIR: /opt/tomcat/temp
+Using JRE_HOME: /usr
+Using CLASSPATH:/opt/tomcat/bin/bootstrap.jar
+Using CATALINA_PID:/var/run/tomcat/tomcat.pid
+Starting tomcat [ OK ]
</pre></div>
</div>
</li>
@@ -361,7 +358,7 @@ traffic_mon #
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_ops_config.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_ops_config.html b/docs/latest/admin/traffic_ops_config.html
index e30af0c..2dc59a8 100644
--- a/docs/latest/admin/traffic_ops_config.html
+++ b/docs/latest/admin/traffic_ops_config.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Configuring Traffic Ops — Traffic Control 1.8.1 documentation </title>
+ <title>Configuring Traffic Ops — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Using Traffic Ops" href="traffic_ops_using.html"/>
<link rel="prev" title="Installing Traffic Ops" href="traffic_ops_install.html"/>
@@ -106,7 +103,7 @@
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Configuring Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Configuring Traffic Ops</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_ops_config.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_ops_config.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -318,7 +315,7 @@ The Traffic Monitor IP addresses have to be included in this, if they are using
</tr>
<tr class="row-even"><td>purge_allow_ip</td>
<td>ip_allow.config</td>
-<td>The IP address range that is allowed to execute the PURGE method on the caches (not related to <a class="reference internal" href="traffic_ops_using.html#rl-purge"><span class="std std-ref">Invalidate Content</span></a>)</td>
+<td>The IP address range that is allowed to execute the PURGE method on the caches (not related to <a class="reference internal" href="traffic_ops_using.html#rl-purge"><em>Invalidate Content</em></a>)</td>
</tr>
<tr class="row-odd"><td>health.threshold.loadavg</td>
<td>rascal.properties</td>
@@ -341,7 +338,7 @@ For example: “”>1500000” means stop sending new traffic to
</div>
<div class="section" id="configuring-content-purge">
<h2>Configuring Content Purge<a class="headerlink" href="#configuring-content-purge" title="Permalink to this headline">¶</a></h2>
-<p>Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html">Regex Revalidate Plugin</a> to purge content from the system. We don’t actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it’s config file, and will pick up changes to it without a <cite>traffic_line -x</cite> signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the low
er tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see <a class="reference internal" href="traffic_server.html#reference-traffic-ops-ort"><span class="std std-ref">Configuring Traffic Server</span></a>) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the <cite>regex_revalidate.config</cite> file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the <cite>regex_revalidate.config</cite> file.</p>
+<p>Content purge using ATS is not simple; there is no file system to delete files/directories from, and in large caches it can be hard to delete a simple regular expression from the cache. This is why Traffic Control uses the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_revalidate.en.html">Regex Revalidate Plugin</a> to purge content from the system. We don’t actually remove the content, we have a check that gets run before each request on each cache to see if this request matches a list of regular expressions, and if it does, we force a revalidation to the origin, making the original content inaccessible. The regex_revalidate plugin will monitor it’s config file, and will pick up changes to it without a <cite>traffic_line -x</cite> signal to ATS. Changes to this file need to be distributed to the highest tier (MID) caches in the CDN before they are distributed to the lower tiers, to prevent filling the low
er tiers with the content that should be purged from the higher tiers without hitting the origin. This is why the ort script (see <a class="reference internal" href="traffic_server.html#reference-traffic-ops-ort"><em>Configuring Traffic Server</em></a>) will by default push out config changes to MID first, confirm that they have all been updated, and then push out the changes to the lower tiers. In large CDNs, this can make the distribution and time to activation of the purge too long, and because of that there is the option to not distribute the <cite>regex_revalidate.config</cite> file using the ort script, but to do this using other means. By default, Traffic Ops will use ort to distribute the <cite>regex_revalidate.config</cite> file.</p>
<p>Content Purge is controlled by the following parameters in the profile of the cache:</p>
<table border="1" class="docutils">
<colgroup>
@@ -388,13 +385,13 @@ For example: –config regex_revalidate.config</td>
<li>Start the kickstart installation.</li>
</ol>
<p>Create a ks.src file in the root of the selection location. See the example below:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">mkdir</span> <span class="n">newdir</span>
-<span class="n">cd</span> <span class="n">newdir</span><span class="o">/</span>
-<span class="n">cp</span> <span class="o">-</span><span class="n">r</span> <span class="o">../</span><span class="n">centos65</span><span class="o">/*</span> <span class="o">.</span>
-<span class="n">vim</span> <span class="n">ks</span><span class="o">.</span><span class="n">src</span>
-<span class="n">vim</span> <span class="n">isolinux</span><span class="o">/</span><span class="n">isolinux</span><span class="o">.</span><span class="n">cfg</span>
-<span class="n">cd</span> <span class="n">vim</span> <span class="n">osversions</span><span class="o">.</span><span class="n">cfg</span>
-<span class="n">vim</span> <span class="n">osversions</span><span class="o">.</span><span class="n">cfg</span>
+<div class="highlight-python"><div class="highlight"><pre>mkdir newdir
+cd newdir/
+cp -r ../centos65/* .
+vim ks.src
+vim isolinux/isolinux.cfg
+cd vim osversions.cfg
+vim osversions.cfg
</pre></div>
</div>
<p>This is a standard kickstart formatted file that the generate ISO process uses to create the kickstart (ks.cfg) file for the install. The generate ISO process uses the ks.src, overwriting any information set in the Generate ISO tab in Traffic Ops, creating ks.cfg.</p>
@@ -448,7 +445,7 @@ For example: –config regex_revalidate.config</td>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[39/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.rst.txt
deleted file mode 100644
index 373c7ec..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/deliveryservice.rst.txt
+++ /dev/null
@@ -1,1276 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v11-ds:
-
-Delivery Service
-================
-
-.. _to-api-v11-ds-route:
-
-/api/1.1/deliveryservices
-+++++++++++++++++++++++++
-
-**GET /api/1.1/deliveryservices**
-
- Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+======================================================================================================================================+
- | ``active`` | bool | true if active, false if inactive. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``displayName`` | string | The display name of the delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectUrl`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | string | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from USA |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitCountries`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The deliveryservice id (database row number). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``initialDispersion`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``logsEnabled`` | bool | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``originShield`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "active": true,
- "cacheurl": null,
- "ccrDnsTtl": "3600",
- "cdnId": "2",
- "cdnName": "over-the-top",
- "checkPath": "",
- "displayName": "My Cool Delivery Service",
- "dnsBypassCname": "",
- "dnsBypassIp": "",
- "dnsBypassIp6": "",
- "dnsBypassTtl": "30",
- "dscp": "40",
- "edgeHeaderRewrite": null,
- "exampleURLs": [
- "http://edge.foo-ds.foo.bar.net"
- ],
- "geoLimit": "0",
- "geoLimitCountries": null,
- "geoLimitRedirectURL": null,
- "geoProvider": "0",
- "globalMaxMbps": null,
- "globalMaxTps": "0",
- "httpBypassFqdn": "",
- "id": "442",
- "infoUrl": "",
- "initialDispersion": "1",
- "ipv6RoutingEnabled": true,
- "lastUpdated": "2016-01-26 08:49:35",
- "logsEnabled": false,
- "longDesc": "",
- "longDesc1": "",
- "longDesc2": "",
- "matchList": [
- {
- "pattern": ".*\\.foo-ds\\..*",
- "setNumber": "0",
- "type": "HOST_REGEXP"
- }
- ],
- "maxDnsAnswers": "0",
- "midHeaderRewrite": null,
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "multiSiteOrigin": false,
- "multiSiteOriginAlgorithm": null,
- "orgServerFqdn": "http://baz.boo.net",
- "originShield": null,
- "profileDescription": "Content Router for over-the-top",
- "profileId": "5",
- "profileName": "ROUTER_TOP",
- "protocol": "0",
- "qstringIgnore": "1",
- "rangeRequestHandling": "0",
- "regexRemap": null,
- "regionalGeoBlocking": false,
- "remapText": null,
- "signed": false,
- "sslKeyVersion": "0",
- "trRequestHeaders": null,
- "trResponseHeaders": "Access-Control-Allow-Origin: *",
- "type": "HTTP",
- "typeId": "8",
- "xmlId": "foo-ds"
- }
- { .. },
- { .. }
- ]
- }
-
-|
-
-
-**GET /api/1.1/deliveryservices/:id**
-
- Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+======================================================================================================================================+
- | ``active`` | bool | true if active, false if inactive. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``displayName`` | string | The display name of the delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectUrl`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | string | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from USA |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitCountries`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The deliveryservice id (database row number). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``initialDispersion`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``logsEnabled`` | bool | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``originShield`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "active": true,
- "cacheurl": null,
- "ccrDnsTtl": "3600",
- "cdnId": "2",
- "cdnName": "over-the-top",
- "checkPath": "",
- "displayName": "My Cool Delivery Service",
- "dnsBypassCname": "",
- "dnsBypassIp": "",
- "dnsBypassIp6": "",
- "dnsBypassTtl": "30",
- "dscp": "40",
- "edgeHeaderRewrite": null,
- "exampleURLs": [
- "http://edge.foo-ds.foo.bar.net"
- ],
- "geoLimit": "0",
- "geoLimitCountries": null,
- "geoLimitRedirectURL": null,
- "geoProvider": "0",
- "globalMaxMbps": null,
- "globalMaxTps": "0",
- "httpBypassFqdn": "",
- "id": "442",
- "infoUrl": "",
- "initialDispersion": "1",
- "ipv6RoutingEnabled": true,
- "lastUpdated": "2016-01-26 08:49:35",
- "logsEnabled": false,
- "longDesc": "",
- "longDesc1": "",
- "longDesc2": "",
- "matchList": [
- {
- "pattern": ".*\\.foo-ds\\..*",
- "setNumber": "0",
- "type": "HOST_REGEXP"
- }
- ],
- "maxDnsAnswers": "0",
- "midHeaderRewrite": null,
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "multiSiteOrigin": false,
- "multiSiteOriginAlgorithm": null,
- "orgServerFqdn": "http://baz.boo.net",
- "originShield": null,
- "profileDescription": "Content Router for over-the-top",
- "profileId": "5",
- "profileName": "ROUTER_TOP",
- "protocol": "0",
- "qstringIgnore": "1",
- "rangeRequestHandling": "0",
- "regexRemap": null,
- "regionalGeoBlocking": false,
- "remapText": null,
- "signed": false,
- "sslKeyVersion": "0",
- "trRequestHeaders": null,
- "trResponseHeaders": "Access-Control-Allow-Origin: *",
- "type": "HTTP",
- "typeId": "8",
- "xmlId": "foo-ds"
- }
- ]
- }
-
-|
-
-
-.. _to-api-v11-ds-health:
-
-Health
-++++++
-
-**GET /api/1.1/deliveryservices/:id/state.json**
-
- Retrieves the failover state for a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+---------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+=================================================+
- | ``failover`` | hash | |
- +------------------+---------+-------------------------------------------------+
- | ``>locations`` | array | |
- +------------------+---------+-------------------------------------------------+
- | ``>destination`` | string | |
- +------------------+---------+-------------------------------------------------+
- | ``>configured`` | boolean | |
- +------------------+---------+-------------------------------------------------+
- | ``>enabled`` | boolean | |
- +------------------+---------+-------------------------------------------------+
- | ``enabled`` | boolean | |
- +------------------+---------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "failover": {
- "locations": [ ],
- "destination": null,
- "configured": false,
- "enabled": false
- },
- "enabled": true
- }
- }
-
-|
-
-**GET /api/1.1/deliveryservices/:id/health.json**
-
- Retrieves the health of all locations (cache groups) for a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``totalOnline`` | int | Total number of online caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``cachegroups`` | array | A collection of cache groups. |
- +------------------+--------+-------------------------------------------------+
- | ``>online`` | int | The number of online caches for the cache group |
- +------------------+--------+-------------------------------------------------+
- | ``>offline`` | int | The number of offline caches for the cache |
- | | | group. |
- +------------------+--------+-------------------------------------------------+
- | ``>name`` | string | Cache group name. |
- +------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "totalOnline": 148,
- "totalOffline": 0,
- "cachegroups": [
- {
- "online": 8,
- "offline": 0,
- "name": "us-co-denver"
- },
- {
- "online": 7,
- "offline": 0,
- "name": "us-de-newcastle"
- }
- ]
- }
- }
-
-
-|
-
-**GET /api/1.1/deliveryservices/:id/capacity.json**
-
- Retrieves the capacity percentages of a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- |id | yes | delivery service id. |
- +-----------------+----------+---------------------------------------------------+
-
- **Response Properties**
-
- +------------------------+--------+---------------------------------------------------+
- | Parameter | Type | Description |
- +========================+========+===================================================+
- | ``availablePercent`` | number | The percentage of server capacity assigned to |
- | | | the delivery service that is available. |
- +------------------------+--------+---------------------------------------------------+
- | ``unavailablePercent`` | number | The percentage of server capacity assigned to the |
- | | | delivery service that is unavailable. |
- +------------------------+--------+---------------------------------------------------+
- | ``utilizedPercent`` | number | The percentage of server capacity assigned to the |
- | | | delivery service being used. |
- +------------------------+--------+---------------------------------------------------+
- | ``maintenancePercent`` | number | The percentage of server capacity assigned to the |
- | | | delivery service that is down for maintenance. |
- +------------------------+--------+---------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "availablePercent": 89.0939840205533,
- "unavailablePercent": 0,
- "utilizedPercent": 10.9060020300395,
- "maintenancePercent": 0.0000139494071146245
- },
- }
-
-
-|
-
-**GET /api/1.1/deliveryservices/:id/routing.json**
-
- Retrieves the routing method percentages of a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- |id | yes | delivery service id. |
- +-----------------+----------+---------------------------------------------------+
-
- **Response Properties**
-
- +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+=============================================================================================================================+
- | ``staticRoute`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries. |
- +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``miss`` | number | The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP). |
- +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``geo`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping. |
- +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``err`` | number | The percentage of Traffic Router requests for this deliveryservice resulting in an error. |
- +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``cz`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF hit. |
- +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``dsr`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the |
- | | | client to the overflow CDN. |
- +-----------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "staticRoute": 0,
- "miss": 0,
- "geo": 37.8855391018869,
- "err": 0,
- "cz": 62.1144608981131,
- "dsr": 0
- },
- }
-
-|
-
-.. _to-api-v11-ds-metrics:
-
-Metrics
-+++++++
-
-**GET /api/1.1/deliveryservices/:id/server_types/:type/metric_types/start_date/:start/end_date/:end.json**
-
- Retrieves detailed and summary metrics for MIDs or EDGEs for a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-----------------------------------------------------------------------------+
- | Name | Required | Description |
- +==================+==========+=============================================================================+
- | ``id`` | yes | The delivery service id. |
- +------------------+----------+-----------------------------------------------------------------------------+
- | ``server_types`` | yes | EDGE or MID. |
- +------------------+----------+-----------------------------------------------------------------------------+
- | ``metric_types`` | yes | One of the following: "kbps", "tps", "tps_2xx", "tps_3xx", "tps_4xx", |
- | | | "tps_5xx". |
- +------------------+----------+-----------------------------------------------------------------------------+
- | ``start_date`` | yes | UNIX time |
- +------------------+----------+-----------------------------------------------------------------------------+
- | ``end_date`` | yes | UNIX time |
- +------------------+----------+-----------------------------------------------------------------------------+
-
- **Request Query Parameters**
-
- +------------------+----------+-----------------------------------------------------------------------------+
- | Name | Required | Description |
- +==================+==========+=============================================================================+
- | ``stats`` | no | Flag used to return only summary metrics |
- +------------------+----------+-----------------------------------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+-------------+
- | Parameter | Type | Description |
- +======================+========+=============+
- | ``stats`` | hash | |
- +----------------------+--------+-------------+
- | ``>>count`` | int | |
- +----------------------+--------+-------------+
- | ``>>98thPercentile`` | number | |
- +----------------------+--------+-------------+
- | ``>>min`` | number | |
- +----------------------+--------+-------------+
- | ``>>max`` | number | |
- +----------------------+--------+-------------+
- | ``>>5thPercentile`` | number | |
- +----------------------+--------+-------------+
- | ``>>95thPercentile`` | number | |
- +----------------------+--------+-------------+
- | ``>>median`` | number | |
- +----------------------+--------+-------------+
- | ``>>mean`` | number | |
- +----------------------+--------+-------------+
- | ``>>stddev`` | number | |
- +----------------------+--------+-------------+
- | ``>>sum`` | number | |
- +----------------------+--------+-------------+
- | ``data`` | array | |
- +----------------------+--------+-------------+
- | ``>>item`` | array | |
- +----------------------+--------+-------------+
- | ``>>time`` | number | |
- +----------------------+--------+-------------+
- | ``>>value`` | number | |
- +----------------------+--------+-------------+
- | ``label`` | string | |
- +----------------------+--------+-------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "stats": {
- "count": 988,
- "98thPercentile": 16589105.55958,
- "min": 3185442.975,
- "max": 17124754.257,
- "5thPercentile": 3901253.95445,
- "95thPercentile": 16013210.034,
- "median": 8816895.576,
- "mean": 8995846.31741194,
- "stddev": 3941169.83683573,
- "sum": 333296106.060112
- },
- "data": [
- [
- 1414303200000,
- 12923518.466
- ],
- [
- 1414303500000,
- 12625139.65
- ]
- ],
- "label": "MID Kbps"
- }
- ],
- }
-
-
-.. _to-api-v11-ds-server:
-
-Server
-++++++
-
-**GET /api/1.1/deliveryserviceserver.json**
-
- Authentication Required: Yes
-
- Role(s) Required: Yes
-
- **Request Query Parameters**
-
- +-----------+----------+----------------------------------------+
- | Name | Required | Description |
- +===========+==========+========================================+
- | ``page`` | no | The page number for use in pagination. |
- +-----------+----------+----------------------------------------+
- | ``limit`` | no | For use in limiting the result set. |
- +-----------+----------+----------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``lastUpdated`` | array | |
- +----------------------+--------+------------------------------------------------+
- |``server`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``deliveryService`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "page": 2,
- "orderby": "deliveryservice",
- "response": [
- {
- "lastUpdated": "2014-09-26 17:53:43",
- "server": "20",
- "deliveryService": "1"
- },
- {
- "lastUpdated": "2014-09-26 17:53:44",
- "server": "21",
- "deliveryService": "1"
- },
- ],
- "limit": 2
- }
-
-|
-
-.. _to-api-v11-ds-sslkeys:
-
-SSL Keys
-+++++++++
-
-**GET /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys.json**
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Route Parameters**
-
- +-----------+----------+----------------------------------------+
- | Name | Required | Description |
- +===========+==========+========================================+
- | ``xmlId`` | yes | xml_id of the desired delivery service |
- +-----------+----------+----------------------------------------+
-
- **Request Query Parameters**
-
- +-------------+----------+--------------------------------+
- | Name | Required | Description |
- +=============+==========+================================+
- | ``version`` | no | The version number to retrieve |
- +-------------+----------+--------------------------------+
-
- **Response Properties**
-
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================================================================================+
- | ``crt`` | string | base64 encoded crt file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``csr`` | string | base64 encoded csr file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``key`` | string | base64 encoded private key file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``version`` | string | The version of the certificate record in Riak |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "certificate": {
- "crt": "crt",
- "key": "key",
- "csr": "csr"
- },
- "businessUnit": "CDN_Eng",
- "city": "Denver",
- "organization": "KableTown",
- "hostname": "foober.com",
- "country": "US",
- "state": "Colorado",
- "version": "1"
- }
- }
-
-|
-
-**GET /api/1.1/deliveryservices/hostname/:hostname/sslkeys.json**
-
- Authentication Required: Yes
-
- Role Required: Admin
-
- **Request Route Parameters**
-
- +--------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +==============+==========+===================================================+
- | ``hostname`` | yes | pristine hostname of the desired delivery service |
- +--------------+----------+---------------------------------------------------+
-
- **Request Query Parameters**
-
- +-------------+----------+--------------------------------+
- | Name | Required | Description |
- +=============+==========+================================+
- | ``version`` | no | The version number to retrieve |
- +-------------+----------+--------------------------------+
-
- **Response Properties**
-
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================================================================================+
- | ``crt`` | string | base64 encoded crt file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``csr`` | string | base64 encoded csr file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``key`` | string | base64 encoded private key file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``version`` | string | The version of the certificate record in Riak |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "certificate": {
- "crt": "crt",
- "key": "key",
- "csr": "csr"
- },
- "businessUnit": "CDN_Eng",
- "city": "Denver",
- "organization": "KableTown",
- "hostname": "foober.com",
- "country": "US",
- "state": "Colorado",
- "version": "1"
- }
- }
-
-|
-
-**GET /api/1.1/deliveryservices/xmlId/:xmlid/sslkeys/delete.json**
-
- Authentication Required: Yes
-
- Role Required: Admin
-
- **Request Route Parameters**
-
- +-----------+----------+----------------------------------------+
- | Name | Required | Description |
- +===========+==========+========================================+
- | ``xmlId`` | yes | xml_id of the desired delivery service |
- +-----------+----------+----------------------------------------+
-
- **Request Query Parameters**
-
- +-------------+----------+--------------------------------+
- | Name | Required | Description |
- +=============+==========+================================+
- | ``version`` | no | The version number to retrieve |
- +-------------+----------+--------------------------------+
-
- **Response Properties**
-
- +--------------+--------+------------------+
- | Parameter | Type | Description |
- +==============+========+==================+
- | ``response`` | string | success response |
- +--------------+--------+------------------+
-
- **Response Example** ::
-
- {
- "response": "Successfully deleted ssl keys for <xml_id>"
- }
-
-|
-
-**POST /api/1.1/deliveryservices/sslkeys/generate**
-
- Generates SSL crt, csr, and private key for a delivery service
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Properties**
-
- +--------------+---------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==============+=========+=================================================+
- | ``key`` | string | xml_id of the delivery service |
- +--------------+---------+-------------------------------------------------+
- | ``version`` | string | version of the keys being generated |
- +--------------+---------+-------------------------------------------------+
- | ``hostname`` | string | the *pristine hostname* of the delivery service |
- +--------------+---------+-------------------------------------------------+
- | ``country`` | string | |
- +--------------+---------+-------------------------------------------------+
- | ``state`` | string | |
- +--------------+---------+-------------------------------------------------+
- | ``city`` | string | |
- +--------------+---------+-------------------------------------------------+
- | ``org`` | string | |
- +--------------+---------+-------------------------------------------------+
- | ``unit`` | boolean | |
- +--------------+---------+-------------------------------------------------+
-
- **Request Example** ::
-
- {
- "key": "ds-01",
- "businessUnit": "CDN Engineering",
- "version": "3",
- "hostname": "tr.ds-01.ott.kabletown.com",
- "certificate": {
- "key": "some_key",
- "csr": "some_csr",
- "crt": "some_crt"
- },
- "country": "US",
- "organization": "Kabletown",
- "city": "Denver",
- "state": "Colorado"
- }
-
-|
-
- **Response Properties**
-
- +--------------+--------+-----------------+
- | Parameter | Type | Description |
- +==============+========+=================+
- | ``response`` | string | response string |
- +--------------+--------+-----------------+
- | ``version`` | string | API version |
- +--------------+--------+-----------------+
-
- **Response Example** ::
-
- {
- "response": "Successfully created ssl keys for ds-01"
- }
-
-|
-
-**POST /api/1.1/deliveryservices/sslkeys/add**
-
- Allows user to add SSL crt, csr, and private key for a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Properties**
-
- +-------------+--------+-------------------------------------+
- | Parameter | Type | Description |
- +=============+========+=====================================+
- | ``key`` | string | xml_id of the delivery service |
- +-------------+--------+-------------------------------------+
- | ``version`` | string | version of the keys being generated |
- +-------------+--------+-------------------------------------+
- | ``csr`` | string | |
- +-------------+--------+-------------------------------------+
- | ``crt`` | string | |
- +-------------+--------+-------------------------------------+
- | ``key`` | string | |
- +-------------+--------+-------------------------------------+
-
- **Request Example** ::
-
- {
- "key": "ds-01",
- "version": "1",
- "certificate": {
- "key": "some_key",
- "csr": "some_csr",
- "crt": "some_crt"
- }
- }
-
-|
-
- **Response Properties**
-
- +--------------+--------+-----------------+
- | Parameter | Type | Description |
- +==============+========+=================+
- | ``response`` | string | response string |
- +--------------+--------+-----------------+
- | ``version`` | string | API version |
- +--------------+--------+-----------------+
-
- **Response Example** ::
-
- {
- "response": "Successfully added ssl keys for ds-01"
- }
-
-
-|
-
-**POST /api/1.1/deliveryservices/request**
-
- Allows a user to send delivery service request details to a specified email address.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | Parameter | Type | Required | Description |
- +========================================+========+==========+=============================================================================================+
- | ``emailTo`` | string | yes | The email to which the delivery service request will be sent. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``details`` | hash | yes | Parameters for the delivery service request. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>customer`` | string | yes | Name of the customer to associated with the delivery service. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>deliveryProtocol`` | string | yes | Eg. http or http/https
<TRUNCATED>
[10/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/asn.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/asn.html b/docs/latest/development/traffic_ops_api/v11/asn.html
index a75a01d..9f0dd91 100644
--- a/docs/latest/development/traffic_ops_api/v11/asn.html
+++ b/docs/latest/development/traffic_ops_api/v11/asn.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>ASN — Traffic Control 1.8.1 documentation </title>
+ <title>ASN — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Cache Group" href="cachegroup.html"/>
<link rel="prev" title="API Routes" href="../routes.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>ASN</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/asn.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/asn.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -234,20 +231,20 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"asns"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"asns"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
- <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
+ <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7015"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
- <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span>
+ <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7016"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -296,7 +293,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/cachegroup.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/cachegroup.html b/docs/latest/development/traffic_ops_api/v11/cachegroup.html
index 214ce94..f0bd719 100644
--- a/docs/latest/development/traffic_ops_api/v11/cachegroup.html
+++ b/docs/latest/development/traffic_ops_api/v11/cachegroup.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Cache Group — Traffic Control 1.8.1 documentation </title>
+ <title>Cache Group — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="CDN" href="cdn.html"/>
<link rel="prev" title="ASN" href="asn.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Cache Group</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/cachegroup.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/cachegroup.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -262,35 +259,35 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
- <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
- <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
+ <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span><span class="p">,</span>
+ <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago-1"</span><span class="p">,</span>
- <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
- <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago-1"</span><span class="p">,</span>
+ <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span><span class="p">,</span>
+ <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -325,16 +322,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span>
- <span class="p">}</span>
- <span class="p">],</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre> {
+ "response": [
+ {
+ "name": "dc-chicago"
+ },
+ {
+ "name": "dc-cmc"
+ }
+ ],
+}
</pre></div>
</div>
</div></blockquote>
@@ -410,21 +407,21 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-25 20:27:28"</span><span class="p">,</span>
- <span class="s2">"latitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"longitude"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
- <span class="s2">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"shortName"</span><span class="p">:</span> <span class="s2">"dcchi"</span><span class="p">,</span>
- <span class="s2">"typeName"</span><span class="p">:</span> <span class="s2">"MID_LOC"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"4"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-25 20:27:28"</span><span class="p">,</span>
+ <span class="s">"latitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"longitude"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
+ <span class="s">"parentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"parentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupId"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"secondaryParentCachegroupName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"shortName"</span><span class="p">:</span> <span class="s">"dcchi"</span><span class="p">,</span>
+ <span class="s">"typeName"</span><span class="p">:</span> <span class="s">"MID_LOC"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"4"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -487,16 +484,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -541,23 +538,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"cachegroupParameters"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
+ <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"380"</span><span class="p">,</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ca-sanjose"</span>
+ <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"380"</span><span class="p">,</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ca-sanjose"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"parameter"</span><span class="p">:</span> <span class="s2">"379"</span><span class="p">,</span>
- <span class="s2">"last_updated"</span><span class="p">:</span> <span class="s2">"2013-08-05 18:49:37"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span>
+ <span class="s">"parameter"</span><span class="p">:</span> <span class="s">"379"</span><span class="p">,</span>
+ <span class="s">"last_updated"</span><span class="p">:</span> <span class="s">"2013-08-05 18:49:37"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -617,15 +614,15 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-chicago"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"21"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-chicago"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"21"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"dc-cmc"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"dc-cmc"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -673,7 +670,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/cdn.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/cdn.html b/docs/latest/development/traffic_ops_api/v11/cdn.html
index 084f079..915222a 100644
--- a/docs/latest/development/traffic_ops_api/v11/cdn.html
+++ b/docs/latest/development/traffic_ops_api/v11/cdn.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>CDN — Traffic Control 1.8.1 documentation </title>
+ <title>CDN — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Change Logs" href="changelog.html"/>
<link rel="prev" title="Cache Group" href="cachegroup.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>CDN</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/cdn.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/cdn.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -230,22 +227,22 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "1"
+ "name": "over-the-top",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -309,16 +306,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -382,16 +379,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"cdn2"</span><span class="p">,</span>
- <span class="s2">"dnssecEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2014-10-02 08:22:43"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -448,20 +445,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -541,20 +538,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
- <span class="s2">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"totalOnline"</span><span class="p">:</span> <span class="mi">148</span><span class="p">,</span>
+ <span class="s">"totalOffline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cachegroups"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">8</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-co-denver"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
- <span class="s2">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"us-de-newcastle"</span>
+ <span class="s">"online"</span><span class="p">:</span> <span class="mi">7</span><span class="p">,</span>
+ <span class="s">"offline"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"us-de-newcastle"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">},</span>
@@ -599,11 +596,11 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
- <span class="s2">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
- <span class="s2">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"currentGbps"</span><span class="p">:</span> <span class="mf">149.368167</span><span class="p">,</span>
+ <span class="s">"tps"</span><span class="p">:</span> <span class="mi">36805</span><span class="p">,</span>
+ <span class="s">"maxGbps"</span><span class="p">:</span> <span class="mi">3961</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -647,12 +644,12 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
- <span class="s2">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
- <span class="s2">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"availablePercent"</span><span class="p">:</span> <span class="mf">89.0939840205533</span><span class="p">,</span>
+ <span class="s">"unavailablePercent"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"utilizedPercent"</span><span class="p">:</span> <span class="mf">10.9060020300395</span><span class="p">,</span>
+ <span class="s">"maintenancePercent"</span><span class="p">:</span> <span class="mf">0.0000139494071146245</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -710,14 +707,14 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
- <span class="s2">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
- <span class="s2">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"staticRoute"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"miss"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"geo"</span><span class="p">:</span> <span class="mf">37.8855391018869</span><span class="p">,</span>
+ <span class="s">"err"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
+ <span class="s">"cz"</span><span class="p">:</span> <span class="mf">62.1144608981131</span><span class="p">,</span>
+ <span class="s">"dsr"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -831,20 +828,20 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"stats"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
- <span class="s2">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
- <span class="s2">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
+ <span class="s">"stats"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"count"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span>
+ <span class="s">"98thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"min"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"max"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"5thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"95thPercentile"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"mean"</span><span class="p">:</span> <span class="mf">1668.03</span><span class="p">,</span>
+ <span class="s">"sum"</span><span class="p">:</span> <span class="mf">1668.03</span>
<span class="p">},</span>
- <span class="s2">"data"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"data"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">[</span>
<span class="mi">1425135900000</span><span class="p">,</span>
<span class="mf">1668.03</span>
@@ -854,7 +851,7 @@ group.</td>
<span class="n">null</span>
<span class="p">]</span>
<span class="p">],</span>
- <span class="s2">"label"</span><span class="p">:</span> <span class="s2">"Origin TPS"</span>
+ <span class="s">"label"</span><span class="p">:</span> <span class="s">"Origin TPS"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -908,21 +905,21 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
- <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"404"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_FOO"</span><span class="p">,</span>
- <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for foo.domain.net"</span><span class="p">,</span>
- <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"foo.domain.net"</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"5"</span><span class="p">,</span>
+ <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"404"</span><span class="p">,</span>
+ <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_FOO"</span><span class="p">,</span>
+ <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for foo.domain.net"</span><span class="p">,</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"foo.domain.net"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span>
- <span class="s2">"parameterId"</span><span class="p">:</span> <span class="s2">"405"</span><span class="p">,</span>
- <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"CR_BAR"</span><span class="p">,</span>
- <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for bar.domain.net"</span><span class="p">,</span>
- <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"bar.domain.net"</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"8"</span><span class="p">,</span>
+ <span class="s">"parameterId"</span><span class="p">:</span> <span class="s">"405"</span><span class="p">,</span>
+ <span class="s">"profileName"</span><span class="p">:</span> <span class="s">"CR_BAR"</span><span class="p">,</span>
+ <span class="s">"profileDescription"</span><span class="p">:</span> <span class="s">"Content Router for bar.domain.net"</span><span class="p">,</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"bar.domain.net"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -993,7 +990,7 @@ group.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
@@ -1255,7 +1252,7 @@ profiles.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">TBD</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span>
</pre></div>
</div>
</div></blockquote>
@@ -1757,46 +1754,46 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cdn1"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
- <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
- <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
- <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
- <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span>
- <span class="p">},</span>
- <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"foo.kabletown.com."</span><span class="p">,</span>
- <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
- <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
- <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
- <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span>
- <span class="p">}</span>
- <span class="p">},</span>
- <span class="s2">"ds-01"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"zsk"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
- <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span><span class="p">,</span>
- <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"zsk private key"</span><span class="p">,</span>
- <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"zsk public key"</span><span class="p">,</span>
- <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1428788750"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span>
- <span class="p">},</span>
- <span class="s2">"ksk"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ds-01.foo.kabletown.com."</span><span class="p">,</span>
- <span class="s2">"expirationDate"</span><span class="p">:</span> <span class="s2">"1457732750"</span><span class="p">,</span>
- <span class="s2">"public"</span><span class="p">:</span> <span class="s2">"ksk public key"</span><span class="p">,</span>
- <span class="s2">"private"</span><span class="p">:</span> <span class="s2">"ksk private key"</span><span class="p">,</span>
- <span class="s2">"inceptionDate"</span><span class="p">:</span> <span class="s2">"1426196750"</span>
- <span class="p">}</span>
- <span class="p">},</span>
- <span class="o">...</span> <span class="n">repeated</span> <span class="k">for</span> <span class="n">each</span> <span class="n">ds</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">cdn</span>
- <span class="p">},</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": {
+ "cdn1": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750",
+ "ttl": "60"
+ }
+ },
+ "ds-01": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "ds-01.foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "ds-01.foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750"
+ }
+ },
+ ... repeated for each ds in the cdn
+ },
+}
</pre></div>
</div>
</div></blockquote>
@@ -1849,8 +1846,8 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully deleted dnssec keys for <cdn>"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully deleted dnssec keys for <cdn>"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1900,13 +1897,13 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"key"</span><span class="p">:</span> <span class="s2">"cdn1"</span><span class="p">,</span>
- <span class="s2">"name"</span> <span class="s2">"ott.kabletown.com"</span><span class="p">,</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"60"</span><span class="p">,</span>
- <span class="s2">"kskExpirationDays"</span><span class="p">:</span> <span class="s2">"365"</span><span class="p">,</span>
- <span class="s2">"zskExpirationDays"</span><span class="p">:</span> <span class="s2">"90"</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "key": "cdn1",
+ "name" "ott.kabletown.com",
+ "ttl": "60",
+ "kskExpirationDays": "365",
+ "zskExpirationDays": "90"
+}
</pre></div>
</div>
<p><strong>Response Properties</strong></p>
@@ -1934,8 +1931,8 @@ Before returning response to user, make sure dnssec keys for all delivery servic
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="s2">"Successfully created dnssec keys for cdn1"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="s">"Successfully created dnssec keys for cdn1"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1981,7 +1978,7 @@ Before returning response to user, make sure dnssec keys for all delivery servic
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/changelog.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/changelog.html b/docs/latest/development/traffic_ops_api/v11/changelog.html
index 1feb7ce..da53066 100644
--- a/docs/latest/development/traffic_ops_api/v11/changelog.html
+++ b/docs/latest/development/traffic_ops_api/v11/changelog.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Change Logs — Traffic Control 1.8.1 documentation </title>
+ <title>Change Logs — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Delivery Service" href="deliveryservice.html"/>
<link rel="prev" title="CDN" href="cdn.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Change Logs</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/changelog.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/changelog.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -238,23 +235,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
- <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
+ <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
+ <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
- <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
+ <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
+ <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"</span>
<span class="p">},</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -329,23 +326,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"OPER"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-04 22:59:13"</span><span class="p">,</span>
- <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid852"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22661"</span><span class="p">,</span>
- <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Snapshot CRConfig created."</span>
+ <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"OPER"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-04 22:59:13"</span><span class="p">,</span>
+ <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid852"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22661"</span><span class="p">,</span>
+ <span class="s">"message"</span><span class="p">:</span> <span class="s">"Snapshot CRConfig created."</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"APICHANGE"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-02-03 17:04:20"</span><span class="p">,</span>
- <span class="s2">"user"</span><span class="p">:</span> <span class="s2">"userid853"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22658"</span><span class="p">,</span>
- <span class="s2">"message"</span><span class="p">:</span> <span class="s2">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
+ <span class="s">"ticketNum"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"APICHANGE"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-02-03 17:04:20"</span><span class="p">,</span>
+ <span class="s">"user"</span><span class="p">:</span> <span class="s">"userid853"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22658"</span><span class="p">,</span>
+ <span class="s">"message"</span><span class="p">:</span> <span class="s">"Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -380,9 +377,9 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"newLogcount"</span><span class="p">:</span> <span class="mi">0</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -429,7 +426,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[30/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
new file mode 100644
index 0000000..1819c69
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/cdn.txt
@@ -0,0 +1,1334 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-cdn:
+
+CDN
+===
+
+.. _to-api-v12-cdn-route:
+
+/api/1.2/cdns
++++++++++++++
+
+**GET /api/1.2/cdns**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "over-the-top",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": true,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cdns/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | CDN id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/cdns/name/:name**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``name`` | yes | CDN name. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``id`` | string | CDN id. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | bool | DNSSEC enabled. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "2"
+ "name": "cdn2",
+ "dnssecEnabled": false,
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/cdns**
+
+ Allows user to create a CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | int | Whether dnssec is enabled. |
+ | | | - 0: disabled |
+ | | | - 1: enabled |
+ +-------------------+--------+-------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "cdn_test",
+ "dnssecEnabled": 0
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the creation, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | CDN name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>id`` | int | CDN id. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "name": "cdn_test",
+ "id": 3
+ "dnssecEnabled": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was created."
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/cdns/{:id}**
+
+ Allows user to edit a CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | CDN id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``name`` | string | CDN name. |
+ +-------------------+--------+-------------------------------------------------+
+ | ``dnssecEnabled`` | int | Whether dnssec is enabled. |
+ | | | - 0: disabled |
+ | | | - 1: enabled |
+ +-------------------+--------+-------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "name": "cdn_test2",
+ "dnssecEnabled": 0
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the update, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | CDN name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>id`` | int | CDN id. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "name": "cdn_test2",
+ "id": 3
+ "dnssecEnabled": 0
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was updated."
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/cdns/{:id}**
+
+ Allows user to delete a CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+================================================+
+ | ``id`` | yes | CDN id. |
+ +-----------------+----------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+----------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+==========+================================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-----------------+----------+------------------------------------------------+
+ | ``>level`` | string | success, info, warning or error. |
+ +-----------------+----------+------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-----------------+----------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "cdn was deleted."
+ }
+ ],
+ }
+
+|
+
+Health
+++++++
+
+.. _to-api-v12-cdn-health-route:
+
+**GET /api/1.2/cdns/health**
+
+ Retrieves the health of all locations (cache groups) for all CDNs.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.2/cdns/:name/health**
+
+ Retrieves the health of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |``name`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across the |
+ | | | specified CDN. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across the |
+ | | | specified CDN. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.2/cdns/usage/overview**
+
+ Retrieves the high-level CDN usage metrics.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``currentGbps`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``tps`` | int | |
+ +----------------------+--------+------------------------------------------------+
+ |``maxGbps`` | int | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "currentGbps": 149.368167,
+ "tps": 36805,
+ "maxGbps": 3961
+ }
+ }
+
+|
+
+**GET /api/1.2/cdns/capacity**
+
+ Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``availablePercent`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``unavailablePercent``| number | |
+ +----------------------+--------+------------------------------------------------+
+ |``utilizedPercent`` | number | |
+ +----------------------+--------+------------------------------------------------+
+ |``maintenancePercent``| number | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "availablePercent": 89.0939840205533,
+ "unavailablePercent": 0,
+ "utilizedPercent": 10.9060020300395,
+ "maintenancePercent": 0.0000139494071146245
+ }
+ }
+
+|
+
+.. _to-api-v12-cdn-routing:
+
+Routing
++++++++
+
+**GET /api/1.2/cdns/routing**
+
+ Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+-----------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+=========================================+
+ | ``staticRoute`` | number | Used pre-configured DNS entries. |
+ +-----------------+--------+-----------------------------------------+
+ | ``miss`` | number | No location available for client IP. |
+ +-----------------+--------+-----------------------------------------+
+ | ``geo`` | number | Used 3rd party geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------+
+ | ``err`` | number | Error localizing client IP. |
+ +-----------------+--------+-----------------------------------------+
+ | ``cz`` | number | Used Coverage Zone geo-IP mapping. |
+ +-----------------+--------+-----------------------------------------+
+ | ``dsr`` | number | Overflow traffic sent to secondary CDN. |
+ +-----------------+--------+-----------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "staticRoute": 0,
+ "miss": 0,
+ "geo": 37.8855391018869,
+ "err": 0,
+ "cz": 62.1144608981131,
+ "dsr": 0
+ }
+ }
+
+|
+
+.. _to-api-v12-cdn-metrics:
+
+Metrics
++++++++
+
+**GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end**
+
+ Retrieves edge metrics of one or all locations (cache groups).
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------+
+ | Name | Required | Description |
+ +=================+==========+===========================+
+ | ``metric_type`` | yes | ooff, origin_tps |
+ +-----------------+----------+---------------------------+
+ | ``start`` | yes | UNIX time, yesterday, now |
+ +-----------------+----------+---------------------------+
+ | ``end`` | yes | UNIX time, yesterday, now |
+ +-----------------+----------+---------------------------+
+
+ **Response Properties**
+
+ +---------------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=====================+========+=============+
+ | ``stats`` | hash | |
+ +---------------------+--------+-------------+
+ | ``>count`` | string | |
+ +---------------------+--------+-------------+
+ | ``>98thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>min`` | string | |
+ +---------------------+--------+-------------+
+ | ``>max`` | string | |
+ +---------------------+--------+-------------+
+ | ``>5thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>95thPercentile`` | string | |
+ +---------------------+--------+-------------+
+ | ``>mean`` | string | |
+ +---------------------+--------+-------------+
+ | ``>sum`` | string | |
+ +---------------------+--------+-------------+
+ | ``data`` | array | |
+ +---------------------+--------+-------------+
+ | ``>time`` | int | |
+ +---------------------+--------+-------------+
+ | ``>value`` | number | |
+ +---------------------+--------+-------------+
+ | ``label`` | string | |
+ +---------------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "stats": {
+ "count": 1,
+ "98thPercentile": 1668.03,
+ "min": 1668.03,
+ "max": 1668.03,
+ "5thPercentile": 1668.03,
+ "95thPercentile": 1668.03,
+ "mean": 1668.03,
+ "sum": 1668.03
+ },
+ "data": [
+ [
+ 1425135900000,
+ 1668.03
+ ],
+ [
+ 1425136200000,
+ null
+ ]
+ ],
+ "label": "Origin TPS"
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v12-cdn-domains:
+
+Domains
++++++++
+
+**GET /api/1.2/cdns/domains**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``profileId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``parameterId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``profileName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``profileDescription``| string | |
+ +----------------------+--------+------------------------------------------------+
+ |``domainName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "profileId": "5",
+ "parameterId": "404",
+ "profileName": "CR_FOO",
+ "profileDescription": "Content Router for foo.domain.net",
+ "domainName": "foo.domain.net"
+ },
+ {
+ "profileId": "8",
+ "parameterId": "405",
+ "profileName": "CR_BAR",
+ "profileDescription": "Content Router for bar.domain.net",
+ "domainName": "bar.domain.net"
+ }
+ ],
+ }
+
+|
+
+.. _to-api-v12-cdn-topology:
+
+Topology
+++++++++
+
+**GET /api/1.2/cdns/:cdn_name/configs**
+
+ Retrieves CDN config information.
+
+ Authentication Required: Yes
+
+ **Request Route Parameters**
+
+ +--------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==============+==========+=======================+
+ | ``cdn_name`` | yes | Your cdn name or, all |
+ +--------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +-----------------------+--------+-----------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+========+===============================================+
+ |``id`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``value`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``name`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+ |``config_file`` | string | |
+ +-----------------------+--------+-----------------------------------------------+
+
+ **Response Example** ::
+
+ TBD
+
+|
+
+**GET /api/1.2/cdns/:name/configs/monitoring**
+
+ Retrieves CDN monitoring information.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | CDN name |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------------------------+--------+--------------------+
+ | Parameter | Type | Description |
+ +=================================================+========+====================+
+ | ``trafficServers`` | array | A collection of |
+ | | | Traffic Servers. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>cacheGroup`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>port`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>interfaceName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>type`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hashId`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``cacheGroups`` | array | A collection of |
+ | | | cache groups. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>coordinates`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>name`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``config`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hack.ttl`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.healthParams.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.dataServer.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.timepad`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.polling.interval`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.threadPool`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.polling.interval`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>health.event-count`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>tm.crConfig.polling.url`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>CDN_name`` | number | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``trafficMonitors`` | array | A collection of |
+ | | | Traffic Monitors. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>location`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>port`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``deliveryServices`` | array | A collection of |
+ | | | delivery services. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>xmlId`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>totalTpsThreshold`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>status`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>totalKbpsThreshold`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``profiles`` | array | A collection of |
+ | | | profiles. |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>parameters`` | hash | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.connection.timeout`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.polling.url`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.queryTime`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>history.count`` | int | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.availableBandwidthInKbps`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>>health.threshold.loadavg`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>name`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+ | ``>type`` | string | |
+ +-------------------------------------------------+--------+--------------------+
+
+ **Response Example**
+ ::
+
+ TBD
+
+|
+
+**GET /api/1.2/cdns/:name/configs/routing**
+
+ Retrieves CDN routing information.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------------+---------+-----------------------------------+
+ | Parameter | Type | Description |
+ +=====================================+=========+===================================+
+ | ``trafficServers`` | array | A collection of Traffic Servers. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>cacheGroup`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>deliveryServices`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>xmlId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>remaps`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>interfaceName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>type`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hashId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``stats`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsPath`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>cdnName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsVersion`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsUser`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>date`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>trafficOpsHost`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``cacheGroups`` | array | A collection of cache groups. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coordinates`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>name`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``config`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.admin`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tcoveragezone.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.expire`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coveragezone.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.minimum`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>domain_name`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.AAAA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.refresh`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.NS`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.SOA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation6.polling.interval`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.ttls.A`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>tld.soa.retry`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geolocation6.polling.url`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``trafficMonitors`` | array | A collection of Traffic Monitors. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>location`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``deliveryServices`` | array | A collection of delivery |
+ | | | services. |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>xmlId`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ttl`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>geoEnabled`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>coverageZoneOnly`` | boolean | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>matchSets`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>protocol`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>matchList`` | array | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>>regex`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>>matchType`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>bypassDestination`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>maxDnsIpsForLocation`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>ttl`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>type`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ttls`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>A`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>SOA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>NS`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>AAAA`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>missCoordinates`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>longitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>latitude`` | number | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>soa`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>admin`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>retry`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>minimum`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>refresh`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>>expire`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``trafficRouters`` | hash | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>profile`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>location`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>status`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>ip6`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>port`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>hostName`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>fqdn`` | string | |
+ +-------------------------------------+---------+-----------------------------------+
+ | ``>apiPort`` | int | |
+ +-------------------------------------+---------+-----------------------------------+
+
+**Response Example**
+::
+
+ TBD
+
+|
+
+
+.. _to-api-v12-cdn-dnsseckeys:
+
+DNSSEC Keys
++++++++++++
+
+**GET /api/1.2/cdns/name/:name/dnsseckeys**
+
+ Gets a list of dnsseckeys for a CDN and all associated Delivery Services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===============================+========+===============================================================+
+ | ``cdn name/ds xml_id`` | string | identifier for ds or cdn |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>zsk/ksk`` | array | collection of zsk/ksk data |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>ttl`` | string | time-to-live for dnssec requests |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>inceptionDate`` | string | epoch timestamp for when the keys were created |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>expirationDate`` | string | epoch timestamp representing the expiration of the keys |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>private`` | string | encoded private key |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>public`` | string | encoded public key |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>name`` | string | domain name |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``version`` | string | API version |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``ksk>>dsRecord>>algorithm`` | string | The algorithm of the referenced DNSKEY-recor. |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``ksk>>dsRecord>>digestType`` | string | Cryptographic hash algorithm used to create the Digest value. |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``ksk>>dsRecord>>digest`` | string | A cryptographic hash value of the referenced DNSKEY-record. |
+ +-------------------------------+--------+---------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cdn1": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750",
+ "ttl": "60",
+ dsRecord: {
+ "algorithm": "5",
+ "digestType": "2",
+ "digest": "abc123def456"
+ }
+ }
+ },
+ "ds-01": {
+ "zsk": {
+ "ttl": "60",
+ "inceptionDate": "1426196750",
+ "private": "zsk private key",
+ "public": "zsk public key",
+ "expirationDate": "1428788750",
+ "name": "ds-01.foo.kabletown.com."
+ },
+ "ksk": {
+ "name": "ds-01.foo.kabletown.com.",
+ "expirationDate": "1457732750",
+ "public": "ksk public key",
+ "private": "ksk private key",
+ "inceptionDate": "1426196750"
+ }
+ },
+ ... repeated for each ds in the cdn
+ },
+ }
+
+
+|
+
+**GET /api/1.2/cdns/name/:name/dnsseckeys/delete**
+
+ Delete dnssec keys for a cdn and all associated delivery services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+----------------------------------------------------------+
+ | Name | Required | Description |
+ +==========+==========+==========================================================+
+ | ``name`` | yes | name of the CDN for which you want to delete dnssec keys |
+ +----------+----------+----------------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------+--------+------------------+
+ | Parameter | Type | Description |
+ +==============+========+==================+
+ | ``response`` | string | success response |
+ +--------------+--------+------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "response": "Successfully deleted dnssec keys for <cdn>"
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/dnsseckeys/generate**
+
+ Generates ZSK and KSK keypairs for a CDN and all associated Delivery Services.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Properties**
+
+ +-----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +=======================+=========+================================================+
+ | ``key`` | string | name of the cdn |
+ +-----------------------+---------+------------------------------------------------+
+ | ``name`` | string | domain name of the cdn |
+ +-----------------------+---------+------------------------------------------------+
+ | ``ttl`` | string | time to live |
+ +-----------------------+---------+------------------------------------------------+
+ | ``kskExpirationDays`` | string | Expiration (in days) for the key signing keys |
+ +-----------------------+---------+------------------------------------------------+
+ | ``zskExpirationDays`` | string | Expiration (in days) for the zone signing keys |
+ +-----------------------+---------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "cdn1",
+ "name" "ott.kabletown.com",
+ "ttl": "60",
+ "kskExpirationDays": "365",
+ "zskExpirationDays": "90"
+ }
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+
+ {
+ "response": "Successfully created dnssec keys for cdn1"
+ }
+
+.. _to-api-v12-cdn-sslkeys:
+
+SSL Keys
++++++++++++
+
+**GET /api/1.2/cdns/name/:name/sslkeys**
+
+ Returns ssl certificates for all Delivery Services that are a part of the CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +----------+----------+-------------+
+ | Name | Required | Description |
+ +==========+==========+=============+
+ | ``name`` | yes | |
+ +----------+----------+-------------+
+
+ **Response Properties**
+
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===============================+========+===============================================================+
+ | ``deliveryservice`` | string | identifier for deliveryservice xml_id |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``certificate`` | array | collection of certificate |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>key`` | string | base64 encoded private key for ssl certificate |
+ +-------------------------------+--------+---------------------------------------------------------------+
+ | ``>>crt`` | string | base64 encoded ssl certificate |
+ +-------------------------------+--------+---------------------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "deliveryservice": "ds1",
+ "certificate": {
+ "crt": "base64encodedcrt1",
+ "key": "base64encodedkey1"
+ }
+ },
+ {
+ "deliveryservice": "ds2",
+ "certificate": {
+ "crt": "base64encodedcrt2",
+ "key": "base64encodedkey2"
+ }
+ }
+ ]
+ }
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/changelog.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/changelog.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/changelog.rst.txt
deleted file mode 100644
index 5cedbe0..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/changelog.rst.txt
+++ /dev/null
@@ -1,154 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v12-change-logs:
-
-Change Logs
-===========
-
-.. _to-api-v12-change-logs-route:
-
-/api/1.2/logs
-+++++++++++++
-
-**GET /api/1.2/logs.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+==========================================================================+
- | ``ticketNum`` | string | Optional field to cross reference with any bug tracking systems |
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``level`` | string | Log categories for each entry, examples: 'UICHANGE', 'OPER', 'APICHANGE'.|
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | Local unique identifier for the Log |
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``user`` | string | Current user who made the change that was logged |
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the Log entry |
- +-----------------+--------+--------------------------------------------------------------------------+
- | ``message`` | string | Log detail about what occurred |
- +-----------------+--------+--------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "ticketNum": null,
- "level": "OPER",
- "lastUpdated": "2015-02-04 22:59:13",
- "user": "userid852",
- "id": "22661",
- "message": "Snapshot CRConfig created."
- },
- {
- "ticketNum": null,
- "level": "APICHANGE",
- "lastUpdated": "2015-02-03 17:04:20",
- "user": "userid853",
- "id": "22658",
- "message": "Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"
- },
- ],
- }
-
-|
-
-**GET /api/1.2/logs/:days/days.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------+----------+-----------------+
- | Name | Required | Description |
- +==========+==========+=================+
- | ``days`` | yes | Number of days. |
- +----------+----------+-----------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``ticketNum`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``level`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``user`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``message`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "ticketNum": null,
- "level": "OPER",
- "lastUpdated": "2015-02-04 22:59:13",
- "user": "userid852",
- "id": "22661",
- "message": "Snapshot CRConfig created."
- },
- {
- "ticketNum": null,
- "level": "APICHANGE",
- "lastUpdated": "2015-02-03 17:04:20",
- "user": "userid853",
- "id": "22658",
- "message": "Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"
- }
- ],
- }
-
-|
-
-**GET /api/1.2/logs/newcount.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``newLogcount`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "newLogcount": 0
- }
- }
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/changelog.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/changelog.txt b/docs/latest/_sources/development/traffic_ops_api/v12/changelog.txt
new file mode 100644
index 0000000..5cedbe0
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/changelog.txt
@@ -0,0 +1,154 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v12-change-logs:
+
+Change Logs
+===========
+
+.. _to-api-v12-change-logs-route:
+
+/api/1.2/logs
++++++++++++++
+
+**GET /api/1.2/logs.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+==========================================================================+
+ | ``ticketNum`` | string | Optional field to cross reference with any bug tracking systems |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``level`` | string | Log categories for each entry, examples: 'UICHANGE', 'OPER', 'APICHANGE'.|
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | Local unique identifier for the Log |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``user`` | string | Current user who made the change that was logged |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the Log entry |
+ +-----------------+--------+--------------------------------------------------------------------------+
+ | ``message`` | string | Log detail about what occurred |
+ +-----------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "ticketNum": null,
+ "level": "OPER",
+ "lastUpdated": "2015-02-04 22:59:13",
+ "user": "userid852",
+ "id": "22661",
+ "message": "Snapshot CRConfig created."
+ },
+ {
+ "ticketNum": null,
+ "level": "APICHANGE",
+ "lastUpdated": "2015-02-03 17:04:20",
+ "user": "userid853",
+ "id": "22658",
+ "message": "Update server odol-atsec-nyc-23.kbaletown.net status=REPORTED"
+ },
+ ],
+ }
+
+|
+
+**GET /api/1.2/logs/:days/days.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------+----------+-----------------+
+ | Name | Required | Description |
+ +==========+==========+=================+
+ | ``days`` | yes | Number of days. |
+ +----------+----------+-----------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``ticketNum`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``level`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``user`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``message`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "ticketNum": null,
+ "level": "OPER",
+ "lastUpdated": "2015-02-04 22:59:13",
+ "user": "userid852",
+ "id": "22661",
+ "message": "Snapshot CRConfig created."
+ },
+ {
+ "ticketNum": null,
+ "level": "APICHANGE",
+ "lastUpdated": "2015-02-03 17:04:20",
+ "user": "userid853",
+ "id": "22658",
+ "message": "Update server odol-atsec-nyc-23.kabletown.net status=REPORTED"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/logs/newcount.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``newLogcount`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "newLogcount": 0
+ }
+ }
+
[29/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt
deleted file mode 100644
index 379ea37..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.rst.txt
+++ /dev/null
@@ -1,1756 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v12-ds:
-
-Delivery Service
-================
-
-.. _to-api-v12-ds-route:
-
-/api/1.2/deliveryservices
-+++++++++++++++++++++++++
-
-**GET /api/1.2/deliveryservices**
-
- Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+======================================================================================================================================+
- | ``active`` | bool | true if active, false if inactive. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``displayName`` | string | The display name of the delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectUrl`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | string | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from USA |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitCountries`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The deliveryservice id (database row number). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``initialDispersion`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``logsEnabled`` | bool | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``originShield`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "active": true,
- "cacheurl": null,
- "ccrDnsTtl": "3600",
- "cdnId": "2",
- "cdnName": "over-the-top",
- "checkPath": "",
- "displayName": "My Cool Delivery Service",
- "dnsBypassCname": "",
- "dnsBypassIp": "",
- "dnsBypassIp6": "",
- "dnsBypassTtl": "30",
- "dscp": "40",
- "edgeHeaderRewrite": null,
- "exampleURLs": [
- "http://edge.foo-ds.foo.bar.net"
- ],
- "geoLimit": "0",
- "geoLimitCountries": null,
- "geoLimitRedirectURL": null,
- "geoProvider": "0",
- "globalMaxMbps": null,
- "globalMaxTps": "0",
- "httpBypassFqdn": "",
- "id": "442",
- "infoUrl": "",
- "initialDispersion": "1",
- "ipv6RoutingEnabled": true,
- "lastUpdated": "2016-01-26 08:49:35",
- "logsEnabled": false,
- "longDesc": "",
- "longDesc1": "",
- "longDesc2": "",
- "matchList": [
- {
- "pattern": ".*\\.foo-ds\\..*",
- "setNumber": "0",
- "type": "HOST_REGEXP"
- }
- ],
- "maxDnsAnswers": "0",
- "midHeaderRewrite": null,
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "multiSiteOrigin": false,
- "multiSiteOriginAlgorithm": null,
- "orgServerFqdn": "http://baz.boo.net",
- "originShield": null,
- "profileDescription": "Content Router for over-the-top",
- "profileId": "5",
- "profileName": "ROUTER_TOP",
- "protocol": "0",
- "qstringIgnore": "1",
- "rangeRequestHandling": "0",
- "regexRemap": null,
- "regionalGeoBlocking": false,
- "remapText": null,
- "signed": false,
- "sslKeyVersion": "0",
- "trRequestHeaders": null,
- "trResponseHeaders": "Access-Control-Allow-Origin: *",
- "type": "HTTP",
- "typeId": "8",
- "xmlId": "foo-ds"
- }
- { .. },
- { .. }
- ]
- }
-
-|
-
-
-**GET /api/1.2/deliveryservices/:id**
-
- Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+======================================================================================================================================+
- | ``active`` | bool | true if active, false if inactive. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``displayName`` | string | The display name of the delivery service. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitRedirectUrl`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimit`` | string | - 0: None - no limitations |
- | | | - 1: Only route on CZF file hit |
- | | | - 2: Only route on CZF hit or when from USA |
- | | | |
- | | | Note that this does not prevent access to content or makes content secure; it just prevents |
- | | | routing to the content by Traffic Router. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoLimitCountries`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``geoProvider`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
- | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
- | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
- | | | HTTP deliveryservices |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
- | | | globalMaxMbps traffic on this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``id`` | string | The deliveryservice id (database row number). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``initialDispersion`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``lastUpdated`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``logsEnabled`` | bool | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc`` | string | Description field 1. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc1`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``longDesc2`` | string | Description field 2. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``matchList`` | array | Array of matchList hashes. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>setNumber`` | string | The set Number of the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``>>pattern`` | string | The regexp for the matchList. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
- | | | available). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
- | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``originShield`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``protocol`` | string | - 0: serve with http:// at EDGE |
- | | | - 1: serve with https:// at EDGE |
- | | | - 2: serve with both http:// and https:// at EDGE |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
- | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
- | | | - 2: drop query string at edge, and do not use it in the cache-key. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``rangeRequestHandling`` | string | How to treat range requests: |
- | | | |
- | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
- | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
- | | | - 2 Use the cache_range_requests plugin. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``remapText`` | string | Additional raw remap line text. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
- | | | - true: token based auth is enabled for this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``sslKeyVersion`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trRequestHeaders`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``trResponseHeaders`` | string | |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
- | ``xmlId`` | string | Unique string that describes this deliveryservice. |
- +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "active": true,
- "cacheurl": null,
- "ccrDnsTtl": "3600",
- "cdnId": "2",
- "cdnName": "over-the-top",
- "checkPath": "",
- "displayName": "My Cool Delivery Service",
- "dnsBypassCname": "",
- "dnsBypassIp": "",
- "dnsBypassIp6": "",
- "dnsBypassTtl": "30",
- "dscp": "40",
- "edgeHeaderRewrite": null,
- "exampleURLs": [
- "http://edge.foo-ds.foo.bar.net"
- ],
- "geoLimit": "0",
- "geoLimitCountries": null,
- "geoLimitRedirectURL": null,
- "geoProvider": "0",
- "globalMaxMbps": null,
- "globalMaxTps": "0",
- "httpBypassFqdn": "",
- "id": "442",
- "infoUrl": "",
- "initialDispersion": "1",
- "ipv6RoutingEnabled": true,
- "lastUpdated": "2016-01-26 08:49:35",
- "logsEnabled": false,
- "longDesc": "",
- "longDesc1": "",
- "longDesc2": "",
- "matchList": [
- {
- "pattern": ".*\\.foo-ds\\..*",
- "setNumber": "0",
- "type": "HOST_REGEXP"
- }
- ],
- "maxDnsAnswers": "0",
- "midHeaderRewrite": null,
- "missLat": "41.881944",
- "missLong": "-87.627778",
- "multiSiteOrigin": false,
- "multiSiteOriginAlgorithm": null,
- "orgServerFqdn": "http://baz.boo.net",
- "originShield": null,
- "profileDescription": "Content Router for over-the-top",
- "profileId": "5",
- "profileName": "ROUTER_TOP",
- "protocol": "0",
- "qstringIgnore": "1",
- "rangeRequestHandling": "0",
- "regexRemap": null,
- "regionalGeoBlocking": false,
- "remapText": null,
- "signed": false,
- "sslKeyVersion": "0",
- "trRequestHeaders": null,
- "trResponseHeaders": "Access-Control-Allow-Origin: *",
- "type": "HTTP",
- "typeId": "8",
- "xmlId": "foo-ds"
- }
- ]
- }
-
-|
-
-
-.. _to-api-v12-ds-health:
-
-Health
-++++++
-
-**GET /api/1.2/deliveryservices/:id/state**
-
- Retrieves the failover state for a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+---------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+=================================================+
- | ``failover`` | hash | |
- +------------------+---------+-------------------------------------------------+
- | ``>locations`` | array | |
- +------------------+---------+-------------------------------------------------+
- | ``>destination`` | hash | |
- +------------------+---------+-------------------------------------------------+
- | ``>>location`` | string | |
- +------------------+---------+-------------------------------------------------+
- | ``>>type`` | string | |
- +------------------+---------+-------------------------------------------------+
- | ``>configured`` | boolean | |
- +------------------+---------+-------------------------------------------------+
- | ``>enabled`` | boolean | |
- +------------------+---------+-------------------------------------------------+
- | ``enabled`` | boolean | |
- +------------------+---------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "failover": {
- "locations": [ ],
- "destination": {
- "location": null,
- "type": "DNS",
- },
- "configured": false,
- "enabled": false
- },
- "enabled": true
- }
- }
-
-|
-
-**GET /api/1.2/deliveryservices/:id/health**
-
- Retrieves the health of all locations (cache groups) for a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``totalOnline`` | int | Total number of online caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``cachegroups`` | array | A collection of cache groups. |
- +------------------+--------+-------------------------------------------------+
- | ``>online`` | int | The number of online caches for the cache group |
- +------------------+--------+-------------------------------------------------+
- | ``>offline`` | int | The number of offline caches for the cache |
- | | | group. |
- +------------------+--------+-------------------------------------------------+
- | ``>name`` | string | Cache group name. |
- +------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "totalOnline": 148,
- "totalOffline": 0,
- "cachegroups": [
- {
- "online": 8,
- "offline": 0,
- "name": "us-co-denver"
- },
- {
- "online": 7,
- "offline": 0,
- "name": "us-de-newcastle"
- }
- ]
- }
- }
-
-|
-
-**GET /api/1.2/deliveryservices/:id/capacity**
-
- Retrieves the capacity percentages of a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- |id | yes | delivery service id. |
- +-----------------+----------+---------------------------------------------------+
-
- **Response Properties**
-
- +------------------------+--------+---------------------------------------------------+
- | Parameter | Type | Description |
- +========================+========+===================================================+
- | ``availablePercent`` | number | The percentage of server capacity assigned to |
- | | | the delivery service that is available. |
- +------------------------+--------+---------------------------------------------------+
- | ``unavailablePercent`` | number | The percentage of server capacity assigned to the |
- | | | delivery service that is unavailable. |
- +------------------------+--------+---------------------------------------------------+
- | ``utilizedPercent`` | number | The percentage of server capacity assigned to the |
- | | | delivery service being used. |
- +------------------------+--------+---------------------------------------------------+
- | ``maintenancePercent`` | number | The percentage of server capacity assigned to the |
- | | | delivery service that is down for maintenance. |
- +------------------------+--------+---------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "availablePercent": 89.0939840205533,
- "unavailablePercent": 0,
- "utilizedPercent": 10.9060020300395,
- "maintenancePercent": 0.0000139494071146245
- },
- }
-
-
-|
-
-**GET /api/1.2/deliveryservices/:id/routing**
-
- Retrieves the routing method percentages of a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- |id | yes | delivery service id. |
- +-----------------+----------+---------------------------------------------------+
-
- **Response Properties**
-
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+=============================================================================================================================+
- | ``staticRoute`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries. |
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``miss`` | number | The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP). |
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``geo`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping. |
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``err`` | number | The percentage of Traffic Router requests for this deliveryservice resulting in an error. |
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``cz`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF (coverage zone file) hit. |
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``dsr`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the |
- | | | client to the overflow CDN. |
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``fed`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to a federated CDN. |
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``regionalAlternate`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the alternate |
- | | | regional geoblocking URL. |
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
- | ``regionalDenied`` | number | The percent of Traffic Router requests for this deliveryservice denied due to geolocation policy. |
- +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "staticRoute": 0,
- "miss": 0,
- "geo": 37.8855391018869,
- "err": 0,
- "cz": 62.1144608981131,
- "dsr": 0,
- "fed": 0,
- "regionalAlternate": 0,
- "regionalDenied": 0
- },
- }
-
-
-.. _to-api-v12-ds-server:
-
-Server
-++++++
-
-**GET /api/1.2/deliveryserviceserver**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +-----------+----------+----------------------------------------+
- | Name | Required | Description |
- +===========+==========+========================================+
- | ``page`` | no | The page number for use in pagination. |
- +-----------+----------+----------------------------------------+
- | ``limit`` | no | For use in limiting the result set. |
- +-----------+----------+----------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``lastUpdated`` | array | |
- +----------------------+--------+------------------------------------------------+
- |``server`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``deliveryService`` | string | |
- +----------------------+--------+------------------------------------------------+
-
-
- **Response Example** ::
-
- {
- "page": 2,
- "orderby": "deliveryservice",
- "response": [
- {
- "lastUpdated": "2014-09-26 17:53:43",
- "server": "20",
- "deliveryService": "1"
- },
- {
- "lastUpdated": "2014-09-26 17:53:44",
- "server": "21",
- "deliveryService": "1"
- },
- ],
- "limit": 2
- }
-
-
-
-.. _to-api-v12-ds-sslkeys:
-
-SSL Keys
-+++++++++
-
-**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys**
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Route Parameters**
-
- +-----------+----------+----------------------------------------+
- | Name | Required | Description |
- +===========+==========+========================================+
- | ``xmlId`` | yes | xml_id of the desired delivery service |
- +-----------+----------+----------------------------------------+
-
-
- **Request Query Parameters**
-
- +-------------+----------+--------------------------------+
- | Name | Required | Description |
- +=============+==========+================================+
- | ``version`` | no | The version number to retrieve |
- +-------------+----------+--------------------------------+
-
- **Response Properties**
-
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================================================================================+
- | ``crt`` | string | base64 encoded crt file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``csr`` | string | base64 encoded csr file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``key`` | string | base64 encoded private key file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``version`` | string | The version of the certificate record in Riak |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "certificate": {
- "crt": "crt",
- "key": "key",
- "csr": "csr"
- },
- "businessUnit": "CDN_Eng",
- "city": "Denver",
- "organization": "KableTown",
- "hostname": "foober.com",
- "country": "US",
- "state": "Colorado",
- "version": "1"
- }
- }
-
-|
-
-**GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys**
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Route Parameters**
-
- +--------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +==============+==========+===================================================+
- | ``hostname`` | yes | pristine hostname of the desired delivery service |
- +--------------+----------+---------------------------------------------------+
-
-
- **Request Query Parameters**
-
- +-------------+----------+--------------------------------+
- | Name | Required | Description |
- +=============+==========+================================+
- | ``version`` | no | The version number to retrieve |
- +-------------+----------+--------------------------------+
-
- **Response Properties**
-
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================================================================================+
- | ``crt`` | string | base64 encoded crt file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``csr`` | string | base64 encoded csr file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``key`` | string | base64 encoded private key file for delivery service |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
- | ``version`` | string | The version of the certificate record in Riak |
- +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "certificate": {
- "crt": "crt",
- "key": "key",
- "csr": "csr"
- },
- "businessUnit": "CDN_Eng",
- "city": "Denver",
- "organization": "KableTown",
- "hostname": "foober.com",
- "country": "US",
- "state": "Colorado",
- "version": "1"
- }
- }
-
-|
-
-**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete**
-
- Authentication Required: Yes
-
- Role Required: Admin
-
- **Request Route Parameters**
-
- +-----------+----------+----------------------------------------+
- | Name | Required | Description |
- +===========+==========+========================================+
- | ``xmlId`` | yes | xml_id of the desired delivery service |
- +-----------+----------+----------------------------------------+
-
- **Request Query Parameters**
-
- +-------------+----------+--------------------------------+
- | Name | Required | Description |
- +=============+==========+================================+
- | ``version`` | no | The version number to retrieve |
- +-------------+----------+--------------------------------+
-
- **Response Properties**
-
- +--------------+--------+------------------+
- | Parameter | Type | Description |
- +==============+========+==================+
- | ``response`` | string | success response |
- +--------------+--------+------------------+
-
- **Response Example** ::
-
- {
- "response": "Successfully deleted ssl keys for <xml_id>"
- }
-
-|
-
-**POST /api/1.2/deliveryservices/sslkeys/generate**
-
- Generates SSL crt, csr, and private key for a delivery service
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Properties**
-
- +--------------+---------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==============+=========+=================================================+
- | ``key`` | string | xml_id of the delivery service |
- +--------------+---------+-------------------------------------------------+
- | ``version`` | string | version of the keys being generated |
- +--------------+---------+-------------------------------------------------+
- | ``hostname`` | string | the *pristine hostname* of the delivery service |
- +--------------+---------+-------------------------------------------------+
- | ``country`` | string | |
- +--------------+---------+-------------------------------------------------+
- | ``state`` | string | |
- +--------------+---------+-------------------------------------------------+
- | ``city`` | string | |
- +--------------+---------+-------------------------------------------------+
- | ``org`` | string | |
- +--------------+---------+-------------------------------------------------+
- | ``unit`` | boolean | |
- +--------------+---------+-------------------------------------------------+
-
- **Request Example** ::
-
- {
- "key": "ds-01",
- "businessUnit": "CDN Engineering",
- "version": "3",
- "hostname": "tr.ds-01.ott.kabletown.com",
- "certificate": {
- "key": "some_key",
- "csr": "some_csr",
- "crt": "some_crt"
- },
- "country": "US",
- "organization": "Kabletown",
- "city": "Denver",
- "state": "Colorado"
- }
-
-|
-
- **Response Properties**
-
- +--------------+--------+-----------------+
- | Parameter | Type | Description |
- +==============+========+=================+
- | ``response`` | string | response string |
- +--------------+--------+-----------------+
- | ``version`` | string | API version |
- +--------------+--------+-----------------+
-
- **Response Example** ::
-
- {
- "response": "Successfully created ssl keys for ds-01"
- }
-
-|
-
-**POST /api/1.2/deliveryservices/sslkeys/add**
-
- Allows user to add SSL crt, csr, and private key for a delivery service.
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Properties**
-
- +-------------+--------+-------------------------------------+
- | Parameter | Type | Description |
- +=============+========+=====================================+
- | ``key`` | string | xml_id of the delivery service |
- +-------------+--------+-------------------------------------+
- | ``version`` | string | version of the keys being generated |
- +-------------+--------+-------------------------------------+
- | ``csr`` | string | |
- +-------------+--------+-------------------------------------+
- | ``crt`` | string | |
- +-------------+--------+-------------------------------------+
- | ``key`` | string | |
- +-------------+--------+-------------------------------------+
-
- **Request Example** ::
-
- {
- "key": "ds-01",
- "version": "1",
- "certificate": {
- "key": "some_key",
- "csr": "some_csr",
- "crt": "some_crt"
- }
- }
-
-|
-
- **Response Properties**
-
- +--------------+--------+-----------------+
- | Parameter | Type | Description |
- +==============+========+=================+
- | ``response`` | string | response string |
- +--------------+--------+-----------------+
- | ``version`` | string | API version |
- +--------------+--------+-----------------+
-
- **Response Example** ::
-
- {
- "response": "Successfully added ssl keys for ds-01"
- }
-
-**POST /api/1.2/deliveryservices/request**
-
- Allows a user to send delivery service request details to a specified email address.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | Parameter | Type | Required | Description |
- +========================================+========+==========+=============================================================================================+
- | ``emailTo`` | string | yes | The email to which the delivery service request will be sent. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``details`` | hash | yes | Parameters for the delivery service request. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>customer`` | string | yes | Name of the customer to associated with the delivery service. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>deliveryProtocol`` | string | yes | Eg. http or http/https |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>routingType`` | string | yes | Eg. DNS or HTTP Redirect |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>serviceDesc`` | string | yes | A description of the delivery service. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>peakBPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>peakTPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>maxLibrarySizeEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>originURL`` | string | yes | The URL path to the origin server. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>hasOriginDynamicRemap`` | bool | yes | This is a feature which allows services to use multiple origin URLs for the same service. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>originTestFile`` | string | yes | A URL path to a test file available on the origin server. |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>hasOriginACLWhitelist`` | bool | yes | Is access to your origin restricted using an access control list (ACL or whitelist) of Ips? |
- +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
- | ``>originHeaders`` | string | no | Header values that must be passed to requests to your origin. |
- +----------------------------------------+--------+----------+------------------------------------
<TRUNCATED>
[46/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_portal.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_portal.rst.txt b/docs/latest/_sources/admin/traffic_portal.rst.txt
deleted file mode 100644
index 9e761b8..0000000
--- a/docs/latest/_sources/admin/traffic_portal.rst.txt
+++ /dev/null
@@ -1,53 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-*****************************
-Traffic Portal Administration
-*****************************
-The following are requirements to ensure an accurate set up:
-
-* CentOS 6.7 or 7
-* Node.js 6.0.x or above
-
-**Installing Traffic Portal**
-
- - Download the Traffic Portal RPM from the traffic control `downloads <https://trafficcontrol.apache.org/downloads/index.html>`_ page or build from `source <https://github.com/apache/incubator-trafficcontrol/traffic_portal/build>`_.
- - Copy the Traffic Portal RPM to your server
- - curl --silent --location https://rpm.nodesource.com/setup_6.x | sudo bash -
- - sudo yum install -y nodejs
- - sudo yum install -y <traffic_portal rpm>
-
-**Configuring Traffic Portal**
-
- - cd /etc/traffic_portal/conf
- - sudo cp config-template.js config.js
- - sudo vi config.js (read the inline comments)
- - [OPTIONAL] sudo vi /opt/traffic_portal/public/traffic_portal_properties.json (to customize traffic portal content)
- - [OPTIONAL] sudo vi /opt/traffic_portal/public/resources/assets/css/custom.css (to customize traffic portal skin)
-
-**Starting Traffic Portal**
-
- - sudo service traffic_portal start
-
-**Stopping Traffic Portal**
-
- - sudo service traffic_portal stop
-
-
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_portal.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_portal.txt b/docs/latest/_sources/admin/traffic_portal.txt
new file mode 100644
index 0000000..9e761b8
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_portal.txt
@@ -0,0 +1,53 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+*****************************
+Traffic Portal Administration
+*****************************
+The following are requirements to ensure an accurate set up:
+
+* CentOS 6.7 or 7
+* Node.js 6.0.x or above
+
+**Installing Traffic Portal**
+
+ - Download the Traffic Portal RPM from the traffic control `downloads <https://trafficcontrol.apache.org/downloads/index.html>`_ page or build from `source <https://github.com/apache/incubator-trafficcontrol/traffic_portal/build>`_.
+ - Copy the Traffic Portal RPM to your server
+ - curl --silent --location https://rpm.nodesource.com/setup_6.x | sudo bash -
+ - sudo yum install -y nodejs
+ - sudo yum install -y <traffic_portal rpm>
+
+**Configuring Traffic Portal**
+
+ - cd /etc/traffic_portal/conf
+ - sudo cp config-template.js config.js
+ - sudo vi config.js (read the inline comments)
+ - [OPTIONAL] sudo vi /opt/traffic_portal/public/traffic_portal_properties.json (to customize traffic portal content)
+ - [OPTIONAL] sudo vi /opt/traffic_portal/public/resources/assets/css/custom.css (to customize traffic portal skin)
+
+**Starting Traffic Portal**
+
+ - sudo service traffic_portal start
+
+**Stopping Traffic Portal**
+
+ - sudo service traffic_portal stop
+
+
+
+
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_router.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_router.rst.txt b/docs/latest/_sources/admin/traffic_router.rst.txt
deleted file mode 100644
index 01ab6b3..0000000
--- a/docs/latest/_sources/admin/traffic_router.rst.txt
+++ /dev/null
@@ -1,494 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-*****************************
-Traffic Router Administration
-*****************************
-.. contents::
- :depth: 2
- :backlinks: top
-
-Installing Traffic Router
-==========================
-The following are requirements to ensure an accurate set up:
-
-* CentOS 6
-* 4 vCPUs
-* 8GB RAM
-* Successful install of Traffic Ops
-* Successful install of Traffic Monitor
-* Administrative access to Traffic Ops
-
-.. Note:: Hardware requirements are generally doubled if DNSSEC is enabled
-
-1. If no suitable profile exists, create a new profile for Traffic Router.
-
-2. Enter the Traffic Router server into Traffic Ops, assign it to a Traffic Router profile, and ensure that its status is set to ``ONLINE``.
-3. Ensure the FQDN of the Traffic Monitor is resolvable in DNS. This FQDN must be resolvable by the clients expected to use this CDN.
-4. Install a traffic router: ``sudo yum install traffic_router``.
-5. Edit ``/opt/traffic_router/conf/traffic_monitor.properties`` and specify the correct online Traffic Monitor(s) for your CDN. See :ref:`rl-tr-config-files`
- # traffic_monitor.properties: url that should normally point to this file
- traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties
-
- # Frequency for reloading this file
- # traffic_monitor.properties.reload.period=60000
-
-
-6. Start Tomcat: ``sudo service tomcat start``, and test lookups with dig and curl against that server.
-7. Snapshot CRConfig; See :ref:`rl-snapshot-crconfig`
-
-.. Note:: Once the CRConfig is snapshotted, live traffic will be sent to the new Traffic Routers provided that their status is set to ``ONLINE``.
-
-8. Ensure that the parent domain (e.g.: kabletown.net) for the CDN's top level domain (e.g.: cdn.kabletown.net) contains a delegation (NS records) for the new Traffic Router, and that the value specified matches the FQDN used in step 3.
-
-Configuring Traffic Router
-==========================
-
-.. Note:: Starting with Traffic Router 1.5, many of the configuration files under ``/opt/traffic_router/conf`` are only needed to override the default configuration values for Traffic Router. Most of the given default values will work well for any CDN. Critical values that must be changed are hostnames and credentials for communicating with other Traffic Control components such as Traffic Ops and Traffic Monitor.
-
-.. Note:: Pre-existing installations having configuration files in ``/opt/traffic_router/conf`` will still be used and honored for Traffic Router 1.5 and onward.
-
-For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See :ref:`rl-snapshot-crconfig` for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under :ref:`rl-ccr-profile` for parameters that influence the behavior of Traffic Router via the CRConfig.
-
-.. _rl-tr-config-files:
-
-Configuration files
--------------------
-
-+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| File name | Parameter | Description | Default Value |
-+============================+===========================================+=====================================================================================================+===================================================+
-| traffic_monitor.properties | traffic_monitor.bootstrap.hosts | Traffic Monitor FQDNs and port if necessary, separated by a semicolon (;) | N/A |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | traffic_monitor.bootstrap.local | Use only the Traffic Monitors specified in config file | false |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | traffic_monitor.properties | Path to the traffic_monitor.properties file; used internally to monitor the file for changes | /opt/traffic_router/traffic_monitor.properties |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | traffic_monitor.properties.reload.period | The interval in milliseconds which Traffic Router will reload this configuration file | 60000 |
-+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| dns.properties | dns.tcp.port | TCP port that Traffic Router will use for incoming DNS requests | 53 |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | dns.tcp.backlog | Maximum length of the queue for incoming TCP connection requests | 0 |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | dns.udp.port | UDP port that Traffic Router will use for incoming DNS requests | 53 |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | dns.max-threads | Maximum number of threads used to process incoming DNS requests | 1000 |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | dns.zones.dir | Path to auto generated zone files for reference | /opt/traffic_router/var/auto-zones |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | dns.routing.name | The label (A/AAAA) Traffic Router will use for the entry point for a DNS delivery service | edge (e.g.: edge.mydeliveryservice.kabletown.net) |
-+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| traffic_ops.properties | traffic_ops.username | Username to access the APIs in Traffic Ops (must be in the admin role) | admin |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | traffic_ops.password | Password for the user specified in traffic_ops.username | N/A |
-+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| http.properties | http.routing.name | The label (A/AAAA) Traffic Router will use for the entry point for an HTTP delivery service | tr (e.g.: tr.mydeliveryservice.kabletown.net) |
-+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| cache.properties | cache.geolocation.database | Full path to the local copy of the MaxMind geolocation binary database file | /opt/traffic_router/db/GeoIP2-City.mmdb |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | cache.geolocation.database.refresh.period | The interval in milliseconds which Traffic Router will poll for a new geolocation database | 604800000 |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | cache.czmap.database | Full path to the local copy of the coverage zone file | /opt/traffic_router/db/czmap.json |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | cache.czmap.database.refresh.period | The interval in milliseconds which Traffic Router will poll for a new coverage zone file | 10800000 |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | cache.health.json | Full path to the local copy of the health state | /opt/traffic_router/db/health.json |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | cache.health.json.refresh.period | The interval in milliseconds which Traffic Router will poll for a new health state file | 1000 |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | cache.config.json | Full path to the local copy of the CRConfig | /opt/traffic_router/db/cr-config.json |
-| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| | cache.config.json.refresh.period | The interval in milliseconds which Traffic Router will poll for a new CRConfig | 60000 |
-+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-| log4j.properties | various parameters | Configuration of log4j is documented on their site; adjust as necessary based on needs | N/A |
-+----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
-
-.. _rl-tr-dnssec:
-
-DNSSEC
-======
-
-Overview
---------
-Domain Name System Security Extensions (DNSSEC) is a set of extensions to DNS that provides a cryptographic mechanism for resolvers to verify the authenticity of responses served by an authoritative DNS server.
-
-Several RFCs (4033, 4044, 4045) describe the low level details and define the extensions, RFC 7129 provides clarification around authenticated denial of existence of records, and finally RFC 6781 describes operational best practices for administering an authoritative DNSSEC enabled DNS server. The authenticated denial of existence RFC describes how an authoritative DNS server responds in NXDOMAIN and NODATA scenarios when DNSSEC is enabled.
-
-Traffic Router currently supports DNSSEC with NSEC, however, NSEC3 and more configurable options will be provided in the future.
-
-Operation
----------
-Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN's top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the :ref:`rl-ccr-profile` documentation for more information.
-
-Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service's zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD's zone. A DS record is generated from each zone's KSK and is placed in the CDN TLD's zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.
-
-The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN's TLD, **however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control**. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment's DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.
-
-Rolling Zone Signing Keys
--------------------------
-Traffic Router currently follows the zone signing key pre-publishing operational best practice described in `section 4.1.1.1 of RFC 6781`_. Once DNSSEC is enabled for a CDN in Traffic Ops, key rolls are triggered via Traffic Ops via the automated key generation process, and Traffic Router selects the active zone signing keys based on the expiration information returned from the keystore API in Traffic Ops.
-
-.. _section 4.1.1.1 of RFC 6781: https://tools.ietf.org/html/rfc6781#section-4.1.1.1
-
-Troubleshooting and log files
-=============================
-Traffic Router log files are in ``/opt/traffic_router/var/log``, and Tomcat log files are in ``/opt/tomcat/logs``. Application related logging is in ``/opt/traffic_router/var/log/traffic_router.log``, while access logs are written to ``/opt/traffic_router/var/log/access.log``.
-
-Event Log File Format
-=====================
-
-Summary
--------
-
-All access events to Traffic Router are logged to the file ``/opt/traffic_router/var/log/access.log``
-This file grows up to 200Mb and gets rolled into older log files, 10 log files total are kept (total of up to 2Gb of logged events per traffic router)
-
-Traffic Router logs access events in a format that largely following `ATS event logging format
-<https://docs.trafficserver.apache.org/en/6.0.x/admin/event-logging-formats.en.html>`_
-
---------------
-
-Sample Message
---------------
-
-Items within brackets below are detailed under the HTTP and DNS sections
-::
-
- 144140678.000 qtype=DNS chi=192.168.10.11 ttms=789 [Fields Specific to the DNS request] rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the DNS result]
- 144140678.000 qtype=HTTP chi=192.168.10.11 ttms=789 [Fields Specific to the HTTP request] rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the HTTP result]
-
-.. Note:: The above message samples contain fields that are always present for every single access event to Traffic Router
-
-**Message Format**
-- Each event that is logged is a series of space separated key value pairs except for the first item.
-- The first item is always the epoch in seconds with a decimal field precision of up to milliseconds
-- Each key value pair is in the form of unquoted string, equals character, optionally quoted string
-- Values that are quoted strings may contain space characters
-- Values that are not quoted should not contains any space characters
-
-.. Note:: Any value that is a single dash character or a dash character enclosed in quotes represents an empty value
-
---------
-
-Fields Always Present
----------------------
-
-+------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
-|Name |Description |Data |
-+======+=================================================================================+===========================================================================+
-|qtype |Whether the request was for DNS or HTTP |Always DNS or HTTP |
-+------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
-|chi |The IP address of the requester |Depends on whether this was a DNS or HTTP request, see below sections |
-+------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
-|ttms |The amount of time in milliseconds it took Traffic Router to process the request |A number greater than or equal to zero |
-+------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
-|rtype |Routing Result Type |One of ERROR, CZ, GEO, MISS, STATIC_ROUTE, DS_REDIRECT, DS_MISS, INIT, FED |
-+------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
-|rloc |GeoLocation of result |Latitude and Longitude in Decimal Degrees |
-+------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
-|rdtl |Result Details Associated with unusual conditions |One of DS_NOT_FOUND, DS_NO_BYPASS, DS_BYPASS, DS_CZ_ONLY |
-+------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
-|rerr |Message about internal Traffic Router Error |String |
-+------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
-
-**rtype meanings**
-
-+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|Name |Meaning |
-+=============+========================================================================================================================================================================+
-|ERROR |An internal error occurred within Traffic Router, more details may be found in the rerr field |
-+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|CZ |The result was derived from Coverage Zone data based on the address in the chi field |
-+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|GEO |The result was derived from geolocation service based on the address in the chi field |
-+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|MISS |Traffic Router was unable to resolve a DNS request or find a cache for the requested resource |
-+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|STATIC_ROUTE |_*DNS Only*_ No DNS Delivery Service supports the hostname portion of the requested url |
-+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|DS_MISS |_*HTTP Only*_ No HTTP Delivery Service supports either this request's URL path or headers |
-+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|DS_REDIRECT |The result is using the Bypass Destination configured for the matched Delivery Service when that Delivery Service is unavailable or does not have the requested resource|
-+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-|FED |_*DNS Only*_ The result was obtained through federated coverage zone data outside of any delivery service |
-+-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-**rdtl meanings**
-
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
-|Name |Meaning |
-+==========================+============================================================================================================================================+
-|DS_NOT_FOUND |Always goes with rtypes STATIC_ROUTE and DS_MISS |
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
-|DS_BYPASS |Used Bypass Destination for Redirect of Delivery Service |
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
-|DS_NO_BYPASS |No valid Bypass Destination is configured for the matched Delivery Service and the delivery service does not have the requested resource |
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
-|DS_CZ_ONLY |The selected Delivery Service only supports resource lookup based on Coverage Zone data |
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
-|DS_CLIENT_GEO_UNSUPPORTED |Traffic Router did not find a resource supported by coverage zone data and was unable to determine the geolocation of the requesting client |
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
-|GEO_NO_CACHE_FOUND |Traffic Router could not find a resource via geolocation data based on the requesting client's geolocation |
-+--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
-
----------------
-
-HTTP Specifics
---------------
-
-Sample Message
-::
-
- 1452197640.936 qtype=HTTP chi=69.241.53.218 url="http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" pssc=302 ttms=0 rurl="http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8" rh="Accept: */*" rh="myheader: asdasdasdasfasg"
-
-**Request Fields**
-
-+-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
-|Name |Description |Data |
-+=====+=========================================================================================================================================+===========================================+
-|url |Requested URL with query string |String |
-+-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
-|cqhm |Http Method |e.g GET, POST |
-+-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
-|cqhv |Http Protocol Version |e.g. HTTP/1.1 |
-+-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
-|rh |One or more of these key value pairs may exist in a logged event and are controlled by the configuration of the matched Delivery Service |Key value pair of the format "name: value" |
-+-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
-
-**Response Fields**
-
-+-----+----------------------------------------------------------+------------+
-|Name |Description |Data |
-+=====+==========================================================+============+
-|rurl |The resulting url of the resource requested by the client |A URL String|
-+-----+----------------------------------------------------------+------------+
-
-------------
-
-DNS Specifics
--------------
-
-Sample Message
-::
-
- 144140678.000 qtype=DNS chi=192.168.10.11 ttms=123 xn=65535 fqdn=www.example.com. type=A class=IN ttl=12345 rcode=NOERROR rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" ans="192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"
-
-**Request Fields**
-
-.. _qname: http://www.zytrax.com/books/dns/ch15/#qname
-
-.. _qtype: http://www.zytrax.com/books/dns/ch15/#qtype
-
-+------+------------------------------------------------------------------+--------------------------------------------------------+
-|Name |Description |Data |
-+======+==================================================================+========================================================+
-|xn |The ID from the client DNS request header |a number from 0 to 65535 |
-+------+------------------------------------------------------------------+--------------------------------------------------------+
-|fqdn |The qname field from the client DNS request message (i.e. The |A series of DNS labels/domains separated by '.' |
-| |fully qualified domain name the client is requesting be resolved) |characters and ending with a '.' character (see qname_) |
-+------+------------------------------------------------------------------+--------------------------------------------------------+
-|type |The qtype field from the client DNS request message (i.e. |Examples are A (IpV4), AAAA (IpV6), NS (Name Service), |
-| |the type of resolution that's requested such as IPv4, IPv6) | SOA (Start of Authority), and CNAME, (see qtype_) |
-+------+------------------------------------------------------------------+--------------------------------------------------------+
-|class |The qclass field from the client DNS request message (i.e. The |Either IN (Internet resource) or ANY (Traffic router |
-| |class of resource being requested) | rejects requests with any other value of class) |
-+------+------------------------------------------------------------------+--------------------------------------------------------+
-
-**Response Fields**
-
-+------+---------------------------------------------------------------------+-----------------------------------------------------+
-|Name | Description | Data |
-+======+=====================================================================+=====================================================+
-|ttl | The 'time to live' in seconds for the answer provided by Traffic |A number from 0 to 4294967295 |
-| | Router (clients can reliably use this answer for this long without | |
-| | re-querying traffic router) | |
-+------+---------------------------------------------------------------------+-----------------------------------------------------+
-|rcode | The result code for the DNS answer provided by Traffic Router | One of NOERROR (success), NOTIMP (request is not |
-| | | NOTIMP (request is not supported), |
-| | | REFUSED (request is refused to be answered), or |
-| | | NXDOMAIN (the domain/name requested does not exist) |
-+------+---------------------------------------------------------------------+-----------------------------------------------------+
-
-.. _rl-tr-ngb:
-
-GeoLimit Failure Redirect feature
-=================================
-
-Overview
---------
-This feature is also called 'National GeoBlock' feature which is short for 'NGB' feature. In this section, the acronym 'NGB' will be used for this feature.
-
-In the past, if the Geolimit check fails (for example, the client ip is not in the 'US' region but the geolimit is set to 'CZF + US'), the router will return 503 response; but with this feature, when the check fails, it will return 302 if the redirect url is set in the delivery service.
-
-The Geolimit check failure has such scenarios:
-1) When the GeoLimit is set to 'CZF + only', if the client ip is not in the the CZ file, the check fails
-2) When the GeoLimit is set to any region, like 'CZF + US', if the client ip is not in such region, and the client ip is not in the CZ file, the check fails
-
-
-Configuration
--------------
-To enable the NGB feature, the DS must be configured with the proper redirect url. And the setting lays at 'Delivery Services'->Edit->'GeoLimit Redirect URL'. If no url is put in this field, the feature is disabled.
-
-The URL has 3 kinds of formats, which have different meanings:
-
-1. URL with no domain. If no domain is in the URL (like 'vod/dance.mp4'), the router will try to find a proper cache server within the delivery service and return the redirect url with the format like 'http://<cache server name>.<delivery service's FQDN>/<configured relative path>'
-
-2. URL with domain that matches with the delivery service. For this URL, the router will also try to find a proper cache server within the delivery service and return the same format url as point 1.
-
-3. URL with domain that doesn't match with the delivery service. For this URL, the router will return the configured url directly to the client.
-
-.. _rl-tr-steering:
-
-Steering feature
-================
-
-Overview
---------
-A Steering delivery service is a delivery service that is used to "steer" traffic to other delivery services. A Steering delivery service will have target delivery services configured for it with weights assigned to them. Traffic Router uses the weights to make a consistent hash ring which it then uses to make sure that requests are routed to a target based on the configured weights. This consistent hash ring is separate from the consistent hash ring used in cache selection.
-
-Special regular expressions called Filters can also be configured for target delivery services to pin traffic to a specific delivery service. For example, if a filter called .*/news/.* for a target called target-ds-1 is created, any requests to traffic router with 'news' in them will be routed to target-ds-1. This will happen regardless of the configured weights.
-
-A client can bypass the steering functionality by providing a header called X-TC-Steering-Option with the xml_id of the target delivery service to route to. When Traffic Router receives this header it will route to the requested target delivery service regardless of weight configuration.
-
-Some other points of interest:
-- Steering is currently only available for HTTP delivery services that are a part of the same CDN.
-- A new role called STEERING has been added to the traffic ops database. Only users with Admin or Steering privileges can modify steering assignments for a Delivery Service.
-- A new API has been created in Traffic Ops under /internal. This API is used by a Steering user to add filters and modify assignments. (Filters can only be added via the API).
-- Traffic Router uses the steering API in Traffic Ops to poll for steering assignments, the assignments are then used when routing traffic.
-
-A couple simple use cases for steering are:
-
-#. Migrating traffic from one delivery service to another over time.
-#. Trying out new functionality for a subset of traffic with an experimental delivery service.
-#. Load balancing between delivery services.
-
-
-
-Configuration
--------------
-
-The following needs to be completed for Steering to work correctly:
-
-#. Two target delivery services are created in Traffic Ops. They must both be HTTP delivery services part of the same CDN.
-#. A delivery service with type STEERING is created in Traffic Ops.
-#. Target delivery services are assigned to the steering delivery service using Traffic Ops.
-#. A user with the role of Steering is created.
-#. Using the API, the steering user assigns weights to the target delivery services.
-#. If desired, the steering user can create filters for the target delivery services.
-
-For more information see the `steering how-to guide <quick_howto/steering.html>`_.
-
-HTTPS for Http Type Delivery Services
-=====================================
-
-Starting with version 1.7 Traffic Router added the ability to allow https traffic between itself and clients on a per http type delivery service basis.
-
-.. Warning::
- The establishing of an HTTPS connection is much more computationally demanding than an HTTP connection.
- Since each client will in turn get redirected to ATS, Traffic Router is most always creating a new HTTPS connection for all HTTPS traffic.
- It is likely to mean that an existing Traffic Router will have some decrease in performance depending on the amount of https traffic you want to support
- As noted for DNSSEC, you may need to plan to scale Traffic Router vertically and/or horizontally to handle the new load
-
-The summary for setting up https is to:
-
-#. Select one of 'https', 'http and https', or 'http to https' for the delivery service
-#. Generate private keys for the delivery service using a wildcard domain such as ``*.my-delivery-service.my-cdn.example.com``
-#. Obtain and import signed certificate chain
-#. Snapshot CR Config
-
-Clients may make HTTPS requests delivery services only after Traffic Router receives the certificate chain from Traffic Ops and the new CR Config.
-
-Protocol Options
-----------------
-
-*https only*
- Traffic Router will only redirect (send a 302) to clients communicating with a secure connection, all other clients will receive a 503
-*http and https*
- Traffic Router will redirect both secure and non-secure clients
-*http to https*
- Traffic Router will redirect non-secure clients with a 302 and a location that is secure (i.e. starting with 'https' instead of 'http'), secure clients will remain on https
-*http*
- Any secure client will get an SSL handshake error. Non-secure clients will experience the same behavior as prior to 1.7
-
-Certificate Retrieval
----------------------
-
-.. Warning::
- If you have https delivery services in your CDN, Traffic Router will not accept **any** connections until it is able to
- fetch certificates from Traffic Ops and load them into memory. Traffic Router does not persist certificates to the java keystore or anywhere else.
-
-Traffic Router fetches certificates into memory:
-
-* At startup time
-* When it receives a new CR Config
-* Once an hour from whenever the most recent of the last of the above occurred
-
-.. Note::
- To adjust the frequency when Traffic Router fetches certificates add the parameter 'certificates.polling.interval' to CR Config and
- setting it to the desired time in milliseconds.
-
-.. Note::
- Taking a snapshot of CR Config may be used at times to avoid waiting the entire polling cycle for a new set of certificates.
-
-.. Warning::
- If a snapshot of CR Config is made that involves a delivery service missing its certificates, Traffic Router will ignore **ALL** changes in that CR-Config
- until one of the following occurs:
- * It receives certificates for that delivery service
- * Another snapshot of CR Config is created and the delivery service without certificates is changed so it's HTTP protocol is set to 'http'
-
-Certificate Chain Ordering
---------------------------
-
-The ordering of certificates within the certificate bundle matters. It must be:
-
-#. Primary Certificate (e.g. the one created for ``*.my-delivery-service.my-cdn.example.com``)
-#. Intermediate Certificate(s)
-#. Root Certificate from CA (optional)
-
-.. Warning::
- If something is wrong with the certificate chain (e.g. the order of the certificates is backwards or for the wrong domain) the
- client will get an SSL handshake. Inspection of /opt/tomcat/logs/catalina.out is likely to yield information to reveal this.
-
-To see the ordering of certificates you may have to manually split up your certificate chain and use openssl on each individual certificate
-
-Suggested Way of Setting up an HTTPS Delivery Service
------------------------------------------------------
-
-Do the following in Traffic Ops:
-
-#. Select one of 'https', 'http and https', or 'http to https' for the protocol field of a delivery service and click 'Save'.
-#. Click 'Manage SSL Keys'.
-#. Click 'Generate New Keys'.
-#. Copy the contents of the Certificate Signing Request field and save it locally.
-#. Click 'Load Keys'.
-#. Select 'http' for the protocol field of the delivery service and click 'Save' (to avoid preventing other CR Config updates from being blocked by Traffic Router)
-#. Follow your standard procedure for obtaining your signed certificate chain from a CA.
-#. After receiving your certificate chain import it into Traffic Ops.
-#. Edit the delivery service.
-#. Restore your original choice for the protocol field and click save.
-#. Click 'Manage SSL Keys'.
-#. Click 'Paste Existing Keys'.
-#. Paste the certificate chain into the CRT field.
-#. Click 'Load Keys'.
-#. Take a new snapshot of CR Config.
-
-Once this is done you should be able to test you are getting correctly redirected by Traffic Router using curl commands to https destinations on your delivery service.
-
-A new testing tool was created for load testing traffic router, it allows you to generate requests from your local box to multiple delivery services of a single cdn.
-You can control which cdn, delivery services, how many transactions per delivery service, and how many concurrent requests.
-During the test it will provide feedback about request latency and transactions per second.
-
-While it is running it is suggested that you monitor your Traffic Router nodes for memory and CPU utilization.
-
[44/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_vault.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_vault.rst.txt b/docs/latest/_sources/admin/traffic_vault.rst.txt
deleted file mode 100644
index 35be160..0000000
--- a/docs/latest/_sources/admin/traffic_vault.rst.txt
+++ /dev/null
@@ -1,195 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-****************************
-Traffic Vault Administration
-****************************
-Installing Traffic Vault
-========================
-In order to successfully store private keys you will need to install Riak.
-The latest version of Riak can be downloaded on the Riak `website <http://docs.basho.com/riak/latest/downloads/>`_.
-The installation instructions for Riak can be found `here <http://docs.basho.com/riak/latest/ops/building/installing/>`_.
-
-Production is currently running version 2.0.5 of Riak, but the latest version should suffice.
-
-
-Configuring Traffic Vault
-=========================
-The following steps were taken to configure Riak in our environments.
-
-Riak configuration file configuration
--------------------------------------
-
-The following steps need to be performed on each Riak server in the cluster:
-
-* Log into riak server as root
-
-* cd to /etc/riak/
-
-* Update the following in riak.conf to reflect your IP:
- - nodename = riak@a-host.sys.kabletown.net
- - listener.http.internal = a-host.sys.kabletown.net:8098 (can be 80 - This endpoint will not work with sec enabled)
- - listener.protobuf.internal = a-host.sys.kabletown.net:8087 (can be different port if you want)
- - listener.https.internal = a-host.sys.kabletown.net:8088 (can be 443)
-
-* Updated the following conf file to point to your cert files
- - ssl.certfile = /etc/riak/certs/server.crt
- - ssl.keyfile = /etc/riak/certs/server.key
- - ssl.cacertfile = /etc/pki/tls/certs/ca-bundle.crt
-
-* Add a line at the bottom of the config for tlsv1
- - tls_protocols.tlsv1 = on
-
-* Once the config file has been updated restart riak
- - ``/etc/init.d/riak restart``
-
-* Validate server is running by going to the following URL:
- - https://<serverHostname>:8088/ping
-
-Riak-admin configuration
--------------------------
-
-Riak-admin is a command line utility that needs to be run as root on a server in the riak cluster.
-
-Assumptions:
- * Riak 2.0.2 or greater is installed
- * SSL Certificates have been generated (signed or self-signed)
- * Root access to riak servers
-
-Add admin user and riakuser to riak
- * Admin user will be a super user
- * Riakuser will be the application user
-
-Login to one of the riak servers in the cluster as root (any will do)
-
- 1. Enable security
-
- ``riak-admin security enable``
-
- 2. Add groups
-
- ``riak-admin security add-group admins``
-
- ``riak-admin security add-group keysusers``
- 3. Add users
-
- .. Note:: username and password should be stored in /opt/traffic_ops/app/conf/<environment>/riak.conf
- ..
-
- ``riak-admin security add-user admin password=<AdminPassword> groups=admins``
-
- ``riak-admin security add-user riakuser password=<RiakUserPassword> groups=keysusers``
-
- 4. Grant access for admin and riakuser
-
- ``riak-admin security add-source riakuser 0.0.0.0/0 password``
-
- ``riak-admin security add-source admin 0.0.0.0/0 password``
-
- 5. Grant privs to admins for everything
-
- ``riak-admin security grant riak_kv.list_buckets,riak_kv.list_keys,riak_kv.get,riak_kv.put,riak_kv.delete on any to admins``
-
- 6. Grant privs to keysuser for ssl, dnssec, and url_sig_keys buckets only
-
- ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default ssl to keysusers``
-
- ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default dnssec to keysusers``
-
- ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default url_sig_keys to keysusers``
-
-.. seealso:: For more information on security in Riak, see the `Riak Security documentation <http://docs.basho.com/riak/2.0.4/ops/advanced/security/>`_.
-.. seealso:: For more information on authentication and authorization in Riak, see the `Riak Authentication and Authorization documentation <http://docs.basho.com/riak/2.0.4/ops/running/authz/>`_.
-
-
-Traffic Ops Configuration
--------------------------
-
-There are a couple configurations that are necessary in Traffic Ops.
-
-1. Database Updates
- * A new profile for Riak needs to be added to the profile table
- * A new type of Riak needs to be added to the type table
- * The servers in the Riak cluster need to be added to the server table
-
- .. Note:: profile and type data should be pre-loaded by seeds sql script.
- ..
-
-2. Configuration updates
- * /opt/traffic_ops/app/conf/<environment>/riak.conf needs to be updated to reflect the correct username and password for accessing riak.
-
-Configuring Riak Search
-=======================
-
-In order to more effectively support retrieval of SSL certificates by Traffic Router and Traffic Ops ORT, Traffic Vault uses `Riak search <http://docs.basho.com/riak/kv/latest/using/reference/search/>`_. Riak Search uses `Apache Solr <http://lucene.apache.org/solr>`_ for indexing and searching of records. The following explains how to enable, configure, and validate Riak Search.
-
-Riak Configuration
-------------------
-
-On Each Riak Server:
-
-1. If java is not already installed on your Riak server, install Java
- * To see if Java is already installed: ``java -version``
- * To install Java: ``yum install -y jdk``
-
-2. enable search in riak.conf
- * ``vim /etc/riak/riak.conf``
- * look for search and change ``search = off`` to ``search = on``
-
-3. Restart Riak so search is on
- * ``service riak restart``
-
-One time configuration:
-
-1. **On one of the Riak servers in the cluster run the following riak-admin commands**
-
-``riak-admin security grant search.admin on schema to admin``
-
-``riak-admin security grant search.admin on index to admin``
-
-``riak-admin security grant search.query on index to admin``
-
-``riak-admin security grant search.query on index sslkeys to admin``
-
-``riak-admin security grant search.query on index to riakuser``
-
-``riak-admin security grant search.query on index sslkeys to riakuser``
-
-``riak-admin security grant riak_core.set_bucket on any to admin``
-
-2. Add the search schema to Riak. This schema is a simple Apache Solr configuration file which will index all records on cdn, hostname, and deliveryservice.
- * Get the schema file by either cloning the project and going to `traffic_ops/app/config/misc/riak_search` or from `github <https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_ops/app/conf/misc/riak_search>`_.
- * Use curl to add the schema to riak: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/search/schema/sslkeys" -H 'Content-Type:application/xml' -d @sslkeys.xml``
-
-3. Add search index to Riak
- * run the following curl command: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/search/index/sslkeys" -H 'Content-Type: application/json' -d '{"schema":"sslkeys"}'``
-
-4. Associate the sslkeys index to the ssl bucket in Riak
- * run the following curl command: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/buckets/ssl/props" -H'content-type:application/json' -d'{"props":{"search_index":"sslkeys"}}'``
-
-Riak Search (using Apache Solr) will now index all NEW records that are added to the "ssl" bucket. The cdn, deliveryservice, and hostname fields are indexed and when a search is performed riak will return the indexed fields along with the crt and key values for a ssl record. In order to add the indexed fields to current records and to get the current records added, a standalone script needs to be run. The following explains how to run the script.
-
-1. Get script from github either by cloning the project and going to `traffic_ops/app/script` or from `here <https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_ops/app/script/update_riak_for_search.pl>`_
-2. Run the script by performing the following command ``./update_riak_for_search.pl -to_url=https://traffic-ops.kabletown.net -to_un=user -to_pw=password``
-
-Validate the search is working by querying against Riak directly:
-``curl -kvs "https://admin:password@riakserver:8088/search/query/sslkeys?wt=json&q=cdn:mycdn"``
-
-Validation can also be done by querying Traffic Ops:
-``curl -Lvs -H "Cookie: $COOKIE" https://traffic-ops.kabletown.net/api/1.2/cdns/name/mycdn/sslkeys.json``
-
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_vault.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_vault.txt b/docs/latest/_sources/admin/traffic_vault.txt
new file mode 100644
index 0000000..35be160
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_vault.txt
@@ -0,0 +1,195 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+****************************
+Traffic Vault Administration
+****************************
+Installing Traffic Vault
+========================
+In order to successfully store private keys you will need to install Riak.
+The latest version of Riak can be downloaded on the Riak `website <http://docs.basho.com/riak/latest/downloads/>`_.
+The installation instructions for Riak can be found `here <http://docs.basho.com/riak/latest/ops/building/installing/>`_.
+
+Production is currently running version 2.0.5 of Riak, but the latest version should suffice.
+
+
+Configuring Traffic Vault
+=========================
+The following steps were taken to configure Riak in our environments.
+
+Riak configuration file configuration
+-------------------------------------
+
+The following steps need to be performed on each Riak server in the cluster:
+
+* Log into riak server as root
+
+* cd to /etc/riak/
+
+* Update the following in riak.conf to reflect your IP:
+ - nodename = riak@a-host.sys.kabletown.net
+ - listener.http.internal = a-host.sys.kabletown.net:8098 (can be 80 - This endpoint will not work with sec enabled)
+ - listener.protobuf.internal = a-host.sys.kabletown.net:8087 (can be different port if you want)
+ - listener.https.internal = a-host.sys.kabletown.net:8088 (can be 443)
+
+* Updated the following conf file to point to your cert files
+ - ssl.certfile = /etc/riak/certs/server.crt
+ - ssl.keyfile = /etc/riak/certs/server.key
+ - ssl.cacertfile = /etc/pki/tls/certs/ca-bundle.crt
+
+* Add a line at the bottom of the config for tlsv1
+ - tls_protocols.tlsv1 = on
+
+* Once the config file has been updated restart riak
+ - ``/etc/init.d/riak restart``
+
+* Validate server is running by going to the following URL:
+ - https://<serverHostname>:8088/ping
+
+Riak-admin configuration
+-------------------------
+
+Riak-admin is a command line utility that needs to be run as root on a server in the riak cluster.
+
+Assumptions:
+ * Riak 2.0.2 or greater is installed
+ * SSL Certificates have been generated (signed or self-signed)
+ * Root access to riak servers
+
+Add admin user and riakuser to riak
+ * Admin user will be a super user
+ * Riakuser will be the application user
+
+Login to one of the riak servers in the cluster as root (any will do)
+
+ 1. Enable security
+
+ ``riak-admin security enable``
+
+ 2. Add groups
+
+ ``riak-admin security add-group admins``
+
+ ``riak-admin security add-group keysusers``
+ 3. Add users
+
+ .. Note:: username and password should be stored in /opt/traffic_ops/app/conf/<environment>/riak.conf
+ ..
+
+ ``riak-admin security add-user admin password=<AdminPassword> groups=admins``
+
+ ``riak-admin security add-user riakuser password=<RiakUserPassword> groups=keysusers``
+
+ 4. Grant access for admin and riakuser
+
+ ``riak-admin security add-source riakuser 0.0.0.0/0 password``
+
+ ``riak-admin security add-source admin 0.0.0.0/0 password``
+
+ 5. Grant privs to admins for everything
+
+ ``riak-admin security grant riak_kv.list_buckets,riak_kv.list_keys,riak_kv.get,riak_kv.put,riak_kv.delete on any to admins``
+
+ 6. Grant privs to keysuser for ssl, dnssec, and url_sig_keys buckets only
+
+ ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default ssl to keysusers``
+
+ ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default dnssec to keysusers``
+
+ ``riak-admin security grant riak_kv.get,riak_kv.put,riak_kv.delete on default url_sig_keys to keysusers``
+
+.. seealso:: For more information on security in Riak, see the `Riak Security documentation <http://docs.basho.com/riak/2.0.4/ops/advanced/security/>`_.
+.. seealso:: For more information on authentication and authorization in Riak, see the `Riak Authentication and Authorization documentation <http://docs.basho.com/riak/2.0.4/ops/running/authz/>`_.
+
+
+Traffic Ops Configuration
+-------------------------
+
+There are a couple configurations that are necessary in Traffic Ops.
+
+1. Database Updates
+ * A new profile for Riak needs to be added to the profile table
+ * A new type of Riak needs to be added to the type table
+ * The servers in the Riak cluster need to be added to the server table
+
+ .. Note:: profile and type data should be pre-loaded by seeds sql script.
+ ..
+
+2. Configuration updates
+ * /opt/traffic_ops/app/conf/<environment>/riak.conf needs to be updated to reflect the correct username and password for accessing riak.
+
+Configuring Riak Search
+=======================
+
+In order to more effectively support retrieval of SSL certificates by Traffic Router and Traffic Ops ORT, Traffic Vault uses `Riak search <http://docs.basho.com/riak/kv/latest/using/reference/search/>`_. Riak Search uses `Apache Solr <http://lucene.apache.org/solr>`_ for indexing and searching of records. The following explains how to enable, configure, and validate Riak Search.
+
+Riak Configuration
+------------------
+
+On Each Riak Server:
+
+1. If java is not already installed on your Riak server, install Java
+ * To see if Java is already installed: ``java -version``
+ * To install Java: ``yum install -y jdk``
+
+2. enable search in riak.conf
+ * ``vim /etc/riak/riak.conf``
+ * look for search and change ``search = off`` to ``search = on``
+
+3. Restart Riak so search is on
+ * ``service riak restart``
+
+One time configuration:
+
+1. **On one of the Riak servers in the cluster run the following riak-admin commands**
+
+``riak-admin security grant search.admin on schema to admin``
+
+``riak-admin security grant search.admin on index to admin``
+
+``riak-admin security grant search.query on index to admin``
+
+``riak-admin security grant search.query on index sslkeys to admin``
+
+``riak-admin security grant search.query on index to riakuser``
+
+``riak-admin security grant search.query on index sslkeys to riakuser``
+
+``riak-admin security grant riak_core.set_bucket on any to admin``
+
+2. Add the search schema to Riak. This schema is a simple Apache Solr configuration file which will index all records on cdn, hostname, and deliveryservice.
+ * Get the schema file by either cloning the project and going to `traffic_ops/app/config/misc/riak_search` or from `github <https://github.com/apache/incubator-trafficcontrol/tree/master/traffic_ops/app/conf/misc/riak_search>`_.
+ * Use curl to add the schema to riak: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/search/schema/sslkeys" -H 'Content-Type:application/xml' -d @sslkeys.xml``
+
+3. Add search index to Riak
+ * run the following curl command: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/search/index/sslkeys" -H 'Content-Type: application/json' -d '{"schema":"sslkeys"}'``
+
+4. Associate the sslkeys index to the ssl bucket in Riak
+ * run the following curl command: ``curl -kvs -XPUT "https://admin:pass@riakserver:8088/buckets/ssl/props" -H'content-type:application/json' -d'{"props":{"search_index":"sslkeys"}}'``
+
+Riak Search (using Apache Solr) will now index all NEW records that are added to the "ssl" bucket. The cdn, deliveryservice, and hostname fields are indexed and when a search is performed riak will return the indexed fields along with the crt and key values for a ssl record. In order to add the indexed fields to current records and to get the current records added, a standalone script needs to be run. The following explains how to run the script.
+
+1. Get script from github either by cloning the project and going to `traffic_ops/app/script` or from `here <https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_ops/app/script/update_riak_for_search.pl>`_
+2. Run the script by performing the following command ``./update_riak_for_search.pl -to_url=https://traffic-ops.kabletown.net -to_un=user -to_pw=password``
+
+Validate the search is working by querying against Riak directly:
+``curl -kvs "https://admin:password@riakserver:8088/search/query/sslkeys?wt=json&q=cdn:mycdn"``
+
+Validation can also be done by querying Traffic Ops:
+``curl -Lvs -H "Cookie: $COOKIE" https://traffic-ops.kabletown.net/api/1.2/cdns/name/mycdn/sslkeys.json``
+
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/cache_revalidation.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/cache_revalidation.rst.txt b/docs/latest/_sources/basics/cache_revalidation.rst.txt
deleted file mode 100644
index dc57346..0000000
--- a/docs/latest/_sources/basics/cache_revalidation.rst.txt
+++ /dev/null
@@ -1,71 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. index::
- Cache Control Header
- Revalidation
- HTTP 304
-
-Cache Control Headers and Revalidation
-======================================
-The `HTTP/1.1 spec <https://www.ietf.org/rfc/rfc2616.txt>`_ allows for origin servers and clients to influence how caches treat their requests and responses. By default, the Traffic Control CDN will honor cache control headers. Most commonly, origin servers will tell the downstream caches how long a response can be cached::
-
- HTTP/1.1 200 OK
- Date: Sun, 14 Dec 2014 23:22:44 GMT
- Server: Apache/2.2.15 (Red Hat)
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Cache-Control: max-age=86400
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
-
- <html><body>This is a fun file</body></html>
-
-In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a ``Expires:`` header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn't get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache *revalidates* the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a ``200 OK`` response, with the new data. If it has not changed, the origin server will send back a ``304 Not Modified`` response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an ``If-Not-Modifie
d-Since:`` header, or an ``If-None-Match:`` header. For example, in the ``If-None-Match:`` case, the origin will send and ``ETag`` header that uniquely identifies the response. The client can use that in an revalidation request like::
-
- GET /foo/bar/fun.html HTTP/1.1
- If-None-Match: "1aa008f-2d-50a3559482cc0"
- Host: www.origin.com
-
-If the content has changed (meaning, the new response would not have had the same ETag) it will respond with ``200 OK``, like::
-
- HTTP/1.1 200 OK
- Date: Sun, 18 Dec 2014 3:22:44 GMT
- Server: Apache/2.2.15 (Red Hat)
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50aa00feadd"
- Cache-Control: max-age=604800
- Content-Length: 49
- Connection: close
- Content-Type: text/html; charset=UTF-8
-
- <html><body>This is NOT a fun file</body></html>
-
-
-If the Content did not change (meaning, the response would have had the same ETag) it will respond with ``304 Not Modified``, like::
-
- 304 Not Modified
- Date: Sun, 18 Dec 2014 3:22:44 GMT
- Server: Apache/2.2.15 (Red Hat)
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Cache-Control: max-age=604800
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
-
-Note that the 304 response only has headers, not the data.
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/cache_revalidation.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/cache_revalidation.txt b/docs/latest/_sources/basics/cache_revalidation.txt
new file mode 100644
index 0000000..dc57346
--- /dev/null
+++ b/docs/latest/_sources/basics/cache_revalidation.txt
@@ -0,0 +1,71 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. index::
+ Cache Control Header
+ Revalidation
+ HTTP 304
+
+Cache Control Headers and Revalidation
+======================================
+The `HTTP/1.1 spec <https://www.ietf.org/rfc/rfc2616.txt>`_ allows for origin servers and clients to influence how caches treat their requests and responses. By default, the Traffic Control CDN will honor cache control headers. Most commonly, origin servers will tell the downstream caches how long a response can be cached::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Cache-Control: max-age=86400
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is a fun file</body></html>
+
+In the above response, the origin server tells downstream caching systems that the maximum time to cache this response for is 86400 seconds. The origin can also add a ``Expires:`` header, explicitly telling the cache the time this response is to be expired. When a response is expired it usually doesn't get deleted from the cache, but, when a request comes in that would have hit on this response if it was not expired, the cache *revalidates* the response. In stead of requesting the object again from the origin server, the cache will send a request to the origin indicating what version of the response it has, and asking if it has changed. If it changed, the server will send a ``200 OK`` response, with the new data. If it has not changed, the origin server will send back a ``304 Not Modified`` response indicating the response is still valid, and that the cache can reset the timer on the response expiration. To indicate what version the client (cache) has it will add an ``If-Not-Modifie
d-Since:`` header, or an ``If-None-Match:`` header. For example, in the ``If-None-Match:`` case, the origin will send and ``ETag`` header that uniquely identifies the response. The client can use that in an revalidation request like::
+
+ GET /foo/bar/fun.html HTTP/1.1
+ If-None-Match: "1aa008f-2d-50a3559482cc0"
+ Host: www.origin.com
+
+If the content has changed (meaning, the new response would not have had the same ETag) it will respond with ``200 OK``, like::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 18 Dec 2014 3:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50aa00feadd"
+ Cache-Control: max-age=604800
+ Content-Length: 49
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is NOT a fun file</body></html>
+
+
+If the Content did not change (meaning, the response would have had the same ETag) it will respond with ``304 Not Modified``, like::
+
+ 304 Not Modified
+ Date: Sun, 18 Dec 2014 3:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Cache-Control: max-age=604800
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+Note that the 304 response only has headers, not the data.
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/caching_proxies.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/caching_proxies.rst.txt b/docs/latest/_sources/basics/caching_proxies.rst.txt
deleted file mode 100644
index af93730..0000000
--- a/docs/latest/_sources/basics/caching_proxies.rst.txt
+++ /dev/null
@@ -1,238 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. |arrow| image:: fwda.png
-
-.. _rl-caching_proxy:
-
-Caching Proxies
-===============
-The main function of a CDN is to proxy requests from clients to origin servers
-and cache the results.
-To proxy, in the CDN context, is to obtain content using HTTP from an origin
-server on behalf of a client. To cache is to store the results so they can be
-reused when other clients are requesting the same content. There are three
-types of proxies in use on the Internet today which are described below.
-
-.. index::
- Reverse Proxy
-
-.. _rl-rev-proxy:
-
-|arrow| Reverse Proxy
----------------------
- A reverse proxy acts on behalf of the origin server. The client is mostly unaware it is communicating with a proxy and not the actual origin.
- All EDGE caches in a Traffic Control CDN are reverse proxies.
- To the end user a Traffic Control based CDN appears as a reverse proxy since
- it retrieves content from the origin server, acting on behalf of that origin server. The client requests a URL that has
- a hostname which resolves to the reverse proxy's IP address and, in compliance
- with the HTTP 1.1 specification, the client sends a ``Host:`` header to the reverse
- proxy that matches the hostname in the URL.
- The proxy looks up this hostname in a
- list of mappings to find the origin hostname; if the hostname of the Host header is not found in the list,
- the proxy will send an error (``404 Not Found``) to the client.
- If the supplied hostname is found in this list of mappings, the proxy checks the cache, and when the content is not already present, connects to the
- origin the requested ``Host:`` maps to and requests the path of the original URL, providing the origin hostname in the ``Host`` header. The proxy then stores the URL in cache and serves the contents to the client. When there are subsequent requests for
- the same URL, a caching proxy serves the content out of cache thereby reducing
- latency and network traffic.
-
-.. seealso:: `ATS documentation on reverse proxy <https://docs.trafficserver.apache.org/en/latest/admin/reverse-proxy-http-redirects.en.html#http-reverse-proxy>`_.
-
-To insert a reverse proxy into the previous HTTP 1.1 example, the reverse proxy requires provisioning
-for ``www.origin.com``. By adding a remap rule to the cache, the reverse proxy then maps requests to
-this origin. The content owner must inform the clients, by updating the URL, to receive the content
-from the cache and not from the origin server directly. For this example, the remap rule on the
-cache is: ``http://www-origin-cache.cdn.com http://www.origin.com``.
-
-.. Note:: In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.
-
-::
-
- HTTP/1.1 200 OK
- Date: Sun, 14 Dec 2014 23:22:44 GMT
- Server: Apache/2.2.15 (Red Hat)
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
-
- <html><body>This is a fun file</body></html>
-
-The client is given the URL ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` (note the different hostname) and when attempting to obtain that URL, the following occurs:
-
-1. The client sends a request to the LDNS server to resolve the name ``www-origin-cache.cdn.com`` to an IPv4 address.
-
-2. Similar to the previous case, the LDNS server resolves the name ``www-origin-cache.cdn.com`` to an IPv4 address, in this example, this address is 55.44.33.22.
-
-3. The client opens a TCP connection from a random port locally, to port 80 (the HTTP default) on 55.44.33.22, and sends the following: ::
-
- GET /foo/bar/fun.html HTTP/1.1
- Host: www-origin-cache.cdn.com
-
-4. The reverse proxy looks up ``www-origin-cache.cdn.com`` in its remap rules, and finds the origin is ``www.origin.com``.
-
-5. The proxy checks its cache to see if the response for ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` is already in the cache.
-
-6a. If the response is not in the cache:
-
- 1. The proxy uses DNS to get the IPv4 address for ``www.origin.com``, connect to it on port 80, and sends: ::
-
- GET /foo/bar/fun.html HTTP/1.1
- Host: www.origin.com
-
- 2. The origin server responds with the headers and content as shown: ::
-
- HTTP/1.1 200 OK
- Date: Sun, 14 Dec 2014 23:22:44 GMT
- Server: Apache/2.2.15 (Red Hat)
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
-
- <html><body>This is a fun file</body></html>
-
- 3. The proxy sends the origin response on to the client adding a ``Via:`` header (and maybe others): ::
-
- HTTP/1.1 200 OK
- Date: Sun, 14 Dec 2014 23:22:44 GMT
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
- Age: 0
- Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
- Server: ATS/4.2.1
-
- <html><body>This is a fun file</body></html>
-
-6b. If it *is* in the cache:
-
- The proxy responds to the client with the previously retrieved result: ::
-
- HTTP/1.1 200 OK
- Date: Sun, 14 Dec 2014 23:22:44 GMT
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
- Age: 39711
- Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
- Server: ATS/4.2.1
-
- <html><body>This is a fun file</body></html>
-
-
-.. index::
- Forward Proxy
-
-.. _rl-fwd-proxy:
-
-|arrow| Forward Proxy
----------------------
- A forward proxy acts on behalf of the client. The origin server is mostly
- unaware of the proxy, the client requests the proxy to retrieve content from a
- particular origin server. All MID caches in a Traffic Control based CDN are
- forward proxies. In a forward proxy scenario, the client is explicitely configured to use the
- the proxy's IP address and port as a forward proxy. The client always connects to the forward
- proxy for content. The content provider does not have to change the URL the
- client obtains, and is unaware of the proxy in the middle.
-
-.. seealso:: `ATS documentation on forward proxy <https://docs.trafficserver.apache.org/en/latest/admin/forward-proxy.en.html>`_.
-
-Below is an example of the client retrieving the URL ``http://www.origin.com/foo/bar/fun.html`` through a forward proxy:
-
-1. The client requires configuration to use the proxy, as opposed to the reverse proxy example. Assume the client configuration is through preferences entries or other to use the proxy IP address 99.88.77.66 and proxy port 8080.
-
-2. To retrieve ``http://www.origin.com/foo/bar/fun.html`` URL, the client connects to 99.88.77.66 on port 8080 and sends:
-
- ::
-
- GET http://www.origin.com/foo/bar/fun.html HTTP/1.1
-
-
- .. Note:: In this case, the client places the entire URL after GET, including protocol and hostname (``http://www.origin.com``), but in the reverse proxy and direct-to-origin case it puts only the path portion of the URL (``/foo/bar/fun.html``) after the GET.
-
-3. The proxy verifies whether the response for ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` is already in the cache.
-
-4a. If it is not in the cache:
-
- 1. The proxy uses DNS to obtain the IPv4 address for ``www.origin.com``, connects to it on port 80, and sends: ::
-
-
- GET /foo/bar/fun.html HTTP/1.1
- Host: www.origin.com
-
-
- 2. The origin server responds with the headers and content as shown below: ::
-
-
- HTTP/1.1 200 OK
- Date: Sun, 14 Dec 2014 23:22:44 GMT
- Server: Apache/2.2.15 (Red Hat)
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
-
- <html><body>This is a fun file</body></html>
-
-
- 3. The proxy sends this on to the client adding a ``Via:`` header (and maybe others): ::
-
- HTTP/1.1 200 OK
- Date: Sun, 14 Dec 2014 23:22:44 GMT
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
- Age: 0
- Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
- Server: ATS/4.2.1
-
- <html><body>This is a fun file</body></html>
-
-
-4b. If it *is* in the cache:
-
- The proxy responds to the client with the previously retrieved result: ::
-
- HTTP/1.1 200 OK
- Date: Sun, 14 Dec 2014 23:22:44 GMT
- Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
- ETag: "1aa008f-2d-50a3559482cc0"
- Content-Length: 45
- Connection: close
- Content-Type: text/html; charset=UTF-8
- Age: 99711
- Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
- Server: ATS/4.2.1
-
- <html><body>This is a fun file</body></html>
-
-.. index::
- Transparent Proxy
-
-|arrow| Transparent Proxy
--------------------------
- Neither the origin nor the client are aware of the actions performed by the transparent proxies. A Traffic Control based CDN does not use transparent proxies. If you are interested you can learn more about transparent proxies on `wikipedia <http://en.wikipedia.org/wiki/Proxy_server#Transparent_proxy>`_.
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/caching_proxies.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/caching_proxies.txt b/docs/latest/_sources/basics/caching_proxies.txt
new file mode 100644
index 0000000..af93730
--- /dev/null
+++ b/docs/latest/_sources/basics/caching_proxies.txt
@@ -0,0 +1,238 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. |arrow| image:: fwda.png
+
+.. _rl-caching_proxy:
+
+Caching Proxies
+===============
+The main function of a CDN is to proxy requests from clients to origin servers
+and cache the results.
+To proxy, in the CDN context, is to obtain content using HTTP from an origin
+server on behalf of a client. To cache is to store the results so they can be
+reused when other clients are requesting the same content. There are three
+types of proxies in use on the Internet today which are described below.
+
+.. index::
+ Reverse Proxy
+
+.. _rl-rev-proxy:
+
+|arrow| Reverse Proxy
+---------------------
+ A reverse proxy acts on behalf of the origin server. The client is mostly unaware it is communicating with a proxy and not the actual origin.
+ All EDGE caches in a Traffic Control CDN are reverse proxies.
+ To the end user a Traffic Control based CDN appears as a reverse proxy since
+ it retrieves content from the origin server, acting on behalf of that origin server. The client requests a URL that has
+ a hostname which resolves to the reverse proxy's IP address and, in compliance
+ with the HTTP 1.1 specification, the client sends a ``Host:`` header to the reverse
+ proxy that matches the hostname in the URL.
+ The proxy looks up this hostname in a
+ list of mappings to find the origin hostname; if the hostname of the Host header is not found in the list,
+ the proxy will send an error (``404 Not Found``) to the client.
+ If the supplied hostname is found in this list of mappings, the proxy checks the cache, and when the content is not already present, connects to the
+ origin the requested ``Host:`` maps to and requests the path of the original URL, providing the origin hostname in the ``Host`` header. The proxy then stores the URL in cache and serves the contents to the client. When there are subsequent requests for
+ the same URL, a caching proxy serves the content out of cache thereby reducing
+ latency and network traffic.
+
+.. seealso:: `ATS documentation on reverse proxy <https://docs.trafficserver.apache.org/en/latest/admin/reverse-proxy-http-redirects.en.html#http-reverse-proxy>`_.
+
+To insert a reverse proxy into the previous HTTP 1.1 example, the reverse proxy requires provisioning
+for ``www.origin.com``. By adding a remap rule to the cache, the reverse proxy then maps requests to
+this origin. The content owner must inform the clients, by updating the URL, to receive the content
+from the cache and not from the origin server directly. For this example, the remap rule on the
+cache is: ``http://www-origin-cache.cdn.com http://www.origin.com``.
+
+.. Note:: In the previous example minimal headers were shown on both the request and response. In the examples that follow, the origin server response is more realistic.
+
+::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is a fun file</body></html>
+
+The client is given the URL ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` (note the different hostname) and when attempting to obtain that URL, the following occurs:
+
+1. The client sends a request to the LDNS server to resolve the name ``www-origin-cache.cdn.com`` to an IPv4 address.
+
+2. Similar to the previous case, the LDNS server resolves the name ``www-origin-cache.cdn.com`` to an IPv4 address, in this example, this address is 55.44.33.22.
+
+3. The client opens a TCP connection from a random port locally, to port 80 (the HTTP default) on 55.44.33.22, and sends the following: ::
+
+ GET /foo/bar/fun.html HTTP/1.1
+ Host: www-origin-cache.cdn.com
+
+4. The reverse proxy looks up ``www-origin-cache.cdn.com`` in its remap rules, and finds the origin is ``www.origin.com``.
+
+5. The proxy checks its cache to see if the response for ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` is already in the cache.
+
+6a. If the response is not in the cache:
+
+ 1. The proxy uses DNS to get the IPv4 address for ``www.origin.com``, connect to it on port 80, and sends: ::
+
+ GET /foo/bar/fun.html HTTP/1.1
+ Host: www.origin.com
+
+ 2. The origin server responds with the headers and content as shown: ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is a fun file</body></html>
+
+ 3. The proxy sends the origin response on to the client adding a ``Via:`` header (and maybe others): ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+ Age: 0
+ Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+ Server: ATS/4.2.1
+
+ <html><body>This is a fun file</body></html>
+
+6b. If it *is* in the cache:
+
+ The proxy responds to the client with the previously retrieved result: ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+ Age: 39711
+ Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+ Server: ATS/4.2.1
+
+ <html><body>This is a fun file</body></html>
+
+
+.. index::
+ Forward Proxy
+
+.. _rl-fwd-proxy:
+
+|arrow| Forward Proxy
+---------------------
+ A forward proxy acts on behalf of the client. The origin server is mostly
+ unaware of the proxy, the client requests the proxy to retrieve content from a
+ particular origin server. All MID caches in a Traffic Control based CDN are
+ forward proxies. In a forward proxy scenario, the client is explicitely configured to use the
+ the proxy's IP address and port as a forward proxy. The client always connects to the forward
+ proxy for content. The content provider does not have to change the URL the
+ client obtains, and is unaware of the proxy in the middle.
+
+.. seealso:: `ATS documentation on forward proxy <https://docs.trafficserver.apache.org/en/latest/admin/forward-proxy.en.html>`_.
+
+Below is an example of the client retrieving the URL ``http://www.origin.com/foo/bar/fun.html`` through a forward proxy:
+
+1. The client requires configuration to use the proxy, as opposed to the reverse proxy example. Assume the client configuration is through preferences entries or other to use the proxy IP address 99.88.77.66 and proxy port 8080.
+
+2. To retrieve ``http://www.origin.com/foo/bar/fun.html`` URL, the client connects to 99.88.77.66 on port 8080 and sends:
+
+ ::
+
+ GET http://www.origin.com/foo/bar/fun.html HTTP/1.1
+
+
+ .. Note:: In this case, the client places the entire URL after GET, including protocol and hostname (``http://www.origin.com``), but in the reverse proxy and direct-to-origin case it puts only the path portion of the URL (``/foo/bar/fun.html``) after the GET.
+
+3. The proxy verifies whether the response for ``http://www-origin-cache.cdn.com/foo/bar/fun.html`` is already in the cache.
+
+4a. If it is not in the cache:
+
+ 1. The proxy uses DNS to obtain the IPv4 address for ``www.origin.com``, connects to it on port 80, and sends: ::
+
+
+ GET /foo/bar/fun.html HTTP/1.1
+ Host: www.origin.com
+
+
+ 2. The origin server responds with the headers and content as shown below: ::
+
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Server: Apache/2.2.15 (Red Hat)
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+
+ <html><body>This is a fun file</body></html>
+
+
+ 3. The proxy sends this on to the client adding a ``Via:`` header (and maybe others): ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+ Age: 0
+ Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+ Server: ATS/4.2.1
+
+ <html><body>This is a fun file</body></html>
+
+
+4b. If it *is* in the cache:
+
+ The proxy responds to the client with the previously retrieved result: ::
+
+ HTTP/1.1 200 OK
+ Date: Sun, 14 Dec 2014 23:22:44 GMT
+ Last-Modified: Sun, 14 Dec 2014 23:18:51 GMT
+ ETag: "1aa008f-2d-50a3559482cc0"
+ Content-Length: 45
+ Connection: close
+ Content-Type: text/html; charset=UTF-8
+ Age: 99711
+ Via: http/1.1 cache01.cdn.kabletown.net (ApacheTrafficServer/4.2.1 [uScSsSfUpSeN:t cCSi p sS])
+ Server: ATS/4.2.1
+
+ <html><body>This is a fun file</body></html>
+
+.. index::
+ Transparent Proxy
+
+|arrow| Transparent Proxy
+-------------------------
+ Neither the origin nor the client are aware of the actions performed by the transparent proxies. A Traffic Control based CDN does not use transparent proxies. If you are interested you can learn more about transparent proxies on `wikipedia <http://en.wikipedia.org/wiki/Proxy_server#Transparent_proxy>`_.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/content_delivery_networks.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/content_delivery_networks.rst.txt b/docs/latest/_sources/basics/content_delivery_networks.rst.txt
deleted file mode 100644
index 872018e..0000000
--- a/docs/latest/_sources/basics/content_delivery_networks.rst.txt
+++ /dev/null
@@ -1,40 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. index::
- Log File Analysis
- CDN
- Content Delivery Network
-
-Content Delivery Networks
-=========================
-The vast majority of today's Internet traffic is media files (often video or audio) being sent from a single source (the *Content Provider*) to many thousands or even millions of destinations (the *Content Consumers*). Content Delivery Networks are the technology that make that one-to-many distribution possible in an economical way. A Content Delivery Network (CDN) is a distributed system of servers for delivering content over HTTP. These servers are deployed in multiple locations with the goal of optimizing the delivery of content to the end users, while minimizing the traffic on the network. A CDN typically consists of the following:
-
-* **Caching Proxies**
- The proxy (cache or caching proxy) is a server that both proxies the requests and caches the results for reusing.
-
-* **Content Router**
- The Content Router ensures that the end user is connected to the optimal cache for the location of the end user and content availability.
-
-* **Health Protocol**
- The Health Protocol monitors the usage of the caches and tenants in the CDN.
-
-* **Configuration Management System**
- In many cases a CDN encompasses hundreds of servers across a large geographic area. The Configuration Management System allows an operator to manage these servers.
-
-* **Log File Analysis System**
- Every transaction in the CDN gets logged. The Log File Analysis System aggregates all of the log entries from all of the servers to a central location for analysis and troubleshooting.
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/content_delivery_networks.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/content_delivery_networks.txt b/docs/latest/_sources/basics/content_delivery_networks.txt
new file mode 100644
index 0000000..872018e
--- /dev/null
+++ b/docs/latest/_sources/basics/content_delivery_networks.txt
@@ -0,0 +1,40 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. index::
+ Log File Analysis
+ CDN
+ Content Delivery Network
+
+Content Delivery Networks
+=========================
+The vast majority of today's Internet traffic is media files (often video or audio) being sent from a single source (the *Content Provider*) to many thousands or even millions of destinations (the *Content Consumers*). Content Delivery Networks are the technology that make that one-to-many distribution possible in an economical way. A Content Delivery Network (CDN) is a distributed system of servers for delivering content over HTTP. These servers are deployed in multiple locations with the goal of optimizing the delivery of content to the end users, while minimizing the traffic on the network. A CDN typically consists of the following:
+
+* **Caching Proxies**
+ The proxy (cache or caching proxy) is a server that both proxies the requests and caches the results for reusing.
+
+* **Content Router**
+ The Content Router ensures that the end user is connected to the optimal cache for the location of the end user and content availability.
+
+* **Health Protocol**
+ The Health Protocol monitors the usage of the caches and tenants in the CDN.
+
+* **Configuration Management System**
+ In many cases a CDN encompasses hundreds of servers across a large geographic area. The Configuration Management System allows an operator to manage these servers.
+
+* **Log File Analysis System**
+ Every transaction in the CDN gets logged. The Log File Analysis System aggregates all of the log entries from all of the servers to a central location for analysis and troubleshooting.
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/http_11.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/http_11.rst.txt b/docs/latest/_sources/basics/http_11.rst.txt
deleted file mode 100644
index 65d6d71..0000000
--- a/docs/latest/_sources/basics/http_11.rst.txt
+++ /dev/null
@@ -1,48 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. index::
- http/1.1
- HTTP
-
-HTTP 1.1
-========
-For a comprehensive look at Traffic Control, it is important to understand basic HTTP 1.1 protocol operations and how caches function. The example below illustrates the fulfillment of an HTTP 1.1 request in a situation without CDN or proxy, followed by viewing the changes after inserting different types of (caching) proxies. Several of the examples below are simplified for clarification of the essentials.
-
-For complete details on HTTP 1.1 see `RFC 2616 - Hypertext Transfer Protocol -- HTTP/1.1 <https://www.ietf.org/rfc/rfc2616.txt>`_.
-
-Below are the steps of a client retrieving the URL ``http://www.origin.com/foo/bar/fun.html`` using HTTP/1.1 without proxies:
-
-1. The client sends a request to the Local DNS (LDNS) server to resolve the name ``www.origin.com`` to an IPv4 address.
-
-2. If the LDNS does not have this name (IPv4 mapping cached), it sends DNS requests to the ., .com, and .origin.com authoritative servers until it receives a response with the address for ``www.origin.com``. Per the DNS SPEC, this response has a Time To Live (TTL), which indicates how long this mapping can be cached at the LDNS server. In the example, the IP address found by the LDNS server for www.origin.com is 44.33.22.11.
-
- .. Note:: While longer DNS TTLs of a day (86400 seconds) or more are quite common in other use cases, in CDN use cases DNS TTLs are often below a minute.
-
-3. The client opens a TCP connection from a random port locally to port 80 (the HTTP default) on 44.33.22.11, and sends this (showing the minimum HTTP 1.1 request, typically there are additional headers): ::
-
- GET /foo/bar/fun.html HTTP/1.1
- Host: www.origin.com
-
-4. The server at ``www.origin.com`` looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path ``/foo/bar/fun.html``, in the example, this is a file that contains ``<html><body>This is a fun file</body></html>``, so the server responds with the following: ::
-
-
- HTTP/1.1 200 OK
- Content-Type: text/html; charset=UTF-8
- Content-Length: 45
-
- <html><body>This is a fun file</body></html>
-
- At this point, HTTP transaction is complete.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/http_11.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/http_11.txt b/docs/latest/_sources/basics/http_11.txt
new file mode 100644
index 0000000..65d6d71
--- /dev/null
+++ b/docs/latest/_sources/basics/http_11.txt
@@ -0,0 +1,48 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. index::
+ http/1.1
+ HTTP
+
+HTTP 1.1
+========
+For a comprehensive look at Traffic Control, it is important to understand basic HTTP 1.1 protocol operations and how caches function. The example below illustrates the fulfillment of an HTTP 1.1 request in a situation without CDN or proxy, followed by viewing the changes after inserting different types of (caching) proxies. Several of the examples below are simplified for clarification of the essentials.
+
+For complete details on HTTP 1.1 see `RFC 2616 - Hypertext Transfer Protocol -- HTTP/1.1 <https://www.ietf.org/rfc/rfc2616.txt>`_.
+
+Below are the steps of a client retrieving the URL ``http://www.origin.com/foo/bar/fun.html`` using HTTP/1.1 without proxies:
+
+1. The client sends a request to the Local DNS (LDNS) server to resolve the name ``www.origin.com`` to an IPv4 address.
+
+2. If the LDNS does not have this name (IPv4 mapping cached), it sends DNS requests to the ., .com, and .origin.com authoritative servers until it receives a response with the address for ``www.origin.com``. Per the DNS SPEC, this response has a Time To Live (TTL), which indicates how long this mapping can be cached at the LDNS server. In the example, the IP address found by the LDNS server for www.origin.com is 44.33.22.11.
+
+ .. Note:: While longer DNS TTLs of a day (86400 seconds) or more are quite common in other use cases, in CDN use cases DNS TTLs are often below a minute.
+
+3. The client opens a TCP connection from a random port locally to port 80 (the HTTP default) on 44.33.22.11, and sends this (showing the minimum HTTP 1.1 request, typically there are additional headers): ::
+
+ GET /foo/bar/fun.html HTTP/1.1
+ Host: www.origin.com
+
+4. The server at ``www.origin.com`` looks up the Host: header to match that to a configuration section, usually referred to as a virtual host section. If the Host: header and configuration section match, the search continues for the content of the path ``/foo/bar/fun.html``, in the example, this is a file that contains ``<html><body>This is a fun file</body></html>``, so the server responds with the following: ::
+
+
+ HTTP/1.1 200 OK
+ Content-Type: text/html; charset=UTF-8
+ Content-Length: 45
+
+ <html><body>This is a fun file</body></html>
+
+ At this point, HTTP transaction is complete.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/index.rst.txt b/docs/latest/_sources/basics/index.rst.txt
deleted file mode 100644
index 23ee1da..0000000
--- a/docs/latest/_sources/basics/index.rst.txt
+++ /dev/null
@@ -1,29 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-CDN Basics
-**********
-
-Traffic Control is a CDN control plane, see the topics below to familiarize yourself with the basic concepts of a CDN.
-
-.. toctree::
- :maxdepth: 2
-
- content_delivery_networks
- http_11
- caching_proxies
- cache_revalidation
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/basics/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/basics/index.txt b/docs/latest/_sources/basics/index.txt
new file mode 100644
index 0000000..23ee1da
--- /dev/null
+++ b/docs/latest/_sources/basics/index.txt
@@ -0,0 +1,29 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+CDN Basics
+**********
+
+Traffic Control is a CDN control plane, see the topics below to familiarize yourself with the basic concepts of a CDN.
+
+.. toctree::
+ :maxdepth: 2
+
+ content_delivery_networks
+ http_11
+ caching_proxies
+ cache_revalidation
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/index.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/index.rst.txt b/docs/latest/_sources/development/index.rst.txt
deleted file mode 100644
index 851e463..0000000
--- a/docs/latest/_sources/development/index.rst.txt
+++ /dev/null
@@ -1,29 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Developer's Guide
-*****************
-Use this guide to start developing applications that consume the Traffic Control APIs, to create extensions to Traffic Ops, or work on Traffic Control itself.
-
-.. toctree::
- :maxdepth: 2
-
- traffic_ops
- traffic_portal
- traffic_router
- traffic_monitor
- traffic_stats
- traffic_server
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/index.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/index.txt b/docs/latest/_sources/development/index.txt
new file mode 100644
index 0000000..851e463
--- /dev/null
+++ b/docs/latest/_sources/development/index.txt
@@ -0,0 +1,29 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Developer's Guide
+*****************
+Use this guide to start developing applications that consume the Traffic Control APIs, to create extensions to Traffic Ops, or work on Traffic Control itself.
+
+.. toctree::
+ :maxdepth: 2
+
+ traffic_ops
+ traffic_portal
+ traffic_router
+ traffic_monitor
+ traffic_stats
+ traffic_server
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_monitor.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_monitor.rst.txt b/docs/latest/_sources/development/traffic_monitor.rst.txt
deleted file mode 100644
index 012cbb3..0000000
--- a/docs/latest/_sources/development/traffic_monitor.rst.txt
+++ /dev/null
@@ -1,112 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Traffic Monitor
-***************
-Introduction
-============
-Traffic Monitor is a Java Tomcat application that monitors caches, provides health state information to Traffic Router, and collects statistics for use in tools such as Traffic Ops and Traffic Stats. The health state provided by Traffic Monitor is used by Traffic Router to control which caches are available on the CDN.
-
-Software Requirements
-=====================
-To work on Traffic Monitor you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
-
-* Eclipse >= Kepler SR2 (or another Java IDE)
-* Maven >= 3.3.1
-* JDK >= 6.0
-
-Traffic Monitor Project Tree Overview
-=====================================
-* ``traffic_control/traffic_monitor/`` - base directory for Traffic Monitor
-
- * ``etc/`` - Miscellaneous simulator utilities
- * ``src/main`` - Main source directory for the Traffic Monitor
-
- * ``bin/`` - Configuration tools
- * ``conf/`` - Configuration files
- * ``java/`` - Java source code for Traffic Monitor
- * ``opt/tomcat/conf`` - Contains Tomcat configuration file(s) pulled in during an RPM build
- * ``resources/`` - Resources pulled in during an RPM build
- * ``scripts/`` - Scripts used by the RPM build process
- * ``webapp/`` - Java webapp resources
-
- * ``src/test`` - Test source directory for Traffic Monitor
-
- * ``java/`` - JUnit based unit tests for Traffic Monitor
- * ``resources/conf`` - Configuration files used by unit tests
- * ``resources/db`` - Files downloaded by unit tests
- * ``resources/var`` - Files generated by unit tests
-
-Java Formatting Conventions
-===========================
-None at this time. The codebase will eventually be formatted per Java standards.
-
-Installing The Developer Environment
-====================================
-To install the Traffic Monitor Developer environment:
-
-1. Clone the traffic_control repository using Git.
-2. Change directories into ``traffic_control/traffic_monitor``.
-3. Edit the following parameters in src/test/resources/conf/traffic_monitor_config.js:
-
-+-----------------+------------------------------------------------------------+
-| Parameter | Value |
-+=================+============================================================+
-| ``tm.hostname`` | FQDN of the Traffic Ops instance (do not include http://). |
-+-----------------+------------------------------------------------------------+
-| ``tm.username`` | Admin username for Traffic Ops |
-+-----------------+------------------------------------------------------------+
-| ``tm.password`` | Password for admin user |
-+-----------------+------------------------------------------------------------+
-| ``cdnName`` | Name of the CDN this Traffic Monitor will monitor |
-+-----------------+------------------------------------------------------------+
-
-4. Import the existing git repo into Eclipse:
-
- a. File -> Import -> Git -> Projects from Git; Next
- b. Existing local repository; Next
- c. Add -> browse to find ``traffic_control``; Add
- d. Select ``traffic_control``; Next
- e. Ensure "Import existing projects" is selected, expand ``traffic_control``, select ``traffic_monitor``; Next
- f. Ensure ``traffic_monitor`` is checked; Finish
- g. Ensure ``traffic_monitor`` has been opened by Eclipse after importing
-
-5. Run ``mvn clean verify`` from the ``traffic_monitor`` directory
-
-6. Start the embedded Jetty instance from within Eclipse
-
- a. In the package explorer, expand ``traffic_monitor``
- b. Expand ``src/test/java``
- c. Expand the package ``com.comcast.cdn.traffic_control.traffic_monitor``
- d. Open and run ``Start.java``
-
- .. Note:: If an error is displayed in the Console, run ``mvn clean verify`` from the ``traffic_monitor`` directory
-
- e. With a web browser, navigate to http://localhost:8080
-
-Test Cases
-==========
-Unit tests can be executed using Maven by running ``mvn test`` at the root of the ``traffic_monitor`` project.
-
-API
-===
-
-:ref:`reference-tm-api`
-
-.. toctree::
- :hidden:
- :maxdepth: 1
-
- traffic_monitor/traffic_monitor_api
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_monitor.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_monitor.txt b/docs/latest/_sources/development/traffic_monitor.txt
new file mode 100644
index 0000000..012cbb3
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_monitor.txt
@@ -0,0 +1,112 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Traffic Monitor
+***************
+Introduction
+============
+Traffic Monitor is a Java Tomcat application that monitors caches, provides health state information to Traffic Router, and collects statistics for use in tools such as Traffic Ops and Traffic Stats. The health state provided by Traffic Monitor is used by Traffic Router to control which caches are available on the CDN.
+
+Software Requirements
+=====================
+To work on Traffic Monitor you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+* Eclipse >= Kepler SR2 (or another Java IDE)
+* Maven >= 3.3.1
+* JDK >= 6.0
+
+Traffic Monitor Project Tree Overview
+=====================================
+* ``traffic_control/traffic_monitor/`` - base directory for Traffic Monitor
+
+ * ``etc/`` - Miscellaneous simulator utilities
+ * ``src/main`` - Main source directory for the Traffic Monitor
+
+ * ``bin/`` - Configuration tools
+ * ``conf/`` - Configuration files
+ * ``java/`` - Java source code for Traffic Monitor
+ * ``opt/tomcat/conf`` - Contains Tomcat configuration file(s) pulled in during an RPM build
+ * ``resources/`` - Resources pulled in during an RPM build
+ * ``scripts/`` - Scripts used by the RPM build process
+ * ``webapp/`` - Java webapp resources
+
+ * ``src/test`` - Test source directory for Traffic Monitor
+
+ * ``java/`` - JUnit based unit tests for Traffic Monitor
+ * ``resources/conf`` - Configuration files used by unit tests
+ * ``resources/db`` - Files downloaded by unit tests
+ * ``resources/var`` - Files generated by unit tests
+
+Java Formatting Conventions
+===========================
+None at this time. The codebase will eventually be formatted per Java standards.
+
+Installing The Developer Environment
+====================================
+To install the Traffic Monitor Developer environment:
+
+1. Clone the traffic_control repository using Git.
+2. Change directories into ``traffic_control/traffic_monitor``.
+3. Edit the following parameters in src/test/resources/conf/traffic_monitor_config.js:
+
++-----------------+------------------------------------------------------------+
+| Parameter | Value |
++=================+============================================================+
+| ``tm.hostname`` | FQDN of the Traffic Ops instance (do not include http://). |
++-----------------+------------------------------------------------------------+
+| ``tm.username`` | Admin username for Traffic Ops |
++-----------------+------------------------------------------------------------+
+| ``tm.password`` | Password for admin user |
++-----------------+------------------------------------------------------------+
+| ``cdnName`` | Name of the CDN this Traffic Monitor will monitor |
++-----------------+------------------------------------------------------------+
+
+4. Import the existing git repo into Eclipse:
+
+ a. File -> Import -> Git -> Projects from Git; Next
+ b. Existing local repository; Next
+ c. Add -> browse to find ``traffic_control``; Add
+ d. Select ``traffic_control``; Next
+ e. Ensure "Import existing projects" is selected, expand ``traffic_control``, select ``traffic_monitor``; Next
+ f. Ensure ``traffic_monitor`` is checked; Finish
+ g. Ensure ``traffic_monitor`` has been opened by Eclipse after importing
+
+5. Run ``mvn clean verify`` from the ``traffic_monitor`` directory
+
+6. Start the embedded Jetty instance from within Eclipse
+
+ a. In the package explorer, expand ``traffic_monitor``
+ b. Expand ``src/test/java``
+ c. Expand the package ``com.comcast.cdn.traffic_control.traffic_monitor``
+ d. Open and run ``Start.java``
+
+ .. Note:: If an error is displayed in the Console, run ``mvn clean verify`` from the ``traffic_monitor`` directory
+
+ e. With a web browser, navigate to http://localhost:8080
+
+Test Cases
+==========
+Unit tests can be executed using Maven by running ``mvn test`` at the root of the ``traffic_monitor`` project.
+
+API
+===
+
+:ref:`reference-tm-api`
+
+.. toctree::
+ :hidden:
+ :maxdepth: 1
+
+ traffic_monitor/traffic_monitor_api
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.rst.txt b/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.rst.txt
deleted file mode 100644
index 0240fd4..0000000
--- a/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.rst.txt
+++ /dev/null
@@ -1,178 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _reference-tm-api:
-
-Traffic Monitor APIs
-====================
-The Traffic Monitor URLs below allow certain query parameters for use in controlling the data returned. The optional query parameters are the *tabbed* in values under each URL, if they exist.
-
-|
-
-**/publish/EventLog**
-
-Log of recent events.
-
-|
-
-**/publish/CacheStats**
-
-Statistics gathered for each cache.
-
-**Query Parameters**
-
-+--------------+---------+------------------------------------------------+
-| Parameter | Type | Description |
-+==============+=========+================================================+
-| ``hc`` | int | The history count, number of items to display. |
-+--------------+---------+------------------------------------------------+
-| ``stats`` | string | A comma separated list of stats to display. |
-+--------------+---------+------------------------------------------------+
-| ``wildcard`` | boolean | Controls whether specified stats should be |
-| | | treated as partial strings. |
-+--------------+---------+------------------------------------------------+
-
-|
-
-**/publish/CacheStats/:cache**
-
-Statistics gathered for only this cache.
-
-**Query Parameters**
-
-+--------------+---------+------------------------------------------------+
-| Parameter | Type | Description |
-+==============+=========+================================================+
-| ``hc`` | int | The history count, number of items to display. |
-+--------------+---------+------------------------------------------------+
-| ``stats`` | string | A comma separated list of stats to display. |
-+--------------+---------+------------------------------------------------+
-| ``wildcard`` | boolean | Controls whether specified stats should be |
-| | | treated as partial strings. |
-+--------------+---------+------------------------------------------------+
-
-|
-
-**/publish/DsStats**
-
-Statistics gathered for delivery services.
-
-**Query Parameters**
-
-+--------------+---------+------------------------------------------------+
-| Parameter | Type | Description |
-+==============+=========+================================================+
-| ``hc`` | int | The history count, number of items to display. |
-+--------------+---------+------------------------------------------------+
-| ``stats`` | string | A comma separated list of stats to display. |
-+--------------+---------+------------------------------------------------+
-| ``wildcard`` | boolean | Controls whether specified stats should be |
-| | | treated as partial strings. |
-+--------------+---------+------------------------------------------------+
-
-|
-
-**/publish/DsStats/:deliveryService**
-
-Statistics gathered for this delivery service only.
-
-**Query Parameters**
-
-+--------------+---------+------------------------------------------------+
-| Parameter | Type | Description |
-+==============+=========+================================================+
-| ``hc`` | int | The history count, number of items to display. |
-+--------------+---------+------------------------------------------------+
-| ``stats`` | string | A comma separated list of stats to display. |
-+--------------+---------+------------------------------------------------+
-| ``wildcard`` | boolean | Controls whether specified stats should be |
-| | | treated as partial strings. |
-+--------------+---------+------------------------------------------------+
-
-|
-
-**/publish/CrStates**
-
-The current state of this CDN per the health protocol.
-
-|
-
-**raw**
-
-The current state of this CDN per this Traffic Monitor only.
-
-|
-
-**/publish/CrConfig**
-
-The CrConfig served to and consumed by Traffic Router.
-
-|
-
-**/publish/PeerStates**
-
-The health state information from all peer Traffic Monitors.
-
-**Query Parameters**
-
-+--------------+---------+------------------------------------------------+
-| Parameter | Type | Description |
-+==============+=========+================================================+
-| ``hc`` | int | The history count, number of items to display. |
-+--------------+---------+------------------------------------------------+
-| ``stats`` | string | A comma separated list of stats to display. |
-+--------------+---------+------------------------------------------------+
-| ``wildcard`` | boolean | Controls whether specified stats should be |
-| | | treated as partial strings. |
-+--------------+---------+------------------------------------------------+
-
-|
-
-**/publish/Stats**
-
-The general statistics about Traffic Monitor.
-
-|
-
-**/publish/StatSummary**
-
-The summary of cache statistics.
-
-**Query Parameters**
-
-+---------------+---------+-----------------------------------------------------------+
-| Parameter | Type | Description |
-+===============+=========+===========================================================+
-| ``startTime`` | number | Window start. The number of milliseconds since the epoch. |
-+---------------+---------+-----------------------------------------------------------+
-| ``endTime`` | number | Window end. The number of milliseconds since the epoch. |
-+---------------+---------+-----------------------------------------------------------+
-| ``hc`` | int | The history count, number of items to display. |
-+---------------+---------+-----------------------------------------------------------+
-| ``stats`` | string | A comma separated list of stats to display. |
-+---------------+---------+-----------------------------------------------------------+
-| ``wildcard`` | boolean | Controls whether specified stats should be |
-| | | treated as partial strings. |
-+---------------+---------+-----------------------------------------------------------+
-| ``cache`` | string | Summary statistics for just this cache. |
-+---------------+---------+-----------------------------------------------------------+
-
-|
-
-**/publish/ConfigDoc**
-
-The overview of configuration options.
-
-
[37/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/hwinfo.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/hwinfo.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/hwinfo.rst.txt
deleted file mode 100644
index cc45b38..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/hwinfo.rst.txt
+++ /dev/null
@@ -1,67 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v11-hwinfo:
-
-Hardware Info
-=============
-
-.. _to-api-v11-hwinfo-route:
-
-/api/1.1/hwinfo
-+++++++++++++++
-
-**GET /api/1.1/hwinfo.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +--------------------+--------+----------------------------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+======================================================================+
- | ``serverId`` | string | Local unique identifier for this specific server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``serverHostName`` | string | Hostname for this specific server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``val`` | string | Freeform value used to track anything about a server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``description`` | string | Freeform description for this specific server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "serverId": "odol-atsmid-cen-09",
- "lastUpdated": "2014-05-27 09:06:02",
- "val": "D1S4",
- "description": "Physical Disk 0:1:0"
- },
- {
- "serverId": "odol-atsmid-cen-09",
- "lastUpdated": "2014-05-27 09:06:02",
- "val": "D1S4",
- "description": "Physical Disk 0:1:1"
- }
- ],
- }
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/hwinfo.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/hwinfo.txt b/docs/latest/_sources/development/traffic_ops_api/v11/hwinfo.txt
new file mode 100644
index 0000000..cc45b38
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/hwinfo.txt
@@ -0,0 +1,67 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v11-hwinfo:
+
+Hardware Info
+=============
+
+.. _to-api-v11-hwinfo-route:
+
+/api/1.1/hwinfo
++++++++++++++++
+
+**GET /api/1.1/hwinfo.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------+--------+----------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+======================================================================+
+ | ``serverId`` | string | Local unique identifier for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``serverHostName`` | string | Hostname for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``val`` | string | Freeform value used to track anything about a server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``description`` | string | Freeform description for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:0"
+ },
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:1"
+ }
+ ],
+ }
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/parameter.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/parameter.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/parameter.rst.txt
deleted file mode 100644
index 1b83d01..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/parameter.rst.txt
+++ /dev/null
@@ -1,136 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-parameter:
-
-Parameter
-=========
-
-.. _to-api-v11-parameters-route:
-
-/api/1.1/parameters
-+++++++++++++++++++
-
-**GET /api/1.1/parameters.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``last_updated`` | string | The Time / Date this server entry was last updated |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": 0,
- "value": "foo.bar.net",
- "name": "domain_name",
- "config_file": "FooConfig.xml"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": 0,
- "value": "0,1,2,3,4,5,6",
- "name": "Drive_Letters",
- "config_file": "storage.config"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": 0,
- "value": "STRING __HOSTNAME__",
- "name": "CONFIG proxy.config.proxy_name",
- "config_file": "records.config"
- }
- ],
- }
-
-|
-
-**GET /api/1.1/parameters/profile/:name.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-------------+
- | Name | Required | Description |
- +==================+==========+=============+
- | ``profile_name`` | yes | |
- +------------------+----------+-------------+
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``last_updated`` | string | The Time / Date this server entry was last updated |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": 0,
- "value": "foo.bar.net",
- "name": "domain_name",
- "config_file": "FooConfig.xml"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": 0,
- "value": "0,1,2,3,4,5,6",
- "name": "Drive_Letters",
- "config_file": "storage.config"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": 0,
- "value": "STRING __HOSTNAME__",
- "name": "CONFIG proxy.config.proxy_name",
- "config_file": "records.config"
- }
- ],
- }
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/parameter.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/parameter.txt b/docs/latest/_sources/development/traffic_ops_api/v11/parameter.txt
new file mode 100644
index 0000000..1b83d01
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/parameter.txt
@@ -0,0 +1,136 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-parameter:
+
+Parameter
+=========
+
+.. _to-api-v11-parameters-route:
+
+/api/1.1/parameters
++++++++++++++++++++
+
+**GET /api/1.1/parameters.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/parameters/profile/:name.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``profile_name`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.rst.txt
deleted file mode 100644
index 6ebaff0..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.rst.txt
+++ /dev/null
@@ -1,449 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-phys-loc:
-
-Physical Location
-=================
-
-.. _to-api-v11-phys-loc-route:
-
-/api/1.1/phys_locations
-+++++++++++++++++++++++
-
-**GET /api/1.1/phys_locations**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``address`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``comments`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``regionId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``shortName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``state`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "region": "Mile High",
- "region": "4",
- "poc": "Jane Doe",
- "lastUpdated": "2014-10-02 08:22:43",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "id": "2",
- "address": "123 East 3rd St",
- "shortName": "Albuquerque"
- },
- {
- "region": "Mile High",
- "region": "4",
- "poc": "Jane Doe",
- "lastUpdated": "2014-10-02 08:22:43",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "id": "2",
- "address": "123 East 3rd St",
- "shortName": "Albuquerque"
- }
- ]
- }
-
-|
-
-**GET /api/1.1/phys_locations/trimmed.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+---------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+=========+================================================+
- |``name`` | string | |
- +----------------------+---------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "Albuquerque"
- },
- {
- "name": "Ashburn"
- }
- ]
- }
-
-|
-
-
-**GET /api/1.1/phys_locations/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | Physical location ID. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``address`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``comments`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``regionId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``shortName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``state`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "region": "Mile High",
- "region": "4",
- "poc": "Jane Doe",
- "lastUpdated": "2014-10-02 08:22:43",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "id": "2",
- "address": "123 East 3rd St",
- "shortName": "Albuquerque"
- }
- ]
- }
-
-|
-
-**PUT /api/1.1/phys_locations/:id**
- Update a physical location
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Type | Description |
- +===================+==========+================================================+
- | ``id`` | int | Physical location id. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +-------------------+----------+------------------------------------------------+
- | Parameter | Required | Description |
- +===================+==========+================================================+
- | ``address`` | yes | Physical location address. |
- +-------------------+----------+------------------------------------------------+
- | ``city`` | yes | Physical location city. |
- +-------------------+----------+------------------------------------------------+
- | ``comments`` | no | Physical location comments. |
- +-------------------+----------+------------------------------------------------+
- | ``email`` | no | Physical location email. |
- +-------------------+----------+------------------------------------------------+
- | ``name`` | yes | Physical location name. |
- +-------------------+----------+------------------------------------------------+
- | ``phone`` | no | Physical location phone. |
- +-------------------+----------+------------------------------------------------+
- | ``poc`` | no | Physical location point of contact. |
- +-------------------+----------+------------------------------------------------+
- | ``regionId`` | no | Physical location region ID. |
- +-------------------+----------+------------------------------------------------+
- | ``shortName`` | yes | Physical location short name. |
- +-------------------+----------+------------------------------------------------+
- | ``state`` | yes | Physical location state. |
- +-------------------+----------+------------------------------------------------+
- | ``zip`` | yes | Physical location zip. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "regionId": "1",
- "poc": "Jane Doesssss",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "address": "123 East 9rd St",
- "shortName": "Albuquerque"
- }
-
-|
-
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``address`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``comments`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``regionId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``shortName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``state`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
- +----------------------+--------+------------------------------------------------+
-
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Physical location update was successful."
- }
- ],
- "response": [
- {
- "region": "Mile High",
- "region": "4",
- "poc": "Jane Doe",
- "lastUpdated": "2014-10-02 08:22:43",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "id": "2",
- "address": "123 East 3rd St",
- "shortName": "Albuquerque"
- }
- ]
- }
-
-|
-
-
-**POST /api/1.1/regions/:region_name/phys_locations**
- Create physical location.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- region_name: the name of the region to create physical location into.
-
- **Request Route Parameters**
-
- +-----------------+----------+-----------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================+
- | ``region_name`` | yes | The name of the physical location |
- +-----------------+----------+-----------------------------------+
-
- **Request Properties**
-
- +-----------------+----------+---------------------------------------------------+
- | Parameter | Required | Description |
- +=================+==========+===================================================+
- | ``name`` | yes | The name of the location |
- +-----------------+----------+---------------------------------------------------+
- | ``shortName`` | yes | The short name of the location |
- +-----------------+----------+---------------------------------------------------+
- | ``address`` | yes | |
- +-----------------+----------+---------------------------------------------------+
- | ``city`` | yes | |
- +-----------------+----------+---------------------------------------------------+
- | ``state`` | yes | |
- +-----------------+----------+---------------------------------------------------+
- | ``zip`` | yes | |
- +-----------------+----------+---------------------------------------------------+
- | ``phone`` | no | |
- +-----------------+----------+---------------------------------------------------+
- | ``poc`` | no | Point of contact |
- +-----------------+----------+---------------------------------------------------+
- | ``email`` | no | |
- +-----------------+----------+---------------------------------------------------+
- | ``comments`` | no | |
- +-----------------+----------+---------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name" : "my physical location1",
- "shortName" : "myphylocation1",
- "address" : "",
- "city" : "Shanghai",
- "state": "SH",
- "zip": "200000",
- "comments": "this is physical location1"
- }
-
-|
-
- **Response Properties**
-
- +-----------------+--------+---------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+===================================================+
- | ``id`` | string | The id of the physical location created. |
- +-----------------+--------+---------------------------------------------------+
- | ``name`` | string | The name of the location |
- +-----------------+--------+---------------------------------------------------+
- | ``shortName`` | string | The short name of the location |
- +-----------------+--------+---------------------------------------------------+
- | ``regionName`` | string | The region name the physical location belongs to. |
- +-----------------+--------+---------------------------------------------------+
- | ``regionId`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``address`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``city`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``state`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``zip`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``phone`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``poc`` | string | Point of contact |
- +-----------------+--------+---------------------------------------------------+
- | ``email`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``comments`` | string | |
- +-----------------+--------+---------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- 'shortName': 'myphylocati',
- 'regionName': 'myregion1',
- 'name': 'my physical location1',
- 'poc': '',
- 'phone': '',
- 'comments': 'this is physical location1',
- 'state': 'SH',
- 'email': '',
- 'zip': '20000',
- 'region_id': '20',
- 'city': 'Shanghai',
- 'address': '',
- 'id': '200'
- }
- }
-
-|
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt b/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
new file mode 100644
index 0000000..6ebaff0
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/phys_location.txt
@@ -0,0 +1,449 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-phys-loc:
+
+Physical Location
+=================
+
+.. _to-api-v11-phys-loc-route:
+
+/api/1.1/phys_locations
++++++++++++++++++++++++
+
+**GET /api/1.1/phys_locations**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ },
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/phys_locations/trimmed.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+=========+================================================+
+ |``name`` | string | |
+ +----------------------+---------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "Albuquerque"
+ },
+ {
+ "name": "Ashburn"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/phys_locations/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Physical location ID. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.1/phys_locations/:id**
+ Update a physical location
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Physical location id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+================================================+
+ | ``address`` | yes | Physical location address. |
+ +-------------------+----------+------------------------------------------------+
+ | ``city`` | yes | Physical location city. |
+ +-------------------+----------+------------------------------------------------+
+ | ``comments`` | no | Physical location comments. |
+ +-------------------+----------+------------------------------------------------+
+ | ``email`` | no | Physical location email. |
+ +-------------------+----------+------------------------------------------------+
+ | ``name`` | yes | Physical location name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``phone`` | no | Physical location phone. |
+ +-------------------+----------+------------------------------------------------+
+ | ``poc`` | no | Physical location point of contact. |
+ +-------------------+----------+------------------------------------------------+
+ | ``regionId`` | no | Physical location region ID. |
+ +-------------------+----------+------------------------------------------------+
+ | ``shortName`` | yes | Physical location short name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``state`` | yes | Physical location state. |
+ +-------------------+----------+------------------------------------------------+
+ | ``zip`` | yes | Physical location zip. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "regionId": "1",
+ "poc": "Jane Doesssss",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "address": "123 East 9rd St",
+ "shortName": "Albuquerque"
+ }
+
+|
+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Physical location update was successful."
+ }
+ ],
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.1/regions/:region_name/phys_locations**
+ Create physical location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ region_name: the name of the region to create physical location into.
+
+ **Request Route Parameters**
+
+ +-----------------+----------+-----------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================+
+ | ``region_name`` | yes | The name of the physical location |
+ +-----------------+----------+-----------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``shortName`` | yes | The short name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``address`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``city`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``state`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``zip`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``phone`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``poc`` | no | Point of contact |
+ +-----------------+----------+---------------------------------------------------+
+ | ``email`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``comments`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name" : "my physical location1",
+ "shortName" : "myphylocation1",
+ "address" : "",
+ "city" : "Shanghai",
+ "state": "SH",
+ "zip": "200000",
+ "comments": "this is physical location1"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+===================================================+
+ | ``id`` | string | The id of the physical location created. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``name`` | string | The name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``shortName`` | string | The short name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionName`` | string | The region name the physical location belongs to. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionId`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``address`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``city`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``state`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``zip`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``phone`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``poc`` | string | Point of contact |
+ +-----------------+--------+---------------------------------------------------+
+ | ``email`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``comments`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/profile.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/profile.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/profile.rst.txt
deleted file mode 100644
index 5c37690..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/profile.rst.txt
+++ /dev/null
@@ -1,129 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-profile:
-
-Profiles
-========
-
-.. _to-api-v11-profiles-route:
-
-/api/1.1/profiles
-+++++++++++++++++
-
-**GET /api/1.1/profiles**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+====================================================+
- | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
- +-----------------+--------+----------------------------------------------------+
- | ``name`` | string | The name for the profile |
- +-----------------+--------+----------------------------------------------------+
- | ``id`` | string | Primary key |
- +-----------------+--------+----------------------------------------------------+
- | ``description`` | string | The description for the profile |
- +-----------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "lastUpdated": "2012-10-08 19:34:45",
- "name": "CCR_TOP",
- "id": "8",
- "description": "Content Router for top.foobar.net"
- }
- ]
- }
-
-|
-
-**GET /api/1.1/profiles/trimmed**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+====================================================+
- | ``name`` | string | The name for the profile |
- +-----------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "CCR_TOP"
- }
- ]
- }
-
-|
-
-**GET /api/1.1/profiles/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+------------+------------------------------------------------+
- | Parameter | Required | Description |
- +=================+============+================================================+
- | ``id`` | yes | The ID of the profile. |
- +-----------------+------------+------------------------------------------------+
-
- **Response Properties**
-
- +-----------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+====================================================+
- | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
- +-----------------+--------+----------------------------------------------------+
- | ``name`` | string | The name for the profile |
- +-----------------+--------+----------------------------------------------------+
- | ``id`` | string | Primary key |
- +-----------------+--------+----------------------------------------------------+
- | ``description`` | string | The description for the profile |
- +-----------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "lastUpdated": "2012-10-08 19:34:45",
- "name": "CCR_TOP",
- "id": "8",
- "description": "Content Router for top.foobar.net"
- }
- ]
- }
-
-|
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt b/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
new file mode 100644
index 0000000..5c37690
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/profile.txt
@@ -0,0 +1,129 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-profile:
+
+Profiles
+========
+
+.. _to-api-v11-profiles-route:
+
+/api/1.1/profiles
++++++++++++++++++
+
+**GET /api/1.1/profiles**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/profiles/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "CCR_TOP"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.1/profiles/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+------------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+============+================================================+
+ | ``id`` | yes | The ID of the profile. |
+ +-----------------+------------+------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+====================================================+
+ | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
+ +-----------------+--------+----------------------------------------------------+
+ | ``name`` | string | The name for the profile |
+ +-----------------+--------+----------------------------------------------------+
+ | ``id`` | string | Primary key |
+ +-----------------+--------+----------------------------------------------------+
+ | ``description`` | string | The description for the profile |
+ +-----------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-10-08 19:34:45",
+ "name": "CCR_TOP",
+ "id": "8",
+ "description": "Content Router for top.foobar.net"
+ }
+ ]
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/region.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/region.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/region.rst.txt
deleted file mode 100644
index faddbb1..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/region.rst.txt
+++ /dev/null
@@ -1,235 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-region:
-
-Regions
-=======
-
-.. _to-api-v11-regions-route:
-
-/api/1.1/regions
-++++++++++++++++
-
-**GET /api/1.1/regions**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | Region ID. |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | Region name. |
- +----------------------+--------+------------------------------------------------+
- |``division`` | string | Division ID. |
- +----------------------+--------+------------------------------------------------+
- |``divisionName`` | string | Division name. |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "6",
- "name": "Atlanta",
- "division": "2",
- "divisionName": "West"
- },
- {
- "id": "7",
- "name": "Denver",
- "division": "2",
- "divisionName": "West"
- },
- ]
- }
-
-
-**GET /api/1.1/regions/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | Region id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | Region ID. |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | Region name. |
- +----------------------+--------+------------------------------------------------+
- |``division`` | string | Division ID. |
- +----------------------+--------+------------------------------------------------+
- |``divisionName`` | string | Division name. |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "6",
- "name": "Atlanta",
- "division": "2",
- "divisionName": "West"
- }
- ]
- }
-
-
-**PUT /api/1.1/regions/:id**
- Update a region
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Type | Description |
- +===================+==========+================================================+
- | ``id`` | int | Region id. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +----------------+----------+--------------------------+
- | Parameter | Required | Description |
- +================+==========+==========================+
- | ``name`` | yes | The name of the region |
- +----------------+----------+--------------------------+
- | ``division`` | yes | The division Id |
- +----------------+----------+--------------------------+
-
- **Request Example** ::
-
- {
- "name": "myregion1",
- "division": "4"
- }
-
-|
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``division`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``divisionName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Region update was successful."
- }
- ],
- "response": {
- "id": "1",
- "lastUpdated": "2014-03-18 08:57:39",
- "name": "myregion1",
- "division": "4",
- "divisionName": "mydivision1"
- }
- }
-|
-
-**POST /api/1.1/divisions/:division_name/regions**
- Create Region
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- division_name - The name of division to create new region into.
-
- ** Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Required | Description |
- +===================+==========+================================================+
- | ``division_name`` | yes | The name of division will create new region in |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +-------------------+----------+------------------------------------------+
- | Parameter | Required | Description |
- +===================+==========+==========================================+
- | ``name`` | yes | The name of the region |
- +-------------------+----------+------------------------------------------+
-
- **Request Example** ::
-
- {
- "name": "myregion1",
- }
-
-|
-
- **Response Properties**
-
- +-------------------+--------+-------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+===========================================+
- | ``name`` | string | name of region created |
- +-------------------+--------+-------------------------------------------+
- | ``id`` | string | id of region created |
- +-------------------+--------+-------------------------------------------+
- | ``divisionName`` | string | the division name the region belongs to. |
- +-------------------+--------+-------------------------------------------+
- | ``divisionId`` | string | the id of division the region belongs to. |
- +-------------------+--------+-------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- 'divisionName': 'mydivision1',
- 'divsionId': '4',
- 'name': 'myregion1',
- 'id': '19'
- }
- }
-
-|
[41/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/cdn.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/cdn.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/cdn.rst.txt
deleted file mode 100644
index d2f742e..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/cdn.rst.txt
+++ /dev/null
@@ -1,1086 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-cdn-health:
-
-CDN
-===
-
-.. _to-api-v11-cdn-health-route:
-
-/api/1.1/cdns
-+++++++++++++
-
-**GET /api/1.1/cdns**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=================================================+
- | ``id`` | string | CDN id. |
- +-------------------+--------+-------------------------------------------------+
- | ``name`` | string | CDN name. |
- +-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | bool | DNSSEC enabled. |
- +-------------------+--------+-------------------------------------------------+
- | ``lastUpdated`` | string | |
- +-------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "1"
- "name": "over-the-top",
- "dnssecEnabled": false,
- "lastUpdated": "2014-10-02 08:22:43"
- },
- {
- "id": "2"
- "name": "cdn2",
- "dnssecEnabled": true,
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-**GET /api/1.1/cdns/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | CDN id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +-------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=================================================+
- | ``id`` | string | CDN id. |
- +-------------------+--------+-------------------------------------------------+
- | ``name`` | string | CDN name. |
- +-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | bool | DNSSEC enabled. |
- +-------------------+--------+-------------------------------------------------+
- | ``lastUpdated`` | string | |
- +-------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "2"
- "name": "cdn2",
- "dnssecEnabled": false,
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-**GET /api/1.1/cdns/name/:name**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``name`` | yes | CDN name. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +-------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=================================================+
- | ``id`` | string | CDN id. |
- +-------------------+--------+-------------------------------------------------+
- | ``name`` | string | CDN name. |
- +-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | bool | DNSSEC enabled. |
- +-------------------+--------+-------------------------------------------------+
- | ``lastUpdated`` | string | |
- +-------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "2"
- "name": "cdn2",
- "dnssecEnabled": false,
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-Health
-++++++
-
-**GET /api/1.1/cdns/health**
-
- Retrieves the health of all locations (cache groups) for all CDNs.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``totalOnline`` | int | Total number of online caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``cachegroups`` | array | A collection of cache groups. |
- +------------------+--------+-------------------------------------------------+
- | ``>online`` | int | The number of online caches for the cache group |
- +------------------+--------+-------------------------------------------------+
- | ``>offline`` | int | The number of offline caches for the cache |
- | | | group. |
- +------------------+--------+-------------------------------------------------+
- | ``>name`` | string | Cache group name. |
- +------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "totalOnline": 148,
- "totalOffline": 0,
- "cachegroups": [
- {
- "online": 8,
- "offline": 0,
- "name": "us-co-denver"
- },
- {
- "online": 7,
- "offline": 0,
- "name": "us-de-newcastle"
- }
- ]
- },
- }
-
-
-|
-
-**GET /api/1.1/cdns/:name/health**
-
- Retrieves the health of all locations (cache groups) for a given CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- |``name`` | yes | |
- +-----------------+----------+---------------------------------------------------+
-
- **Response Properties**
-
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``totalOnline`` | int | Total number of online caches across the |
- | | | specified CDN. |
- +------------------+--------+-------------------------------------------------+
- | ``totalOffline`` | int | Total number of offline caches across the |
- | | | specified CDN. |
- +------------------+--------+-------------------------------------------------+
- | ``cachegroups`` | array | A collection of cache groups. |
- +------------------+--------+-------------------------------------------------+
- | ``>online`` | int | The number of online caches for the cache group |
- +------------------+--------+-------------------------------------------------+
- | ``>offline`` | int | The number of offline caches for the cache |
- | | | group. |
- +------------------+--------+-------------------------------------------------+
- | ``>name`` | string | Cache group name. |
- +------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "totalOnline": 148,
- "totalOffline": 0,
- "cachegroups": [
- {
- "online": 8,
- "offline": 0,
- "name": "us-co-denver"
- },
- {
- "online": 7,
- "offline": 0,
- "name": "us-de-newcastle"
- }
- ]
- },
- }
-
-|
-
-**GET /api/1.1/cdns/usage/overview**
-
- Retrieves the high-level CDN usage metrics.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``currentGbps`` | number | |
- +----------------------+--------+------------------------------------------------+
- |``tps`` | int | |
- +----------------------+--------+------------------------------------------------+
- |``maxGbps`` | int | |
- +----------------------+--------+------------------------------------------------+
-
-
- **Response Example** ::
-
- {
- "response": {
- "currentGbps": 149.368167,
- "tps": 36805,
- "maxGbps": 3961
- }
- }
-
-
-**GET /api/1.1/cdns/capacity**
-
- Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``availablePercent`` | number | |
- +----------------------+--------+------------------------------------------------+
- |``unavailablePercent``| number | |
- +----------------------+--------+------------------------------------------------+
- |``utilizedPercent`` | number | |
- +----------------------+--------+------------------------------------------------+
- |``maintenancePercent``| number | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "availablePercent": 89.0939840205533,
- "unavailablePercent": 0,
- "utilizedPercent": 10.9060020300395,
- "maintenancePercent": 0.0000139494071146245
- }
- }
-
-|
-
-.. _to-api-v11-cdn-routing:
-
-Routing
-+++++++
-
-**GET /api/1.1/cdns/routing**
-
- Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------+--------+-----------------------------------------+
- | Parameter | Type | Description |
- +=================+========+=========================================+
- | ``staticRoute`` | number | Used pre-configured DNS entries. |
- +-----------------+--------+-----------------------------------------+
- | ``miss`` | number | No location available for client IP. |
- +-----------------+--------+-----------------------------------------+
- | ``geo`` | number | Used 3rd party geo-IP mapping. |
- +-----------------+--------+-----------------------------------------+
- | ``err`` | number | Error localizing client IP. |
- +-----------------+--------+-----------------------------------------+
- | ``cz`` | number | Used Coverage Zone geo-IP mapping. |
- +-----------------+--------+-----------------------------------------+
- | ``dsr`` | number | Overflow traffic sent to secondary CDN. |
- +-----------------+--------+-----------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "staticRoute": 0,
- "miss": 0,
- "geo": 37.8855391018869,
- "err": 0,
- "cz": 62.1144608981131,
- "dsr": 0
- }
- }
-
-|
-
-.. _to-api-v11-cdn-metrics:
-
-Metrics
-+++++++
-
-**GET /api/1.1/cdns/metric_types/:metric/start_date/:start/end_date/:end**
-
- Retrieves edge metrics of one or all locations (cache groups).
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------+
- | Name | Required | Description |
- +=================+==========+===========================+
- | ``metric_type`` | yes | ooff, origin_tps |
- +-----------------+----------+---------------------------+
- | ``start`` | yes | UNIX time, yesterday, now |
- +-----------------+----------+---------------------------+
- | ``end`` | yes | UNIX time, yesterday, now |
- +-----------------+----------+---------------------------+
-
- **Response Properties**
-
- +---------------------+--------+-------------+
- | Parameter | Type | Description |
- +=====================+========+=============+
- | ``stats`` | hash | |
- +---------------------+--------+-------------+
- | ``>count`` | string | |
- +---------------------+--------+-------------+
- | ``>98thPercentile`` | string | |
- +---------------------+--------+-------------+
- | ``>min`` | string | |
- +---------------------+--------+-------------+
- | ``>max`` | string | |
- +---------------------+--------+-------------+
- | ``>5thPercentile`` | string | |
- +---------------------+--------+-------------+
- | ``>95thPercentile`` | string | |
- +---------------------+--------+-------------+
- | ``>mean`` | string | |
- +---------------------+--------+-------------+
- | ``>sum`` | string | |
- +---------------------+--------+-------------+
- | ``data`` | array | |
- +---------------------+--------+-------------+
- | ``>time`` | int | |
- +---------------------+--------+-------------+
- | ``>value`` | number | |
- +---------------------+--------+-------------+
- | ``label`` | string | |
- +---------------------+--------+-------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "stats": {
- "count": 1,
- "98thPercentile": 1668.03,
- "min": 1668.03,
- "max": 1668.03,
- "5thPercentile": 1668.03,
- "95thPercentile": 1668.03,
- "mean": 1668.03,
- "sum": 1668.03
- },
- "data": [
- [
- 1425135900000,
- 1668.03
- ],
- [
- 1425136200000,
- null
- ]
- ],
- "label": "Origin TPS"
- }
- ],
- }
-
-|
-
-.. _to-api-v11-cdn-domains:
-
-Domains
-+++++++
-
-**GET /api/1.1/cdns/domains**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``profileId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``parameterId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``profileName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``profileDescription``| string | |
- +----------------------+--------+------------------------------------------------+
- |``domainName`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "profileId": "5",
- "parameterId": "404",
- "profileName": "CR_FOO",
- "profileDescription": "Content Router for foo.domain.net",
- "domainName": "foo.domain.net"
- },
- {
- "profileId": "8",
- "parameterId": "405",
- "profileName": "CR_BAR",
- "profileDescription": "Content Router for bar.domain.net",
- "domainName": "bar.domain.net"
- }
- ],
- }
-
-|
-
-.. _to-api-v11-cdn-topology:
-
-Topology
-++++++++
-
-**GET /api/1.1/cdns/:cdn_name/configs**
-
- Retrieves CDN config information based upon the provided cdn name.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +--------------+----------+-----------------------+
- | Name | Required | Description |
- +==============+==========+=======================+
- | ``cdn_name`` | yes | Your cdn name or, all |
- +--------------+----------+-----------------------+
-
- **Response Properties**
-
- +-----------------------+--------+-----------------------------------------------+
- | Parameter | Type | Description |
- +=======================+========+===============================================+
- |``id`` | string | |
- +-----------------------+--------+-----------------------------------------------+
- |``value`` | string | |
- +-----------------------+--------+-----------------------------------------------+
- |``name`` | string | |
- +-----------------------+--------+-----------------------------------------------+
- |``config_file`` | string | |
- +-----------------------+--------+-----------------------------------------------+
-
- **Response Example** ::
-
- TBD
-
-|
-
-**GET /api/1.1/cdns/:name/configs/monitoring**
-
- Retrieves CDN monitoring information.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------+----------+-------------+
- | Name | Required | Description |
- +==========+==========+=============+
- | ``name`` | yes | CDN name |
- +----------+----------+-------------+
-
- **Response Properties**
-
- +-------------------------------------------------+--------+--------------------+
- | Parameter | Type | Description |
- +=================================================+========+====================+
- | ``trafficServers`` | array | A collection of |
- | | | Traffic Servers. |
- +-------------------------------------------------+--------+--------------------+
- | ``>profile`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>ip`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>status`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>cacheGroup`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>ip6`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>port`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>hostName`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>interfaceName`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>type`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>hashId`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``cacheGroups`` | array | A collection of |
- | | | cache groups. |
- +-------------------------------------------------+--------+--------------------+
- | ``>coordinates`` | hash | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>longitude`` | number | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>latitude`` | number | |
- +-------------------------------------------------+--------+--------------------+
- | ``>name`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``config`` | hash | |
- +-------------------------------------------------+--------+--------------------+
- | ``>hack.ttl`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>tm.healthParams.polling.url`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>tm.dataServer.polling.url`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>health.timepad`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>tm.polling.interval`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>health.threadPool`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>health.polling.interval`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>health.event-count`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>tm.crConfig.polling.url`` | number | |
- +-------------------------------------------------+--------+--------------------+
- | ``>CDN_name`` | number | |
- +-------------------------------------------------+--------+--------------------+
- | ``trafficMonitors`` | array | A collection of |
- | | | Traffic Monitors. |
- +-------------------------------------------------+--------+--------------------+
- | ``>profile`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>location`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>ip`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>status`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>ip6`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>port`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>hostName`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``deliveryServices`` | array | A collection of |
- | | | delivery services. |
- +-------------------------------------------------+--------+--------------------+
- | ``>xmlId`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>totalTpsThreshold`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>status`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>totalKbpsThreshold`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``profiles`` | array | A collection of |
- | | | profiles. |
- +-------------------------------------------------+--------+--------------------+
- | ``>parameters`` | hash | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.connection.timeout`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.polling.url`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.threshold.queryTime`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>history.count`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.threshold.availableBandwidthInKbps`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.threshold.loadavg`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>name`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>type`` | string | |
- +-------------------------------------------------+--------+--------------------+
-
- **Response Example**
- ::
-
- TBD
-
-|
-
-**GET /api/1.1/cdns/:name/configs/routing**
-
- Retrieves CDN routing information.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------+----------+-------------+
- | Name | Required | Description |
- +==========+==========+=============+
- | ``name`` | yes | |
- +----------+----------+-------------+
-
- **Response Properties**
-
- +-------------------------------------+---------+-----------------------------------+
- | Parameter | Type | Description |
- +=====================================+=========+===================================+
- | ``trafficServers`` | array | A collection of Traffic Servers. |
- +-------------------------------------+---------+-----------------------------------+
- | ``>profile`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>status`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>cacheGroup`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip6`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>port`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>deliveryServices`` | array | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>xmlId`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>remaps`` | array | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>hostName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>interfaceName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>type`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>hashId`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``stats`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>trafficOpsPath`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>cdnName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>trafficOpsVersion`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>trafficOpsUser`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>date`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>trafficOpsHost`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``cacheGroups`` | array | A collection of cache groups. |
- +-------------------------------------+---------+-----------------------------------+
- | ``>coordinates`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>longitude`` | number | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>latitude`` | number | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>name`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``config`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.admin`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tcoveragezone.polling.interval`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geolocation.polling.interval`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.expire`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>coveragezone.polling.url`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.minimum`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geolocation.polling.url`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>domain_name`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.ttls.AAAA`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.refresh`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.ttls.NS`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.ttls.SOA`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geolocation6.polling.interval`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.ttls.A`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.retry`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geolocation6.polling.url`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``trafficMonitors`` | array | A collection of Traffic Monitors. |
- +-------------------------------------+---------+-----------------------------------+
- | ``>profile`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>location`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>status`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip6`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>port`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>hostName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``deliveryServices`` | array | A collection of delivery |
- | | | services. |
- +-------------------------------------+---------+-----------------------------------+
- | ``>xmlId`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ttl`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geoEnabled`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>coverageZoneOnly`` | boolean | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>matchSets`` | array | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>protocol`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>matchList`` | array | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>>regex`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>>matchType`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>bypassDestination`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>maxDnsIpsForLocation`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>ttl`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>type`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ttls`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>A`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>SOA`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>NS`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>AAAA`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>missCoordinates`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>longitude`` | number | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>latitude`` | number | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>soa`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>admin`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>retry`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>minimum`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>refresh`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>expire`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``trafficRouters`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>profile`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>location`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>status`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip6`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>port`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>hostName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>apiPort`` | int | |
- +-------------------------------------+---------+-----------------------------------+
-
-
-**Response Example**
-
-::
- TBD
-
-
-.. _to-api-v11-cdn-dnsseckeys:
-
-DNSSEC Keys
-+++++++++++
-
-**GET /api/1.1/cdns/name/:name/dnsseckeys**
-
- Gets a list of dnsseckeys for CDN and all associated Delivery Services.
- Before returning response to user, check to make sure keys aren't expired. If they are expired, generate new ones.
- Before returning response to user, make sure dnssec keys for all delivery services exist. If they don't exist, create them.
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Route Parameters**
-
- +----------+----------+-------------+
- | Name | Required | Description |
- +==========+==========+=============+
- | ``name`` | yes | |
- +----------+----------+-------------+
-
- **Response Properties**
-
- +------------------------+--------+---------------------------------------------------------+
- | Parameter | Type | Description |
- +========================+========+=========================================================+
- | ``cdn name/ds xml_id`` | string | identifier for ds or cdn |
- +------------------------+--------+---------------------------------------------------------+
- | ``>zsk/ksk`` | array | collection of zsk/ksk data |
- +------------------------+--------+---------------------------------------------------------+
- | ``>>ttl`` | string | time-to-live for dnssec requests |
- +------------------------+--------+---------------------------------------------------------+
- | ``>>inceptionDate`` | string | epoch timestamp for when the keys were created |
- +------------------------+--------+---------------------------------------------------------+
- | ``>>expirationDate`` | string | epoch timestamp representing the expiration of the keys |
- +------------------------+--------+---------------------------------------------------------+
- | ``>>private`` | string | encoded private key |
- +------------------------+--------+---------------------------------------------------------+
- | ``>>public`` | string | encoded public key |
- +------------------------+--------+---------------------------------------------------------+
- | ``>>name`` | string | domain name |
- +------------------------+--------+---------------------------------------------------------+
- | ``version`` | string | API version |
- +------------------------+--------+---------------------------------------------------------+
-
-
- **Response Example** ::
-
- {
- "response": {
- "cdn1": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "foo.kabletown.com."
- },
- "ksk": {
- "name": "foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750",
- "ttl": "60"
- }
- },
- "ds-01": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "ds-01.foo.kabletown.com."
- },
- "ksk": {
- "name": "ds-01.foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750"
- }
- },
- ... repeated for each ds in the cdn
- },
- }
-
-|
-
-**GET /api/1.1/cdns/name/:name/dnsseckeys/delete**
-
- Delete dnssec keys for a cdn and all associated delivery services.
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Route Parameters**
-
- +----------+----------+----------------------------------------------------------+
- | Name | Required | Description |
- +==========+==========+==========================================================+
- | ``name`` | yes | name of the CDN for which you want to delete dnssec keys |
- +----------+----------+----------------------------------------------------------+
-
- **Response Properties**
-
- +--------------+--------+------------------+
- | Parameter | Type | Description |
- +==============+========+==================+
- | ``response`` | string | success response |
- +--------------+--------+------------------+
-
- **Response Example**
- ::
-
- {
- "response": "Successfully deleted dnssec keys for <cdn>"
- }
-
-|
-
-**POST /api/1.1/deliveryservices/dnsseckeys/generate**
-
- Generates zsk and ksk keypairs for a cdn and all associated delivery services.
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Properties**
-
- +-----------------------+---------+------------------------------------------------+
- | Parameter | Type | Description |
- +=======================+=========+================================================+
- | ``key`` | string | name of the cdn |
- +-----------------------+---------+------------------------------------------------+
- | ``name`` | string | domain name of the cdn |
- +-----------------------+---------+------------------------------------------------+
- | ``ttl`` | string | time to live |
- +-----------------------+---------+------------------------------------------------+
- | ``kskExpirationDays`` | string | Expiration (in days) for the key signing keys |
- +-----------------------+---------+------------------------------------------------+
- | ``zskExpirationDays`` | string | Expiration (in days) for the zone signing keys |
- +-----------------------+---------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "key": "cdn1",
- "name" "ott.kabletown.com",
- "ttl": "60",
- "kskExpirationDays": "365",
- "zskExpirationDays": "90"
- }
-
- **Response Properties**
-
- +--------------+--------+-----------------+
- | Parameter | Type | Description |
- +==============+========+=================+
- | ``response`` | string | response string |
- +--------------+--------+-----------------+
- | ``version`` | string | API version |
- +--------------+--------+-----------------+
-
- **Response Example** ::
-
-
- {
- "response": "Successfully created dnssec keys for cdn1"
- }
-
[45/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_router.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_router.txt b/docs/latest/_sources/admin/traffic_router.txt
new file mode 100644
index 0000000..01ab6b3
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_router.txt
@@ -0,0 +1,494 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+*****************************
+Traffic Router Administration
+*****************************
+.. contents::
+ :depth: 2
+ :backlinks: top
+
+Installing Traffic Router
+==========================
+The following are requirements to ensure an accurate set up:
+
+* CentOS 6
+* 4 vCPUs
+* 8GB RAM
+* Successful install of Traffic Ops
+* Successful install of Traffic Monitor
+* Administrative access to Traffic Ops
+
+.. Note:: Hardware requirements are generally doubled if DNSSEC is enabled
+
+1. If no suitable profile exists, create a new profile for Traffic Router.
+
+2. Enter the Traffic Router server into Traffic Ops, assign it to a Traffic Router profile, and ensure that its status is set to ``ONLINE``.
+3. Ensure the FQDN of the Traffic Monitor is resolvable in DNS. This FQDN must be resolvable by the clients expected to use this CDN.
+4. Install a traffic router: ``sudo yum install traffic_router``.
+5. Edit ``/opt/traffic_router/conf/traffic_monitor.properties`` and specify the correct online Traffic Monitor(s) for your CDN. See :ref:`rl-tr-config-files`
+ # traffic_monitor.properties: url that should normally point to this file
+ traffic_monitor.properties=file:/opt/traffic_router/conf/traffic_monitor.properties
+
+ # Frequency for reloading this file
+ # traffic_monitor.properties.reload.period=60000
+
+
+6. Start Tomcat: ``sudo service tomcat start``, and test lookups with dig and curl against that server.
+7. Snapshot CRConfig; See :ref:`rl-snapshot-crconfig`
+
+.. Note:: Once the CRConfig is snapshotted, live traffic will be sent to the new Traffic Routers provided that their status is set to ``ONLINE``.
+
+8. Ensure that the parent domain (e.g.: kabletown.net) for the CDN's top level domain (e.g.: cdn.kabletown.net) contains a delegation (NS records) for the new Traffic Router, and that the value specified matches the FQDN used in step 3.
+
+Configuring Traffic Router
+==========================
+
+.. Note:: Starting with Traffic Router 1.5, many of the configuration files under ``/opt/traffic_router/conf`` are only needed to override the default configuration values for Traffic Router. Most of the given default values will work well for any CDN. Critical values that must be changed are hostnames and credentials for communicating with other Traffic Control components such as Traffic Ops and Traffic Monitor.
+
+.. Note:: Pre-existing installations having configuration files in ``/opt/traffic_router/conf`` will still be used and honored for Traffic Router 1.5 and onward.
+
+For the most part, the configuration files and parameters that follow are used to get Traffic Router online and communicating with various Traffic Control components. Once Traffic Router is successfully communicating with Traffic Control, configuration is mostly performed in Traffic Ops, and is distributed throughout Traffic Control via the CRConfig snapshot process. See :ref:`rl-snapshot-crconfig` for more information. Please see the parameter documentation for Traffic Router in the Using Traffic Ops guide documented under :ref:`rl-ccr-profile` for parameters that influence the behavior of Traffic Router via the CRConfig.
+
+.. _rl-tr-config-files:
+
+Configuration files
+-------------------
+
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| File name | Parameter | Description | Default Value |
++============================+===========================================+=====================================================================================================+===================================================+
+| traffic_monitor.properties | traffic_monitor.bootstrap.hosts | Traffic Monitor FQDNs and port if necessary, separated by a semicolon (;) | N/A |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | traffic_monitor.bootstrap.local | Use only the Traffic Monitors specified in config file | false |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | traffic_monitor.properties | Path to the traffic_monitor.properties file; used internally to monitor the file for changes | /opt/traffic_router/traffic_monitor.properties |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | traffic_monitor.properties.reload.period | The interval in milliseconds which Traffic Router will reload this configuration file | 60000 |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| dns.properties | dns.tcp.port | TCP port that Traffic Router will use for incoming DNS requests | 53 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | dns.tcp.backlog | Maximum length of the queue for incoming TCP connection requests | 0 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | dns.udp.port | UDP port that Traffic Router will use for incoming DNS requests | 53 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | dns.max-threads | Maximum number of threads used to process incoming DNS requests | 1000 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | dns.zones.dir | Path to auto generated zone files for reference | /opt/traffic_router/var/auto-zones |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | dns.routing.name | The label (A/AAAA) Traffic Router will use for the entry point for a DNS delivery service | edge (e.g.: edge.mydeliveryservice.kabletown.net) |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| traffic_ops.properties | traffic_ops.username | Username to access the APIs in Traffic Ops (must be in the admin role) | admin |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | traffic_ops.password | Password for the user specified in traffic_ops.username | N/A |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| http.properties | http.routing.name | The label (A/AAAA) Traffic Router will use for the entry point for an HTTP delivery service | tr (e.g.: tr.mydeliveryservice.kabletown.net) |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| cache.properties | cache.geolocation.database | Full path to the local copy of the MaxMind geolocation binary database file | /opt/traffic_router/db/GeoIP2-City.mmdb |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.geolocation.database.refresh.period | The interval in milliseconds which Traffic Router will poll for a new geolocation database | 604800000 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.czmap.database | Full path to the local copy of the coverage zone file | /opt/traffic_router/db/czmap.json |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.czmap.database.refresh.period | The interval in milliseconds which Traffic Router will poll for a new coverage zone file | 10800000 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.health.json | Full path to the local copy of the health state | /opt/traffic_router/db/health.json |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.health.json.refresh.period | The interval in milliseconds which Traffic Router will poll for a new health state file | 1000 |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.config.json | Full path to the local copy of the CRConfig | /opt/traffic_router/db/cr-config.json |
+| +-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| | cache.config.json.refresh.period | The interval in milliseconds which Traffic Router will poll for a new CRConfig | 60000 |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+| log4j.properties | various parameters | Configuration of log4j is documented on their site; adjust as necessary based on needs | N/A |
++----------------------------+-------------------------------------------+-----------------------------------------------------------------------------------------------------+---------------------------------------------------+
+
+.. _rl-tr-dnssec:
+
+DNSSEC
+======
+
+Overview
+--------
+Domain Name System Security Extensions (DNSSEC) is a set of extensions to DNS that provides a cryptographic mechanism for resolvers to verify the authenticity of responses served by an authoritative DNS server.
+
+Several RFCs (4033, 4044, 4045) describe the low level details and define the extensions, RFC 7129 provides clarification around authenticated denial of existence of records, and finally RFC 6781 describes operational best practices for administering an authoritative DNSSEC enabled DNS server. The authenticated denial of existence RFC describes how an authoritative DNS server responds in NXDOMAIN and NODATA scenarios when DNSSEC is enabled.
+
+Traffic Router currently supports DNSSEC with NSEC, however, NSEC3 and more configurable options will be provided in the future.
+
+Operation
+---------
+Upon startup or a configuration change, Traffic Router obtains keys from the keystore API in Traffic Ops which returns key signing keys (KSK) and zone signing keys (ZSK) for each delivery service that is a subdomain off the CDN's top level domain (TLD), in addition to the keys for the CDN TLD itself. Each key has timing information that allows Traffic Router to determine key validity (expiration, inception, and effective dates) in addition to the appropriate TTL to use for the DNSKEY record(s). All TTLs are configurable parameters; see the :ref:`rl-ccr-profile` documentation for more information.
+
+Once Traffic Router obtains the key data from the API, it converts each public key into the appropriate record types (DNSKEY, DS) to place in zones and uses the private key to sign zones. DNSKEY records are added to each delivery service's zone (e.g.: mydeliveryservice.cdn.kabletown.net) for every valid key that exists, in addition to the CDN TLD's zone. A DS record is generated from each zone's KSK and is placed in the CDN TLD's zone (e.g.: cdn.kabletown.net); the DS record for the CDN TLD must be placed in its parent zone, which is not managed by Traffic Control.
+
+The DNSKEY to DS record relationship allows resolvers to validate signatures across zone delegation points; with Traffic Control, we control all delegation points below the CDN's TLD, **however, the DS record for the CDN TLD must be placed in the parent zone (e.g.: kabletown.net), which is not managed by Traffic Control**. As such, the DS record (available in the Traffic Ops DNSSEC administration UI) must be placed in the parent zone prior to enabling DNSSEC, and prior to generating a new CDN KSK. Based on your deployment's DNS configuration, this might be a manual process or it might be automated; either way, extreme care and diligence must be taken and knowledge of the management of the upstream zone is imperative for a successful DNSSEC deployment.
+
+Rolling Zone Signing Keys
+-------------------------
+Traffic Router currently follows the zone signing key pre-publishing operational best practice described in `section 4.1.1.1 of RFC 6781`_. Once DNSSEC is enabled for a CDN in Traffic Ops, key rolls are triggered via Traffic Ops via the automated key generation process, and Traffic Router selects the active zone signing keys based on the expiration information returned from the keystore API in Traffic Ops.
+
+.. _section 4.1.1.1 of RFC 6781: https://tools.ietf.org/html/rfc6781#section-4.1.1.1
+
+Troubleshooting and log files
+=============================
+Traffic Router log files are in ``/opt/traffic_router/var/log``, and Tomcat log files are in ``/opt/tomcat/logs``. Application related logging is in ``/opt/traffic_router/var/log/traffic_router.log``, while access logs are written to ``/opt/traffic_router/var/log/access.log``.
+
+Event Log File Format
+=====================
+
+Summary
+-------
+
+All access events to Traffic Router are logged to the file ``/opt/traffic_router/var/log/access.log``
+This file grows up to 200Mb and gets rolled into older log files, 10 log files total are kept (total of up to 2Gb of logged events per traffic router)
+
+Traffic Router logs access events in a format that largely following `ATS event logging format
+<https://docs.trafficserver.apache.org/en/6.0.x/admin/event-logging-formats.en.html>`_
+
+--------------
+
+Sample Message
+--------------
+
+Items within brackets below are detailed under the HTTP and DNS sections
+::
+
+ 144140678.000 qtype=DNS chi=192.168.10.11 ttms=789 [Fields Specific to the DNS request] rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the DNS result]
+ 144140678.000 qtype=HTTP chi=192.168.10.11 ttms=789 [Fields Specific to the HTTP request] rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" [Fields Specific to the HTTP result]
+
+.. Note:: The above message samples contain fields that are always present for every single access event to Traffic Router
+
+**Message Format**
+- Each event that is logged is a series of space separated key value pairs except for the first item.
+- The first item is always the epoch in seconds with a decimal field precision of up to milliseconds
+- Each key value pair is in the form of unquoted string, equals character, optionally quoted string
+- Values that are quoted strings may contain space characters
+- Values that are not quoted should not contains any space characters
+
+.. Note:: Any value that is a single dash character or a dash character enclosed in quotes represents an empty value
+
+--------
+
+Fields Always Present
+---------------------
+
++------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
+|Name |Description |Data |
++======+=================================================================================+===========================================================================+
+|qtype |Whether the request was for DNS or HTTP |Always DNS or HTTP |
++------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
+|chi |The IP address of the requester |Depends on whether this was a DNS or HTTP request, see below sections |
++------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
+|ttms |The amount of time in milliseconds it took Traffic Router to process the request |A number greater than or equal to zero |
++------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
+|rtype |Routing Result Type |One of ERROR, CZ, GEO, MISS, STATIC_ROUTE, DS_REDIRECT, DS_MISS, INIT, FED |
++------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
+|rloc |GeoLocation of result |Latitude and Longitude in Decimal Degrees |
++------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
+|rdtl |Result Details Associated with unusual conditions |One of DS_NOT_FOUND, DS_NO_BYPASS, DS_BYPASS, DS_CZ_ONLY |
++------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
+|rerr |Message about internal Traffic Router Error |String |
++------+---------------------------------------------------------------------------------+---------------------------------------------------------------------------+
+
+**rtype meanings**
+
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|Name |Meaning |
++=============+========================================================================================================================================================================+
+|ERROR |An internal error occurred within Traffic Router, more details may be found in the rerr field |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|CZ |The result was derived from Coverage Zone data based on the address in the chi field |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|GEO |The result was derived from geolocation service based on the address in the chi field |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|MISS |Traffic Router was unable to resolve a DNS request or find a cache for the requested resource |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|STATIC_ROUTE |_*DNS Only*_ No DNS Delivery Service supports the hostname portion of the requested url |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_MISS |_*HTTP Only*_ No HTTP Delivery Service supports either this request's URL path or headers |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_REDIRECT |The result is using the Bypass Destination configured for the matched Delivery Service when that Delivery Service is unavailable or does not have the requested resource|
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+|FED |_*DNS Only*_ The result was obtained through federated coverage zone data outside of any delivery service |
++-------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+**rdtl meanings**
+
++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|Name |Meaning |
++==========================+============================================================================================================================================+
+|DS_NOT_FOUND |Always goes with rtypes STATIC_ROUTE and DS_MISS |
++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_BYPASS |Used Bypass Destination for Redirect of Delivery Service |
++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_NO_BYPASS |No valid Bypass Destination is configured for the matched Delivery Service and the delivery service does not have the requested resource |
++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_CZ_ONLY |The selected Delivery Service only supports resource lookup based on Coverage Zone data |
++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|DS_CLIENT_GEO_UNSUPPORTED |Traffic Router did not find a resource supported by coverage zone data and was unable to determine the geolocation of the requesting client |
++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+|GEO_NO_CACHE_FOUND |Traffic Router could not find a resource via geolocation data based on the requesting client's geolocation |
++--------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+
+---------------
+
+HTTP Specifics
+--------------
+
+Sample Message
+::
+
+ 1452197640.936 qtype=HTTP chi=69.241.53.218 url="http://ccr.mm-test.jenkins.cdnlab.comcast.net/some/asset.m3u8" cqhm=GET cqhv=HTTP/1.1 rtype=GEO rloc="40.252611,58.439389" rdtl=- rerr="-" pssc=302 ttms=0 rurl="http://odol-atsec-sim-114.mm-test.jenkins.cdnlab.comcast.net:8090/some/asset.m3u8" rh="Accept: */*" rh="myheader: asdasdasdasfasg"
+
+**Request Fields**
+
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+|Name |Description |Data |
++=====+=========================================================================================================================================+===========================================+
+|url |Requested URL with query string |String |
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+|cqhm |Http Method |e.g GET, POST |
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+|cqhv |Http Protocol Version |e.g. HTTP/1.1 |
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+|rh |One or more of these key value pairs may exist in a logged event and are controlled by the configuration of the matched Delivery Service |Key value pair of the format "name: value" |
++-----+-----------------------------------------------------------------------------------------------------------------------------------------+-------------------------------------------+
+
+**Response Fields**
+
++-----+----------------------------------------------------------+------------+
+|Name |Description |Data |
++=====+==========================================================+============+
+|rurl |The resulting url of the resource requested by the client |A URL String|
++-----+----------------------------------------------------------+------------+
+
+------------
+
+DNS Specifics
+-------------
+
+Sample Message
+::
+
+ 144140678.000 qtype=DNS chi=192.168.10.11 ttms=123 xn=65535 fqdn=www.example.com. type=A class=IN ttl=12345 rcode=NOERROR rtype=CZ rloc="40.252611,58.439389" rdtl=- rerr="-" ans="192.168.1.2 192.168.3.4 0:0:0:0:0:ffff:c0a8:102 0:0:0:0:0:ffff:c0a8:304"
+
+**Request Fields**
+
+.. _qname: http://www.zytrax.com/books/dns/ch15/#qname
+
+.. _qtype: http://www.zytrax.com/books/dns/ch15/#qtype
+
++------+------------------------------------------------------------------+--------------------------------------------------------+
+|Name |Description |Data |
++======+==================================================================+========================================================+
+|xn |The ID from the client DNS request header |a number from 0 to 65535 |
++------+------------------------------------------------------------------+--------------------------------------------------------+
+|fqdn |The qname field from the client DNS request message (i.e. The |A series of DNS labels/domains separated by '.' |
+| |fully qualified domain name the client is requesting be resolved) |characters and ending with a '.' character (see qname_) |
++------+------------------------------------------------------------------+--------------------------------------------------------+
+|type |The qtype field from the client DNS request message (i.e. |Examples are A (IpV4), AAAA (IpV6), NS (Name Service), |
+| |the type of resolution that's requested such as IPv4, IPv6) | SOA (Start of Authority), and CNAME, (see qtype_) |
++------+------------------------------------------------------------------+--------------------------------------------------------+
+|class |The qclass field from the client DNS request message (i.e. The |Either IN (Internet resource) or ANY (Traffic router |
+| |class of resource being requested) | rejects requests with any other value of class) |
++------+------------------------------------------------------------------+--------------------------------------------------------+
+
+**Response Fields**
+
++------+---------------------------------------------------------------------+-----------------------------------------------------+
+|Name | Description | Data |
++======+=====================================================================+=====================================================+
+|ttl | The 'time to live' in seconds for the answer provided by Traffic |A number from 0 to 4294967295 |
+| | Router (clients can reliably use this answer for this long without | |
+| | re-querying traffic router) | |
++------+---------------------------------------------------------------------+-----------------------------------------------------+
+|rcode | The result code for the DNS answer provided by Traffic Router | One of NOERROR (success), NOTIMP (request is not |
+| | | NOTIMP (request is not supported), |
+| | | REFUSED (request is refused to be answered), or |
+| | | NXDOMAIN (the domain/name requested does not exist) |
++------+---------------------------------------------------------------------+-----------------------------------------------------+
+
+.. _rl-tr-ngb:
+
+GeoLimit Failure Redirect feature
+=================================
+
+Overview
+--------
+This feature is also called 'National GeoBlock' feature which is short for 'NGB' feature. In this section, the acronym 'NGB' will be used for this feature.
+
+In the past, if the Geolimit check fails (for example, the client ip is not in the 'US' region but the geolimit is set to 'CZF + US'), the router will return 503 response; but with this feature, when the check fails, it will return 302 if the redirect url is set in the delivery service.
+
+The Geolimit check failure has such scenarios:
+1) When the GeoLimit is set to 'CZF + only', if the client ip is not in the the CZ file, the check fails
+2) When the GeoLimit is set to any region, like 'CZF + US', if the client ip is not in such region, and the client ip is not in the CZ file, the check fails
+
+
+Configuration
+-------------
+To enable the NGB feature, the DS must be configured with the proper redirect url. And the setting lays at 'Delivery Services'->Edit->'GeoLimit Redirect URL'. If no url is put in this field, the feature is disabled.
+
+The URL has 3 kinds of formats, which have different meanings:
+
+1. URL with no domain. If no domain is in the URL (like 'vod/dance.mp4'), the router will try to find a proper cache server within the delivery service and return the redirect url with the format like 'http://<cache server name>.<delivery service's FQDN>/<configured relative path>'
+
+2. URL with domain that matches with the delivery service. For this URL, the router will also try to find a proper cache server within the delivery service and return the same format url as point 1.
+
+3. URL with domain that doesn't match with the delivery service. For this URL, the router will return the configured url directly to the client.
+
+.. _rl-tr-steering:
+
+Steering feature
+================
+
+Overview
+--------
+A Steering delivery service is a delivery service that is used to "steer" traffic to other delivery services. A Steering delivery service will have target delivery services configured for it with weights assigned to them. Traffic Router uses the weights to make a consistent hash ring which it then uses to make sure that requests are routed to a target based on the configured weights. This consistent hash ring is separate from the consistent hash ring used in cache selection.
+
+Special regular expressions called Filters can also be configured for target delivery services to pin traffic to a specific delivery service. For example, if a filter called .*/news/.* for a target called target-ds-1 is created, any requests to traffic router with 'news' in them will be routed to target-ds-1. This will happen regardless of the configured weights.
+
+A client can bypass the steering functionality by providing a header called X-TC-Steering-Option with the xml_id of the target delivery service to route to. When Traffic Router receives this header it will route to the requested target delivery service regardless of weight configuration.
+
+Some other points of interest:
+- Steering is currently only available for HTTP delivery services that are a part of the same CDN.
+- A new role called STEERING has been added to the traffic ops database. Only users with Admin or Steering privileges can modify steering assignments for a Delivery Service.
+- A new API has been created in Traffic Ops under /internal. This API is used by a Steering user to add filters and modify assignments. (Filters can only be added via the API).
+- Traffic Router uses the steering API in Traffic Ops to poll for steering assignments, the assignments are then used when routing traffic.
+
+A couple simple use cases for steering are:
+
+#. Migrating traffic from one delivery service to another over time.
+#. Trying out new functionality for a subset of traffic with an experimental delivery service.
+#. Load balancing between delivery services.
+
+
+
+Configuration
+-------------
+
+The following needs to be completed for Steering to work correctly:
+
+#. Two target delivery services are created in Traffic Ops. They must both be HTTP delivery services part of the same CDN.
+#. A delivery service with type STEERING is created in Traffic Ops.
+#. Target delivery services are assigned to the steering delivery service using Traffic Ops.
+#. A user with the role of Steering is created.
+#. Using the API, the steering user assigns weights to the target delivery services.
+#. If desired, the steering user can create filters for the target delivery services.
+
+For more information see the `steering how-to guide <quick_howto/steering.html>`_.
+
+HTTPS for Http Type Delivery Services
+=====================================
+
+Starting with version 1.7 Traffic Router added the ability to allow https traffic between itself and clients on a per http type delivery service basis.
+
+.. Warning::
+ The establishing of an HTTPS connection is much more computationally demanding than an HTTP connection.
+ Since each client will in turn get redirected to ATS, Traffic Router is most always creating a new HTTPS connection for all HTTPS traffic.
+ It is likely to mean that an existing Traffic Router will have some decrease in performance depending on the amount of https traffic you want to support
+ As noted for DNSSEC, you may need to plan to scale Traffic Router vertically and/or horizontally to handle the new load
+
+The summary for setting up https is to:
+
+#. Select one of 'https', 'http and https', or 'http to https' for the delivery service
+#. Generate private keys for the delivery service using a wildcard domain such as ``*.my-delivery-service.my-cdn.example.com``
+#. Obtain and import signed certificate chain
+#. Snapshot CR Config
+
+Clients may make HTTPS requests delivery services only after Traffic Router receives the certificate chain from Traffic Ops and the new CR Config.
+
+Protocol Options
+----------------
+
+*https only*
+ Traffic Router will only redirect (send a 302) to clients communicating with a secure connection, all other clients will receive a 503
+*http and https*
+ Traffic Router will redirect both secure and non-secure clients
+*http to https*
+ Traffic Router will redirect non-secure clients with a 302 and a location that is secure (i.e. starting with 'https' instead of 'http'), secure clients will remain on https
+*http*
+ Any secure client will get an SSL handshake error. Non-secure clients will experience the same behavior as prior to 1.7
+
+Certificate Retrieval
+---------------------
+
+.. Warning::
+ If you have https delivery services in your CDN, Traffic Router will not accept **any** connections until it is able to
+ fetch certificates from Traffic Ops and load them into memory. Traffic Router does not persist certificates to the java keystore or anywhere else.
+
+Traffic Router fetches certificates into memory:
+
+* At startup time
+* When it receives a new CR Config
+* Once an hour from whenever the most recent of the last of the above occurred
+
+.. Note::
+ To adjust the frequency when Traffic Router fetches certificates add the parameter 'certificates.polling.interval' to CR Config and
+ setting it to the desired time in milliseconds.
+
+.. Note::
+ Taking a snapshot of CR Config may be used at times to avoid waiting the entire polling cycle for a new set of certificates.
+
+.. Warning::
+ If a snapshot of CR Config is made that involves a delivery service missing its certificates, Traffic Router will ignore **ALL** changes in that CR-Config
+ until one of the following occurs:
+ * It receives certificates for that delivery service
+ * Another snapshot of CR Config is created and the delivery service without certificates is changed so it's HTTP protocol is set to 'http'
+
+Certificate Chain Ordering
+--------------------------
+
+The ordering of certificates within the certificate bundle matters. It must be:
+
+#. Primary Certificate (e.g. the one created for ``*.my-delivery-service.my-cdn.example.com``)
+#. Intermediate Certificate(s)
+#. Root Certificate from CA (optional)
+
+.. Warning::
+ If something is wrong with the certificate chain (e.g. the order of the certificates is backwards or for the wrong domain) the
+ client will get an SSL handshake. Inspection of /opt/tomcat/logs/catalina.out is likely to yield information to reveal this.
+
+To see the ordering of certificates you may have to manually split up your certificate chain and use openssl on each individual certificate
+
+Suggested Way of Setting up an HTTPS Delivery Service
+-----------------------------------------------------
+
+Do the following in Traffic Ops:
+
+#. Select one of 'https', 'http and https', or 'http to https' for the protocol field of a delivery service and click 'Save'.
+#. Click 'Manage SSL Keys'.
+#. Click 'Generate New Keys'.
+#. Copy the contents of the Certificate Signing Request field and save it locally.
+#. Click 'Load Keys'.
+#. Select 'http' for the protocol field of the delivery service and click 'Save' (to avoid preventing other CR Config updates from being blocked by Traffic Router)
+#. Follow your standard procedure for obtaining your signed certificate chain from a CA.
+#. After receiving your certificate chain import it into Traffic Ops.
+#. Edit the delivery service.
+#. Restore your original choice for the protocol field and click save.
+#. Click 'Manage SSL Keys'.
+#. Click 'Paste Existing Keys'.
+#. Paste the certificate chain into the CRT field.
+#. Click 'Load Keys'.
+#. Take a new snapshot of CR Config.
+
+Once this is done you should be able to test you are getting correctly redirected by Traffic Router using curl commands to https destinations on your delivery service.
+
+A new testing tool was created for load testing traffic router, it allows you to generate requests from your local box to multiple delivery services of a single cdn.
+You can control which cdn, delivery services, how many transactions per delivery service, and how many concurrent requests.
+During the test it will provide feedback about request latency and transactions per second.
+
+While it is running it is suggested that you monitor your Traffic Router nodes for memory and CPU utilization.
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_server.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_server.rst.txt b/docs/latest/_sources/admin/traffic_server.rst.txt
deleted file mode 100644
index 1b99ce0..0000000
--- a/docs/latest/_sources/admin/traffic_server.rst.txt
+++ /dev/null
@@ -1,71 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-*****************************
-Traffic Server Administration
-*****************************
-Installing Traffic Server
-=========================
-1. Select **Servers** in the Traffic Ops web interface.
-2. Scroll to the bottom of the page and click **Add Server**.
-3. Complete the *Required Info*: section.
-4. Click **Submit**.
-5. Click **Save**.
-
-.. 6. Click **Online Server**.
-.. 7. From the Set status of this machine to ONLINE? screen, click **OK**.
-
-.. _reference-traffic-ops-ort:
-
-Configuring Traffic Server
-==========================
-All of the Traffic Server application configuration files are generated by Traffic Ops and installed by way of the traffic_ops_ort.pl script.
-
-
-**traffic_ops_ort.pl**
- The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below: ::
-
- $ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net
- Thu May 26 15:52:11 UTC 2016
- ====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
- Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL> <Traffic_Ops_Login> [optional flags]
- <Mode> = interactive - asks questions during config process.
- <Mode> = report - prints config differences and exits.
- <Mode> = badass - attempts to fix all config differences that it can.
- <Mode> = syncds - syncs delivery services with what is configured in Traffic Ops.
-
- <Log_Level> => ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, NONE
-
- <Traffic_Ops_URL> = URL to Traffic Ops host. Example: https://trafficops.company.net
-
- <Traffic_Ops_Login> => Example: 'username:password'
-
- [optional flags]:
- dispersion=<time> => wait a random number between 0 and <time> before starting. Default = 300.
- retries=<number> => retry connection to Traffic Ops URL <number> times. Default = 3.
- wait_for_parents=<0|1> => do not update if parent_pending = 1 in the update json. Default = 1, wait for parents.
- ====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
- $
-
-
- For initial configuration or when major changes (like a Profile change) need to be made, run the script in "badass mode". All required rpm packages will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted. Example run below: ::
-
- run here
-
- For "every day changes" such as adding deliveryservices or changing records.config parameters caches should run the script in "syncds" mode out of cron. Example crontab entry: ::
-
- */15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password > /tmp/ort/syncds.log 2>&1
-
- .. Note:: <disclaimer on what is "hot changeable" here>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_server.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_server.txt b/docs/latest/_sources/admin/traffic_server.txt
new file mode 100644
index 0000000..1b99ce0
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_server.txt
@@ -0,0 +1,71 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+*****************************
+Traffic Server Administration
+*****************************
+Installing Traffic Server
+=========================
+1. Select **Servers** in the Traffic Ops web interface.
+2. Scroll to the bottom of the page and click **Add Server**.
+3. Complete the *Required Info*: section.
+4. Click **Submit**.
+5. Click **Save**.
+
+.. 6. Click **Online Server**.
+.. 7. From the Set status of this machine to ONLINE? screen, click **OK**.
+
+.. _reference-traffic-ops-ort:
+
+Configuring Traffic Server
+==========================
+All of the Traffic Server application configuration files are generated by Traffic Ops and installed by way of the traffic_ops_ort.pl script.
+
+
+**traffic_ops_ort.pl**
+ The traffic_ops_ort.pl should be installed on all caches (by puppet or other non Traffic Ops means), usually in /opt/ort. It is used to do initial install of the config files when the cache is being deployed, and to keep the config files up to date when the cache is already in service. The usage message of the script is shown below: ::
+
+ $ sudo ./traffic_ops_ort.pl syncds warn https://to.cdn.kabletown.net
+ Thu May 26 15:52:11 UTC 2016
+ ====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
+ Usage: ./traffic_ops_ort.pl <Mode> <Log_Level> <Traffic_Ops_URL> <Traffic_Ops_Login> [optional flags]
+ <Mode> = interactive - asks questions during config process.
+ <Mode> = report - prints config differences and exits.
+ <Mode> = badass - attempts to fix all config differences that it can.
+ <Mode> = syncds - syncs delivery services with what is configured in Traffic Ops.
+
+ <Log_Level> => ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, NONE
+
+ <Traffic_Ops_URL> = URL to Traffic Ops host. Example: https://trafficops.company.net
+
+ <Traffic_Ops_Login> => Example: 'username:password'
+
+ [optional flags]:
+ dispersion=<time> => wait a random number between 0 and <time> before starting. Default = 300.
+ retries=<number> => retry connection to Traffic Ops URL <number> times. Default = 3.
+ wait_for_parents=<0|1> => do not update if parent_pending = 1 in the update json. Default = 1, wait for parents.
+ ====-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-====
+ $
+
+
+ For initial configuration or when major changes (like a Profile change) need to be made, run the script in "badass mode". All required rpm packages will be installed, all Traffic Server config files will be fetched and installed, and (if needed) the Traffic Server application will be restarted. Example run below: ::
+
+ run here
+
+ For "every day changes" such as adding deliveryservices or changing records.config parameters caches should run the script in "syncds" mode out of cron. Example crontab entry: ::
+
+ */15 * * * * /opt/ort/traffic_ops_ort.pl syncds warn https://traffops.kabletown.net admin:password > /tmp/ort/syncds.log 2>&1
+
+ .. Note:: <disclaimer on what is "hot changeable" here>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_stats.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_stats.rst.txt b/docs/latest/_sources/admin/traffic_stats.rst.txt
deleted file mode 100644
index ae9d91b..0000000
--- a/docs/latest/_sources/admin/traffic_stats.rst.txt
+++ /dev/null
@@ -1,187 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-****************************
-Traffic Stats Administration
-****************************
-
-Traffic Stats consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.
-
-Installation
-========================
-
-**Installing Traffic Stats:**
-
- - Download the Traffic Stats RPM from the traffic control `downloads <https://trafficcontrol.apache.org/downloads/index.html>`_ page.
- - Copy the Traffic Stats RPM to your server
- - sudo rpm -ivh <traffic_stats rpm>
-
-**Installing InfluxDB:**
-
- **As of Traffic Stats 1.8.0, InfluxDb 1.0.0 or higher is required. For InfluxDb versions less than 1.0.0 use Traffic Stats 1.7.x**
-
- In order to store traffic stats data you will need to install `InfluxDB <https://docs.influxdata.com/influxdb/latest/introduction/installation/>`_. While not required, it is recommended to use some sort of high availability option like `Influx enterprise <https://portal.influxdata.com/>`_, `Influxdb Relay <https://github.com/influxdata/influxdb-relay>`_, or another `high availability option <https://www.influxdata.com/high-availability/>`_.
-
-
-**Installing Grafana:**
-
- Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and can be accessed by Traffic Ops. Documentation on installing Grafana can be found on the `Grafana website <http://docs.grafana.org/installation/>`_.
-
-Configuration
-=========================
-
-**Configuring Traffic Stats:**
-
- Traffic Stats' configuration file can be found in /opt/traffic_stats/conf/traffic_stats.cfg.
- The following values need to be configured:
-
- - *toUser:* The user used to connect to Traffic Ops
- - *toPasswd:* The password to use when connecting to Traffic Ops
- - *toUrl:* The URL of the Traffic Ops server used by Traffic Stats
- - *influxUser:* The user to use when connecting to InfluxDB (if configured on InfluxDB, else leave default)
- - *influxPassword:* That password to use when connecting to InfluxDB (if configured, else leave blank)
- - *pollingInterval:* The interval at which Traffic Monitor is polled and stats are stored in InfluxDB
- - *statusToMon:* The status of Traffic Monitor to poll (poll ONLINE or OFFLINE traffic monitors)
- - *seelogConfig:* The absolute path of the seelong config file
- - *dailySummaryPollingInterval:* The interval, in seconds, at which Traffic Stats checks to see if daily stats need to be computed and stored.
- - *cacheRetentionPolicy:* The default retention policy for cache stats
- - *dsRetentionPolicy:* The default retention policy for deliveryservice stats
- - *dailySummaryRetentionPolicy:* The retention policy to be used for the daily stats
- - *influxUrls:* An array of influxdb hosts for Traffic Stats to write stats to.
-
-**Configuring InfluxDB:**
-
- As mentioned above, it is recommended that InfluxDb be running in some sort of high availability configuration. There are several ways to achieve high availabilty so it is best to consult the high availability options on the `InfuxDB website <https://www.influxdata.com/high-availability/>`_.
-
- Once InfluxDB is installed and configured, databases and retention policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the `overview <../overview/traffic_stats.html>`_ page.
-
- To easily create databases, retention policies, and continuous queries, run create_ts_databases from the /opt/traffic_stats/influxdb_tools directory on your Traffic Stats server. See the `InfluxDb Tools <traffic_stats.html#influxdb-tools>`_ section below for more information.
-
-**Configuring Grafana:**
-
- In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (more information below) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been configured and that data has been written to it. If this is not true, you will not see any graphs.
-
- - Login to grafana as an admin user http://grafana_url:3000/login
- - Choose Data Sources and then Add New
- - Enter the necessary information to configure your data source
- - Click on the 'Home' dropdown at the top of the screen and choose New at the bottom
- - Click on the green menu bar (with 3 lines) at the top and choose Add Panel -> Graph
- - Where it says 'No Title (click here)' click and choose edit
- - Choose your data source at the bottom
- - You can have grafana help you create a query, or you can create your own. Here is a sample query:
-
- ``SELECT sum(value)*1000 FROM "monthly"."bandwidth.cdn.1min" WHERE $timeFilter GROUP BY time(60s), cdn``
- - Once you have the graph the way you want it, click the 'Save Dashboard' button at the top
- - You should now have a new saved graph
-
- In order for Traffic Ops users to see Grafana graphs, Grafana will need to allow anonymous access. Information on how to configure anonymous access can be found on the configuration page of the `Grafana Website <http://docs.grafana.org/installation/configuration/#authanonymous>`_.
-
- Traffic Ops uses custom dashboards to display information about individual delivery services or cache groups. In order for the custom graphs to display correctly, the `traffic_ops_*.js <https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_stats/grafana/>`_ files need to be in the ``/usr/share/grafana/public/dashboards/`` directory on the grafana server. If your Grafana server is the same as your Traffic Stats server the RPM install process will take care of putting the files in place. If your grafana server is different from your Traffic Stats server, you will need to manually copy the files to the correct directory.
-
- More information on custom scripted graphs can be found in the `scripted dashboards <http://docs.grafana.org/reference/scripting/>`_ section of the Grafana documentation.
-
-**Configuring Traffic Ops for Traffic Stats:**
-
- - The influxDb servers need to be added to Traffic Ops with profile = InfluxDB. Make sure to use port 8086 in the configuration.
- - The traffic stats server should be added to Traffic Ops with profile = Traffic Stats.
- - Parameters for which stats will be collected are added with the release, but any changes can be made via parameters that are assigned to the Traffic Stats profile.
-
-**Configuring Traffic Ops to use Grafana Dashboards**
-
- To configure Traffic Ops to use Grafana Dashboards, you need to enter the following parameters and assign them to the GLOBAL profile. This assumes you followed the above instructions to install and configure InfluxDB and Grafana. You will need to place 'cdn-stats','deliveryservice-stats', and 'daily-summary' with the name of your dashboards.
-
- +---------------------------+------------------------------------------------------------------------------------------------+
- | parameter name | parameter value |
- +===========================+================================================================================================+
- | all_graph_url | https://<grafana_url>/dashboard/db/deliveryservice-stats |
- +---------------------------+------------------------------------------------------------------------------------------------+
- | cachegroup_graph_url | https://<grafanaHost>/dashboard/script/traffic_ops_cachegroup.js?which= |
- +---------------------------+------------------------------------------------------------------------------------------------+
- | deliveryservice_graph_url | https://<grafanaHost>/dashboard/script/traffic_ops_devliveryservice.js?which= |
- +---------------------------+------------------------------------------------------------------------------------------------+
- | server_graph_url | https://<grafanaHost>/dashboard/script/traffic_ops_server.js?which= |
- +---------------------------+------------------------------------------------------------------------------------------------+
- | visual_status_panel_1 | https://<grafanaHost>/dashboard-solo/db/cdn-stats?panelId=2&fullscreen&from=now-24h&to=now-60s |
- +---------------------------+------------------------------------------------------------------------------------------------+
- | visual_status_panel_2 | https://<grafanaHost>/dashboard-solo/db/cdn-stats?panelId=1&fullscreen&from=now-24h&to=now-60s |
- +---------------------------+------------------------------------------------------------------------------------------------+
- | daily_bw_url | https://<grafanaHost>/dashboard-solo/db/daily-summary?panelId=1&fullscreen&from=now-3y&to=now |
- +---------------------------+------------------------------------------------------------------------------------------------+
- | daily_served_url | https://<grafanaHost>/dashboard-solo/db/daily-summary?panelId=2&fullscreen&from=now-3y&to=now |
- +---------------------------+------------------------------------------------------------------------------------------------+
-
-InfluxDb Tools
-=========================
-
-Under the Traffic Stats source directory there is a directory called influxdb_tools. These tools are meant to be used as one-off scripts to help a user quickly get new databases and continuous queries setup in influxdb.
-They are specific for traffic stats and are not meant to be generic to influxdb. Below is an brief description of each script along with how to use it.
-
-**create_ts_databases**
- This script creates all `databases <https://docs.influxdata.com/influxdb/latest/concepts/key_concepts/#database>`_, `retention policies <https://docs.influxdata.com/influxdb/latest/concepts/key_concepts/#retention-policy>`_, and `continuous queries <https://docs.influxdata.com/influxdb/v0.11/query_language/continuous_queries/>`_ required by traffic stats.
-
- **How to use create_ts_databases:**
-
- Pre-Requisites:
-
- 1. Go 1.4 or later
- 2. configured $GOPATH (e.g. export GOPATH=~/go)
-
- Using create_ts_databases.go
-
- 1. go get github.com/influxdata/influxdb
-
- 2. go build create_ts_databases.go
-
- 3. Run it:
- - ./create_ts_databases -help
- - optional flags:
- - influxUrl - The influxdb url and port
- - replication - The number of nodes in the cluster
- - user - The user to use
- - password - The password to use
- - example: ./create_ts_databases -influxUrl=localhost:8086 -replication=3 -user=joe -password=mysecret
-
-**sync_ts_databases**
- This script is used to sync one influxdb environment to another. Only data from continuous queries is synced as it is downsampled data and much smaller in size than syncing raw data. Possible use cases are syncing from Production to Development or Syncing a new cluster once brought online.
-
- **How to use sync_ts_databases:**
-
- Pre-Requisites:
-
- 1. Go 1.4 or later
- 2. configured $GOPATH (e.g. export GOPATH=~/go)
-
- Using sync_ts_databases.go:
-
- 1. go get github.com/influxdata/influxdb
-
- 2. go build sync_ts_databases.go
-
- 3. Run it
- - ./sync_ts_databases -help
- - required flags:
- - sourceUrl - The URL of the source database
- - targetUrl - The URL of the target database
-
- -optional flags:
- - database - The database to sync (default = sync all databases)
- - days - Days in the past to sync (default = sync all data)
- - sourceUser - The user of the source database
- - sourcePass - The password for the source database
- - targetUser - The user of the target database
- - targetPass - The password for the target database
-
- - example: ./sync_ts_databases -sourceUrl=http://influxdb-production-01.kabletown.net:8086 -targetUrl=http://influxdb-dev-01.kabletown.net:8086 -database=cache_stats -days=7 -sourceUser=joe sourcePass=mysecret
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_stats.txt b/docs/latest/_sources/admin/traffic_stats.txt
new file mode 100644
index 0000000..ae9d91b
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_stats.txt
@@ -0,0 +1,187 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+****************************
+Traffic Stats Administration
+****************************
+
+Traffic Stats consists of three seperate components: Traffic Stats, InfluxDB, and Grafana. See below for information on installing and configuring each component as well as configuring the integration between the three and Traffic Ops.
+
+Installation
+========================
+
+**Installing Traffic Stats:**
+
+ - Download the Traffic Stats RPM from the traffic control `downloads <https://trafficcontrol.apache.org/downloads/index.html>`_ page.
+ - Copy the Traffic Stats RPM to your server
+ - sudo rpm -ivh <traffic_stats rpm>
+
+**Installing InfluxDB:**
+
+ **As of Traffic Stats 1.8.0, InfluxDb 1.0.0 or higher is required. For InfluxDb versions less than 1.0.0 use Traffic Stats 1.7.x**
+
+ In order to store traffic stats data you will need to install `InfluxDB <https://docs.influxdata.com/influxdb/latest/introduction/installation/>`_. While not required, it is recommended to use some sort of high availability option like `Influx enterprise <https://portal.influxdata.com/>`_, `Influxdb Relay <https://github.com/influxdata/influxdb-relay>`_, or another `high availability option <https://www.influxdata.com/high-availability/>`_.
+
+
+**Installing Grafana:**
+
+ Grafana is used to display Traffic Stats/InfluxDB data in Traffic Ops. Grafana is typically run on the same server as Traffic Stats but this is not a requirement. Grafana can be installed on any server that can access InfluxDB and can be accessed by Traffic Ops. Documentation on installing Grafana can be found on the `Grafana website <http://docs.grafana.org/installation/>`_.
+
+Configuration
+=========================
+
+**Configuring Traffic Stats:**
+
+ Traffic Stats' configuration file can be found in /opt/traffic_stats/conf/traffic_stats.cfg.
+ The following values need to be configured:
+
+ - *toUser:* The user used to connect to Traffic Ops
+ - *toPasswd:* The password to use when connecting to Traffic Ops
+ - *toUrl:* The URL of the Traffic Ops server used by Traffic Stats
+ - *influxUser:* The user to use when connecting to InfluxDB (if configured on InfluxDB, else leave default)
+ - *influxPassword:* That password to use when connecting to InfluxDB (if configured, else leave blank)
+ - *pollingInterval:* The interval at which Traffic Monitor is polled and stats are stored in InfluxDB
+ - *statusToMon:* The status of Traffic Monitor to poll (poll ONLINE or OFFLINE traffic monitors)
+ - *seelogConfig:* The absolute path of the seelong config file
+ - *dailySummaryPollingInterval:* The interval, in seconds, at which Traffic Stats checks to see if daily stats need to be computed and stored.
+ - *cacheRetentionPolicy:* The default retention policy for cache stats
+ - *dsRetentionPolicy:* The default retention policy for deliveryservice stats
+ - *dailySummaryRetentionPolicy:* The retention policy to be used for the daily stats
+ - *influxUrls:* An array of influxdb hosts for Traffic Stats to write stats to.
+
+**Configuring InfluxDB:**
+
+ As mentioned above, it is recommended that InfluxDb be running in some sort of high availability configuration. There are several ways to achieve high availabilty so it is best to consult the high availability options on the `InfuxDB website <https://www.influxdata.com/high-availability/>`_.
+
+ Once InfluxDB is installed and configured, databases and retention policies need to be created. Traffic Stats writes to three different databases: cache_stats, deliveryservice_stats, and daily_stats. More information about the databases and what data is stored in each can be found on the `overview <../overview/traffic_stats.html>`_ page.
+
+ To easily create databases, retention policies, and continuous queries, run create_ts_databases from the /opt/traffic_stats/influxdb_tools directory on your Traffic Stats server. See the `InfluxDb Tools <traffic_stats.html#influxdb-tools>`_ section below for more information.
+
+**Configuring Grafana:**
+
+ In Traffic Ops the Health -> Graph View tab can be configured to display grafana graphs using influxDb data. In order for this to work correctly, you will need two things 1) a parameter added to traffic ops with the graph URL (more information below) and 2) the graphs created in grafana. See below for how to create some simple graphs in grafana. These instructions assume that InfluxDB has been configured and that data has been written to it. If this is not true, you will not see any graphs.
+
+ - Login to grafana as an admin user http://grafana_url:3000/login
+ - Choose Data Sources and then Add New
+ - Enter the necessary information to configure your data source
+ - Click on the 'Home' dropdown at the top of the screen and choose New at the bottom
+ - Click on the green menu bar (with 3 lines) at the top and choose Add Panel -> Graph
+ - Where it says 'No Title (click here)' click and choose edit
+ - Choose your data source at the bottom
+ - You can have grafana help you create a query, or you can create your own. Here is a sample query:
+
+ ``SELECT sum(value)*1000 FROM "monthly"."bandwidth.cdn.1min" WHERE $timeFilter GROUP BY time(60s), cdn``
+ - Once you have the graph the way you want it, click the 'Save Dashboard' button at the top
+ - You should now have a new saved graph
+
+ In order for Traffic Ops users to see Grafana graphs, Grafana will need to allow anonymous access. Information on how to configure anonymous access can be found on the configuration page of the `Grafana Website <http://docs.grafana.org/installation/configuration/#authanonymous>`_.
+
+ Traffic Ops uses custom dashboards to display information about individual delivery services or cache groups. In order for the custom graphs to display correctly, the `traffic_ops_*.js <https://github.com/apache/incubator-trafficcontrol/blob/master/traffic_stats/grafana/>`_ files need to be in the ``/usr/share/grafana/public/dashboards/`` directory on the grafana server. If your Grafana server is the same as your Traffic Stats server the RPM install process will take care of putting the files in place. If your grafana server is different from your Traffic Stats server, you will need to manually copy the files to the correct directory.
+
+ More information on custom scripted graphs can be found in the `scripted dashboards <http://docs.grafana.org/reference/scripting/>`_ section of the Grafana documentation.
+
+**Configuring Traffic Ops for Traffic Stats:**
+
+ - The influxDb servers need to be added to Traffic Ops with profile = InfluxDB. Make sure to use port 8086 in the configuration.
+ - The traffic stats server should be added to Traffic Ops with profile = Traffic Stats.
+ - Parameters for which stats will be collected are added with the release, but any changes can be made via parameters that are assigned to the Traffic Stats profile.
+
+**Configuring Traffic Ops to use Grafana Dashboards**
+
+ To configure Traffic Ops to use Grafana Dashboards, you need to enter the following parameters and assign them to the GLOBAL profile. This assumes you followed the above instructions to install and configure InfluxDB and Grafana. You will need to place 'cdn-stats','deliveryservice-stats', and 'daily-summary' with the name of your dashboards.
+
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | parameter name | parameter value |
+ +===========================+================================================================================================+
+ | all_graph_url | https://<grafana_url>/dashboard/db/deliveryservice-stats |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | cachegroup_graph_url | https://<grafanaHost>/dashboard/script/traffic_ops_cachegroup.js?which= |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | deliveryservice_graph_url | https://<grafanaHost>/dashboard/script/traffic_ops_devliveryservice.js?which= |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | server_graph_url | https://<grafanaHost>/dashboard/script/traffic_ops_server.js?which= |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | visual_status_panel_1 | https://<grafanaHost>/dashboard-solo/db/cdn-stats?panelId=2&fullscreen&from=now-24h&to=now-60s |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | visual_status_panel_2 | https://<grafanaHost>/dashboard-solo/db/cdn-stats?panelId=1&fullscreen&from=now-24h&to=now-60s |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | daily_bw_url | https://<grafanaHost>/dashboard-solo/db/daily-summary?panelId=1&fullscreen&from=now-3y&to=now |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+ | daily_served_url | https://<grafanaHost>/dashboard-solo/db/daily-summary?panelId=2&fullscreen&from=now-3y&to=now |
+ +---------------------------+------------------------------------------------------------------------------------------------+
+
+InfluxDb Tools
+=========================
+
+Under the Traffic Stats source directory there is a directory called influxdb_tools. These tools are meant to be used as one-off scripts to help a user quickly get new databases and continuous queries setup in influxdb.
+They are specific for traffic stats and are not meant to be generic to influxdb. Below is an brief description of each script along with how to use it.
+
+**create_ts_databases**
+ This script creates all `databases <https://docs.influxdata.com/influxdb/latest/concepts/key_concepts/#database>`_, `retention policies <https://docs.influxdata.com/influxdb/latest/concepts/key_concepts/#retention-policy>`_, and `continuous queries <https://docs.influxdata.com/influxdb/v0.11/query_language/continuous_queries/>`_ required by traffic stats.
+
+ **How to use create_ts_databases:**
+
+ Pre-Requisites:
+
+ 1. Go 1.4 or later
+ 2. configured $GOPATH (e.g. export GOPATH=~/go)
+
+ Using create_ts_databases.go
+
+ 1. go get github.com/influxdata/influxdb
+
+ 2. go build create_ts_databases.go
+
+ 3. Run it:
+ - ./create_ts_databases -help
+ - optional flags:
+ - influxUrl - The influxdb url and port
+ - replication - The number of nodes in the cluster
+ - user - The user to use
+ - password - The password to use
+ - example: ./create_ts_databases -influxUrl=localhost:8086 -replication=3 -user=joe -password=mysecret
+
+**sync_ts_databases**
+ This script is used to sync one influxdb environment to another. Only data from continuous queries is synced as it is downsampled data and much smaller in size than syncing raw data. Possible use cases are syncing from Production to Development or Syncing a new cluster once brought online.
+
+ **How to use sync_ts_databases:**
+
+ Pre-Requisites:
+
+ 1. Go 1.4 or later
+ 2. configured $GOPATH (e.g. export GOPATH=~/go)
+
+ Using sync_ts_databases.go:
+
+ 1. go get github.com/influxdata/influxdb
+
+ 2. go build sync_ts_databases.go
+
+ 3. Run it
+ - ./sync_ts_databases -help
+ - required flags:
+ - sourceUrl - The URL of the source database
+ - targetUrl - The URL of the target database
+
+ -optional flags:
+ - database - The database to sync (default = sync all databases)
+ - days - Days in the past to sync (default = sync all data)
+ - sourceUser - The user of the source database
+ - sourcePass - The password for the source database
+ - targetUser - The user of the target database
+ - targetPass - The password for the target database
+
+ - example: ./sync_ts_databases -sourceUrl=http://influxdb-production-01.kabletown.net:8086 -targetUrl=http://influxdb-dev-01.kabletown.net:8086 -database=cache_stats -days=7 -sourceUser=joe sourcePass=mysecret
+
[42/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/asn.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/asn.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/asn.rst.txt
deleted file mode 100644
index b6960d7..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/asn.rst.txt
+++ /dev/null
@@ -1,69 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v11-asn:
-
-ASN
-===
-
-.. _to-api-v11-asns-route:
-
-/api/1.1/asns
-+++++++++++++
-
-**GET /api/1.1/asns**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+--------+-------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================+
- | ``asns`` | array | A collection of asns |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``>lastUpdated`` | string | The Time / Date this server entry was last updated |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``>id`` | string | Local unique identifier for the ASN |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``>asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``>cachegroup`` | string | Related cachegroup name |
- +------------------+--------+-------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "asns": [
- {
- "lastUpdated": "2012-09-17 21:41:22",
- "id": "27",
- "asn": "7015",
- "cachegroup": "us-ma-woburn"
- },
- {
- "lastUpdated": "2012-09-17 21:41:22",
- "id": "28",
- "asn": "7016",
- "cachegroup": "us-pa-pittsburgh"
- }
- ]
- },
- }
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/asn.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/asn.txt b/docs/latest/_sources/development/traffic_ops_api/v11/asn.txt
new file mode 100644
index 0000000..b6960d7
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/asn.txt
@@ -0,0 +1,69 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v11-asn:
+
+ASN
+===
+
+.. _to-api-v11-asns-route:
+
+/api/1.1/asns
++++++++++++++
+
+**GET /api/1.1/asns**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``asns`` | array | A collection of asns |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>id`` | string | Local unique identifier for the ASN |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``>cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "asns": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "27",
+ "asn": "7015",
+ "cachegroup": "us-ma-woburn"
+ },
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "7016",
+ "cachegroup": "us-pa-pittsburgh"
+ }
+ ]
+ },
+ }
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.rst.txt
deleted file mode 100644
index 5278645..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.rst.txt
+++ /dev/null
@@ -1,317 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-cachegroup:
-
-Cache Group
-===========
-
-.. _to-api-v11-cachegroups-route:
-
-/api/1.1/cachegroups
-++++++++++++++++++++
-
-**GET /api/1.1/cachegroups**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +===================================+========+==========================================================================+
- | ``id`` | string | Local unique identifier for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``longitude`` | string | Longitude for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | Parent cachegroup ID. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupName`` | string | Parent cachegroup name. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``typeName`` | string | The name of the type of Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "21",
- "lastUpdated": "2012-09-25 20:27:28",
- "latitude": "0",
- "longitude": "0",
- "name": "dc-chicago",
- "parentCachegroupId": null,
- "parentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "secondaryParentCachegroupName": null,
- "shortName": "dcchi",
- "typeName": "MID_LOC",
- "typeId": "4"
- },
- {
- "id": "22",
- "lastUpdated": "2012-09-25 20:27:28",
- "latitude": "0",
- "longitude": "0",
- "name": "dc-chicago-1",
- "parentCachegroupId": null,
- "parentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "secondaryParentCachegroupName": null,
- "shortName": "dcchi",
- "typeName": "MID_LOC",
- "typeId": "4"
- }
- ],
- }
-
-|
-
-**GET /api/1.1/cachegroups/trimmed**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "dc-chicago"
- },
- {
- "name": "dc-cmc"
- }
- ],
- }
-
-|
-
-**GET /api/1.1/cachegroups/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +===================================+========+==========================================================================+
- | ``id`` | string | Local unique identifier for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``longitude`` | string | Longitude for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | Parent cachegroup ID. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupName`` | string | Parent cachegroup name. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``typeName`` | string | The name of the type of Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "21",
- "lastUpdated": "2012-09-25 20:27:28",
- "latitude": "0",
- "longitude": "0",
- "name": "dc-chicago",
- "parentCachegroupId": null,
- "parentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "secondaryParentCachegroupName": null,
- "shortName": "dcchi",
- "typeName": "MID_LOC",
- "typeId": "4"
- }
- ],
- }
-
-|
-
-
-**GET /api/1.1/cachegroup/:parameter_id/parameter**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-------------+
- | Name | Required | Description |
- +==================+==========+=============+
- | ``parameter_id`` | yes | |
- +------------------+----------+-------------+
-
- **Response Properties**
-
- +-----------------+--------+-------------+
- | Parameter | Type | Description |
- +=================+========+=============+
- | ``cachegroups`` | array | |
- +-----------------+--------+-------------+
- | ``>name`` | string | |
- +-----------------+--------+-------------+
- | ``>id`` | string | |
- +-----------------+--------+-------------+
-
- **Response Example** ::
-
- {
- "response": {
- "cachegroups": [
- {
- "name": "dc-chicago",
- "id": "21"
- },
- {
- "name": "dc-cmc",
- "id": "22"
- }
- ]
- },
- }
-
-
-**GET /api/1.1/cachegroupparameters**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +--------------------------+--------+-----------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+=========================================+
- | ``cachegroupParameters`` | array | A collection of cache group parameters. |
- +--------------------------+--------+-----------------------------------------+
- | ``>parameter`` | string | |
- +--------------------------+--------+-----------------------------------------+
- | ``>last_updated`` | string | |
- +--------------------------+--------+-----------------------------------------+
- | ``>cachegroup`` | string | |
- +--------------------------+--------+-----------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "cachegroupParameters": [
- {
- "parameter": "379",
- "last_updated": "2013-08-05 18:49:37",
- "cachegroup": "us-ca-sanjose"
- },
- {
- "parameter": "380",
- "last_updated": "2013-08-05 18:49:37",
- "cachegroup": "us-ca-sanjose"
- },
- {
- "parameter": "379",
- "last_updated": "2013-08-05 18:49:37",
- "cachegroup": "us-ma-woburn"
- }
- ]
- },
- }
-
-
-|
-
-**GET /api/1.1/cachegroups/:parameter_id/parameter/available**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-------------+
- | Name | Required | Description |
- +==================+==========+=============+
- | ``parameter_id`` | yes | |
- +------------------+----------+-------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "dc-chicago",
- "id": "21"
- },
- {
- "name": "dc-cmc",
- "id": "22"
- }
- ],
- }
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.txt b/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.txt
new file mode 100644
index 0000000..5278645
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/cachegroup.txt
@@ -0,0 +1,317 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-cachegroup:
+
+Cache Group
+===========
+
+.. _to-api-v11-cachegroups-route:
+
+/api/1.1/cachegroups
+++++++++++++++++++++
+
+**GET /api/1.1/cachegroups**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ },
+ {
+ "id": "22",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago-1",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/cachegroups/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "dc-chicago"
+ },
+ {
+ "name": "dc-cmc"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/cachegroups/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+
+**GET /api/1.1/cachegroup/:parameter_id/parameter**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``parameter_id`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +-----------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=================+========+=============+
+ | ``cachegroups`` | array | |
+ +-----------------+--------+-------------+
+ | ``>name`` | string | |
+ +-----------------+--------+-------------+
+ | ``>id`` | string | |
+ +-----------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroups": [
+ {
+ "name": "dc-chicago",
+ "id": "21"
+ },
+ {
+ "name": "dc-cmc",
+ "id": "22"
+ }
+ ]
+ },
+ }
+
+
+**GET /api/1.1/cachegroupparameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+-----------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+=========================================+
+ | ``cachegroupParameters`` | array | A collection of cache group parameters. |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>parameter`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>last_updated`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>cachegroup`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroupParameters": [
+ {
+ "parameter": "379",
+ "last_updated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ca-sanjose"
+ },
+ {
+ "parameter": "380",
+ "last_updated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ca-sanjose"
+ },
+ {
+ "parameter": "379",
+ "last_updated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ma-woburn"
+ }
+ ]
+ },
+ }
+
+
+|
+
+**GET /api/1.1/cachegroups/:parameter_id/parameter/available**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``parameter_id`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "dc-chicago",
+ "id": "21"
+ },
+ {
+ "name": "dc-cmc",
+ "id": "22"
+ }
+ ],
+ }
+
[49/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_ops_install.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_install.rst.txt b/docs/latest/_sources/admin/traffic_ops_install.rst.txt
deleted file mode 100644
index ca49461..0000000
--- a/docs/latest/_sources/admin/traffic_ops_install.rst.txt
+++ /dev/null
@@ -1,381 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. index::
- Traffic Ops - Installing
-
-.. _rl-ps:
-
-Installing Traffic Ops
-%%%%%%%%%%%%%%%%%%%%%%
-
-System Requirements
--------------------
-The user must have the following for a successful install:
-
-* CentOS 6
-* 4 vCPUs
-* 32GB RAM
-* 20 GB disk space
-* YUM repository with minimally the following dependecies avaliable
-
- * apr 1.3.9-5
- * apr-util 1.3.9-3
- * apr-util-ldap 1.3.9-3
- * expat-devel 2.0.1-11
- * genisoimage 1.1.9-12
- * httpd 2.2.15
- * httpd-tools 2.2.15
- * libpcap-devel 14:1.4
- * mod_ssl 1:2.2.15-29
- * mysql 5.1.71
- * autoconf 2.63-5.1.
- * automake 1.11.1-4
- * gcc 4.4.7-4
- * gettext 0.17-16
- * libcurl-devel 7.19.7-37
- * libtool 2.2.6-15.5
- * mysql-devel 5.1.73-3
- * perl-CPAN 1.9402-136
- * libcurl 7.19.7-37
- * openssl 1.0.1e-30
- * cloog-ppl 0.15.7-1.2
- * cpp 4.4.7-4
- * cvs 1.11.23-16
- * libgomp 4.4.7-4
- * libidn-devel 1.18-2
- * m4 1.4.13-5
- * mpfr 2.4.1-6
- * perl-Digest-SHA 1:5.47-136
- * ppl 0.10.2-11
- * curl 7.19.7-37
- * openssl-devel 1.0.1e-30
-
-* Access to `The Comprehensive Perl Archive Network (CPAN) <http://www.cpan.org/>`_
-
-.. Note:: The above versions are known to work on CentOS 6.5. Higher versions may work.
-
-.. Note:: Although Traffic Ops supports both MySQL and Postgres as a database, support for MySQL is more mature and better tested. It is best to use MySQL when first getting started, and the rest of this guide assumes MySQL as the database.
-
-Navigating the Install
------------------------
-To begin the install:
-
-1. Install Traffic Ops:
-
- Download the traffic_ops rpm package from http://trafficcontrol.apache.org/downloads/index.html
-
- ``sudo rpm -ivh traffic_ops-1.*.*-****.x86_64.rpm``
-
-
-
-
-
-2. After installation of Traffic Ops rpm enter the following command: ``sudo /opt/traffic_ops/install/bin/postinstall``
-
- Example output::
-
-
- trafficops-vm # /opt/traffic_ops/install/bin/postinstall
-
- This script will build and package the required Traffic Ops perl modules.
- In order to complete this operation, Development tools such as the gcc
- compiler must be installed on this machine.
-
- Hit ENTER to continue:
-
-
- The first thing postinstall will do is install additional packages needed from the yum repo.
-
- Ater that, it will automatically proceed to installing the required Perl packages from CPAN.
-
- .. Note:: Especially when installing Traffic Ops for the first time on a system this can take a long time, since many dependencies for the Mojolicous application need to be downloaded. Expect 30 minutes.
-
- If there are any prompts in this phase, please just answer with the defaults (some CPAN installs can prompt for install questions).
-
- When this phase is complete, you will see::
-
- ...
- Successfully installed Test-Differences-0.63
- Successfully installed DBIx-Class-Schema-Loader-0.07042
- Successfully installed Time-HiRes-1.9726 (upgraded from 1.9719)
- Successfully installed Mojolicious-Plugin-Authentication-1.26
- 113 distributions installed
- Complete! Modules were installed into /opt/traffic_ops/app/local
- Linking perl libraries...
- Installing perl scripts
-
-
- This script will initialize the Traffic Ops database.
- Please enter the following information in order to completely
- configure the Traffic Ops mysql database.
-
-
- Database type [mysql]:
-
-
- The next phase of the install will ask you about the local environment for your CDN.
-
- .. Note:: Before proceeding to this step, the database has to have at least a root password, and needs to be started. When using mysql, please type ``service mysqld start`` as root in another terminal and follow the instructions on the screen to set the root password.
-
- .. Note:: CentOS files note.
-
- Example output::
-
- Database type [mysql]:
- Database name [traffic_ops_db]:
- Database server hostname IP or FQDN [localhost]:
- Database port number [3306]:
- Traffic Ops database user [traffic_ops]:
- Password for traffic_ops:
- Re-Enter password for traffic_ops:
-
- Error: passwords do not match, try again.
-
- Password for traffic_ops:
- Re-Enter password for traffic_ops:
-
- Database server root (admin) user name [root]:
- Database server root password:
- Database Type: mysql
- Database Name: traffic_ops_db
- Hostname: localhost
- Port: 3306
- Database User: traffic_ops
- Is the above information correct (y/n) [n]: y
-
- The database properties have been saved to /opt/traffic_ops/app/conf/production/database.conf
-
- The database configuration has been saved. Now we need to set some custom
- fields that are necessary for the CDN to function correctly.
-
-
- Traffic Ops url [https://localhost]: https://traffic-ops.kabletown.net
- Human-readable CDN Name. (No whitespace, please) [kabletown_cdn]:
- DNS sub-domain for which your CDN is authoritative [cdn1.kabletown.net]:
- Fully qualified name of your CentOS 6.5 ISO kickstart tar file, or 'na' to skip and add files later [/var/cache/centos65.tgz]: na
- Fully qualified location to store your ISO kickstart files [/var/www/files]:
-
- Traffic Ops URL: https://traffic-ops.kabletown.net
- Traffic Ops Info URL: https://traffic-ops.kabletown.net/info
- Domainname: cdn1.kabletown.net
- CDN Name: kabletown_cdn
- GeoLocation Polling URL: https://traffic-ops.kabletown.net/routing/GeoIP2-City.mmdb.gz
- CoverageZone Polling URL: https://traffic-ops.kabletown.net/routing/coverage-zone.json
-
- Is the above information correct (y/n) [n]: y
- Install information has been saved to /opt/traffic_ops/install/data/json/post_install.json
-
-
- Adding an administration user to the Traffic Ops database.
-
- Administration username for Traffic Ops: admin
- Password for the admin user admin:
- Verify the password for admin:
- Do you wish to create an ldap configuration for access to traffic ops [y/n] ? [n]: n
- creating database
- Creating database...
- Creating user...
- Flushing privileges...
- setting up database
- Executing 'drop database traffic_ops_db'
- Executing 'create database traffic_ops_db'
- Creating database tables...
- Migrating database...
- goose: migrating db environment 'production', current version: 0, target: 20150316100000
- OK 20141222103718_extension.sql
- OK 20150108100000_add_job_deliveryservice.sql
- OK 20150205100000_cg_location.sql
- OK 20150209100000_cran_to_asn.sql
- OK 20150210100000_ds_keyinfo.sql
- OK 20150304100000_add_ip6_ds_routing.sql
- OK 20150310100000_add_bg_fetch.sql
- OK 20150316100000_move_hdr_rw.sql
- Seeding database...
- Database initialization succeeded.
- seeding profile data...
- name EDGE1 description Edge 1
- name TR1 description Traffic Router 1
- name TM1 description Traffic Monitor 1
- name MID1 description Mid 1
- seeding parameter data...
-
- Explanation of the information that needs to be provided:
-
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Field | Description |
- +====================================================+===============================================================================================+
- | Database type | mysql or postgres |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Database name | The name of the database Traffic Ops uses to store the configuration information |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Database server hostname IP or FQDN | The hostname of the database server |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Database port number | The database port number |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Traffic Ops database user | The username Traffic Ops will use to read/write from the database |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Password for traffic ops | The password for the above database user |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Database server root (admin) user name | Privileged database user that has permission to create the database and user for Traffic Ops |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Database server root (admin) user password | The password for the above privileged database user |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Traffic Ops url | The URL to connect to this instance of Traffic Ops, usually https://<traffic ops host FQDN>/ |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Human-readable CDN Name | The name of the first CDN traffic Ops will be managing |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | DNS sub-domain for which your CDN is authoritative | The DNS domain that will be delegated to this Traffic Control CDN |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | name of your CentOS 6.5 ISO kickstart tar file | See :ref:`Creating-CentOS-Kickstart` |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Administration username for Traffic Ops | The Administration (highest privilege) Traffic Ops user to create; |
- | | use this user to login for the first time and create other users |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
- | Password for the admin user | The password for the above user |
- +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
-
-
- The postinstall script will now seed the database with some inital configuration settings for the CDN and the servers in the CDN.
-
- The next phase is the download of the geo location database and configuration of information needed for SSL certificates.
-
- Example output::
-
- Downloading MaxMind data.
- --2015-04-14 02:14:32-- http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
- Resolving geolite.maxmind.com... 141.101.115.190, 141.101.114.190, 2400:cb00:2048:1::8d65:73be, ...
- Connecting to geolite.maxmind.com|141.101.115.190|:80... connected.
- HTTP request sent, awaiting response... 200 OK
- Length: 17633433 (17M) [application/octet-stream]
- Saving to: "GeoLite2-City.mmdb.gz"
-
- 100%[==================================================================================================================================================================>] 17,633,433 7.03M/s in 2.4s
-
- 2015-04-14 02:14:35 (7.03 MB/s) - "GeoLite2-City.mmdb.gz" saved [17633433/17633433]
-
- Copying coverage zone file to public dir.
-
- Installing SSL Certificates.
-
- We're now running a script to generate a self signed X509 SSL certificate.
- When prompted to enter a pass phrase, just enter 'pass' each time. The
- pass phrase will be stripped from the private key before installation.
-
- When prompted to enter a 'challenge password', just hit the ENTER key.
-
- The remaining enformation Country, State, Locality, etc... are required to
- generate a properly formatted SSL certificate.
-
- Hit Enter when you are ready to continue:
- Postinstall SSL Certificate Creation.
-
- Generating an RSA Private Server Key.
-
- Generating RSA private key, 1024 bit long modulus
- ..........................++++++
- .....................++++++
- e is 65537 (0x10001)
- Enter pass phrase for server.key:
- Verifying - Enter pass phrase for server.key:
-
- The server key has been generated.
-
- Creating a Certificate Signing Request (CSR)
-
- Enter pass phrase for server.key:
- You are about to be asked to enter information that will be incorporated
- into your certificate request.
- What you are about to enter is what is called a Distinguished Name or a DN.
- There are quite a few fields but you can leave some blank
- For some fields there will be a default value,
- If you enter '.', the field will be left blank.
- -----
- Country Name (2 letter code) [XX]:US
- State or Province Name (full name) []:CO
- Locality Name (eg, city) [Default City]:Denver
- Organization Name (eg, company) [Default Company Ltd]:
- Organizational Unit Name (eg, section) []:
- Common Name (eg, your name or your server's hostname) []:
- Email Address []:
-
- Please enter the following 'extra' attributes
- to be sent with your certificate request
- A challenge password []:pass
- An optional company name []:
-
- The Certificate Signing Request has been generated.
- Removing the pass phrase from the server key.
- Enter pass phrase for server.key.orig:
- writing RSA key
-
- The pass phrase has been removed from the server key.
-
- Generating a Self-signed certificate.
- Signature ok
- subject=/C=US/ST=CO/L=Denver/O=Default Company Ltd
- Getting Private key
-
- A server key and self signed certificate has been generated.
-
- Installing the server key and server certificate.
-
- The private key has been installed.
-
- Installing the self signed certificate.
-
- Saving the self signed csr.
-
- The self signed certificate has now been installed.
-
- You may obtain a certificate signed by a Certificate Authority using the
- server.csr file saved in the current directory. Once you have obtained
- a signed certificate, copy it to /etc/pki/tls/certs/localhost.crt and
- restart Traffic Ops.
-
-
-
- SSL Certificates have been installed.
-
- Starting Traffic Ops.
-
- Starting Traffic Ops
-
- Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
- Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
- Loading config from /opt/traffic_ops/app/conf/cdn.conf
- Reading log4perl config from /opt/traffic_ops/app/conf/production/log4perl.conf
- Starting hot deployment for Hypnotoad server 32192.
-
- Waiting for Traffic Ops to start.
-
-
- Shutdown Traffic Ops [y/n] [n]: n
-
- To start Traffic Ops: service traffic_ops start
- To stop Traffic Ops: service traffic_ops stop
-
- traffic_ops #
-
-Traffic Ops is now installed!
-
-Upgrading Traffic Ops
-=====================
-To upgrade:
-
-1. Enter the following command:``service traffic_ops stop``
-2. Enter the following command:``yum upgrade traffic_ops``
-3. See :ref:`rl-ps` to run postinstall.
-4. Enter the following command:``service traffic_ops start``
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_ops_install.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_install.txt b/docs/latest/_sources/admin/traffic_ops_install.txt
new file mode 100644
index 0000000..ca49461
--- /dev/null
+++ b/docs/latest/_sources/admin/traffic_ops_install.txt
@@ -0,0 +1,381 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. index::
+ Traffic Ops - Installing
+
+.. _rl-ps:
+
+Installing Traffic Ops
+%%%%%%%%%%%%%%%%%%%%%%
+
+System Requirements
+-------------------
+The user must have the following for a successful install:
+
+* CentOS 6
+* 4 vCPUs
+* 32GB RAM
+* 20 GB disk space
+* YUM repository with minimally the following dependecies avaliable
+
+ * apr 1.3.9-5
+ * apr-util 1.3.9-3
+ * apr-util-ldap 1.3.9-3
+ * expat-devel 2.0.1-11
+ * genisoimage 1.1.9-12
+ * httpd 2.2.15
+ * httpd-tools 2.2.15
+ * libpcap-devel 14:1.4
+ * mod_ssl 1:2.2.15-29
+ * mysql 5.1.71
+ * autoconf 2.63-5.1.
+ * automake 1.11.1-4
+ * gcc 4.4.7-4
+ * gettext 0.17-16
+ * libcurl-devel 7.19.7-37
+ * libtool 2.2.6-15.5
+ * mysql-devel 5.1.73-3
+ * perl-CPAN 1.9402-136
+ * libcurl 7.19.7-37
+ * openssl 1.0.1e-30
+ * cloog-ppl 0.15.7-1.2
+ * cpp 4.4.7-4
+ * cvs 1.11.23-16
+ * libgomp 4.4.7-4
+ * libidn-devel 1.18-2
+ * m4 1.4.13-5
+ * mpfr 2.4.1-6
+ * perl-Digest-SHA 1:5.47-136
+ * ppl 0.10.2-11
+ * curl 7.19.7-37
+ * openssl-devel 1.0.1e-30
+
+* Access to `The Comprehensive Perl Archive Network (CPAN) <http://www.cpan.org/>`_
+
+.. Note:: The above versions are known to work on CentOS 6.5. Higher versions may work.
+
+.. Note:: Although Traffic Ops supports both MySQL and Postgres as a database, support for MySQL is more mature and better tested. It is best to use MySQL when first getting started, and the rest of this guide assumes MySQL as the database.
+
+Navigating the Install
+-----------------------
+To begin the install:
+
+1. Install Traffic Ops:
+
+ Download the traffic_ops rpm package from http://trafficcontrol.apache.org/downloads/index.html
+
+ ``sudo rpm -ivh traffic_ops-1.*.*-****.x86_64.rpm``
+
+
+
+
+
+2. After installation of Traffic Ops rpm enter the following command: ``sudo /opt/traffic_ops/install/bin/postinstall``
+
+ Example output::
+
+
+ trafficops-vm # /opt/traffic_ops/install/bin/postinstall
+
+ This script will build and package the required Traffic Ops perl modules.
+ In order to complete this operation, Development tools such as the gcc
+ compiler must be installed on this machine.
+
+ Hit ENTER to continue:
+
+
+ The first thing postinstall will do is install additional packages needed from the yum repo.
+
+ Ater that, it will automatically proceed to installing the required Perl packages from CPAN.
+
+ .. Note:: Especially when installing Traffic Ops for the first time on a system this can take a long time, since many dependencies for the Mojolicous application need to be downloaded. Expect 30 minutes.
+
+ If there are any prompts in this phase, please just answer with the defaults (some CPAN installs can prompt for install questions).
+
+ When this phase is complete, you will see::
+
+ ...
+ Successfully installed Test-Differences-0.63
+ Successfully installed DBIx-Class-Schema-Loader-0.07042
+ Successfully installed Time-HiRes-1.9726 (upgraded from 1.9719)
+ Successfully installed Mojolicious-Plugin-Authentication-1.26
+ 113 distributions installed
+ Complete! Modules were installed into /opt/traffic_ops/app/local
+ Linking perl libraries...
+ Installing perl scripts
+
+
+ This script will initialize the Traffic Ops database.
+ Please enter the following information in order to completely
+ configure the Traffic Ops mysql database.
+
+
+ Database type [mysql]:
+
+
+ The next phase of the install will ask you about the local environment for your CDN.
+
+ .. Note:: Before proceeding to this step, the database has to have at least a root password, and needs to be started. When using mysql, please type ``service mysqld start`` as root in another terminal and follow the instructions on the screen to set the root password.
+
+ .. Note:: CentOS files note.
+
+ Example output::
+
+ Database type [mysql]:
+ Database name [traffic_ops_db]:
+ Database server hostname IP or FQDN [localhost]:
+ Database port number [3306]:
+ Traffic Ops database user [traffic_ops]:
+ Password for traffic_ops:
+ Re-Enter password for traffic_ops:
+
+ Error: passwords do not match, try again.
+
+ Password for traffic_ops:
+ Re-Enter password for traffic_ops:
+
+ Database server root (admin) user name [root]:
+ Database server root password:
+ Database Type: mysql
+ Database Name: traffic_ops_db
+ Hostname: localhost
+ Port: 3306
+ Database User: traffic_ops
+ Is the above information correct (y/n) [n]: y
+
+ The database properties have been saved to /opt/traffic_ops/app/conf/production/database.conf
+
+ The database configuration has been saved. Now we need to set some custom
+ fields that are necessary for the CDN to function correctly.
+
+
+ Traffic Ops url [https://localhost]: https://traffic-ops.kabletown.net
+ Human-readable CDN Name. (No whitespace, please) [kabletown_cdn]:
+ DNS sub-domain for which your CDN is authoritative [cdn1.kabletown.net]:
+ Fully qualified name of your CentOS 6.5 ISO kickstart tar file, or 'na' to skip and add files later [/var/cache/centos65.tgz]: na
+ Fully qualified location to store your ISO kickstart files [/var/www/files]:
+
+ Traffic Ops URL: https://traffic-ops.kabletown.net
+ Traffic Ops Info URL: https://traffic-ops.kabletown.net/info
+ Domainname: cdn1.kabletown.net
+ CDN Name: kabletown_cdn
+ GeoLocation Polling URL: https://traffic-ops.kabletown.net/routing/GeoIP2-City.mmdb.gz
+ CoverageZone Polling URL: https://traffic-ops.kabletown.net/routing/coverage-zone.json
+
+ Is the above information correct (y/n) [n]: y
+ Install information has been saved to /opt/traffic_ops/install/data/json/post_install.json
+
+
+ Adding an administration user to the Traffic Ops database.
+
+ Administration username for Traffic Ops: admin
+ Password for the admin user admin:
+ Verify the password for admin:
+ Do you wish to create an ldap configuration for access to traffic ops [y/n] ? [n]: n
+ creating database
+ Creating database...
+ Creating user...
+ Flushing privileges...
+ setting up database
+ Executing 'drop database traffic_ops_db'
+ Executing 'create database traffic_ops_db'
+ Creating database tables...
+ Migrating database...
+ goose: migrating db environment 'production', current version: 0, target: 20150316100000
+ OK 20141222103718_extension.sql
+ OK 20150108100000_add_job_deliveryservice.sql
+ OK 20150205100000_cg_location.sql
+ OK 20150209100000_cran_to_asn.sql
+ OK 20150210100000_ds_keyinfo.sql
+ OK 20150304100000_add_ip6_ds_routing.sql
+ OK 20150310100000_add_bg_fetch.sql
+ OK 20150316100000_move_hdr_rw.sql
+ Seeding database...
+ Database initialization succeeded.
+ seeding profile data...
+ name EDGE1 description Edge 1
+ name TR1 description Traffic Router 1
+ name TM1 description Traffic Monitor 1
+ name MID1 description Mid 1
+ seeding parameter data...
+
+ Explanation of the information that needs to be provided:
+
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Field | Description |
+ +====================================================+===============================================================================================+
+ | Database type | mysql or postgres |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Database name | The name of the database Traffic Ops uses to store the configuration information |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Database server hostname IP or FQDN | The hostname of the database server |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Database port number | The database port number |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Traffic Ops database user | The username Traffic Ops will use to read/write from the database |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Password for traffic ops | The password for the above database user |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Database server root (admin) user name | Privileged database user that has permission to create the database and user for Traffic Ops |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Database server root (admin) user password | The password for the above privileged database user |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Traffic Ops url | The URL to connect to this instance of Traffic Ops, usually https://<traffic ops host FQDN>/ |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Human-readable CDN Name | The name of the first CDN traffic Ops will be managing |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | DNS sub-domain for which your CDN is authoritative | The DNS domain that will be delegated to this Traffic Control CDN |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | name of your CentOS 6.5 ISO kickstart tar file | See :ref:`Creating-CentOS-Kickstart` |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Administration username for Traffic Ops | The Administration (highest privilege) Traffic Ops user to create; |
+ | | use this user to login for the first time and create other users |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+ | Password for the admin user | The password for the above user |
+ +----------------------------------------------------+-----------------------------------------------------------------------------------------------+
+
+
+ The postinstall script will now seed the database with some inital configuration settings for the CDN and the servers in the CDN.
+
+ The next phase is the download of the geo location database and configuration of information needed for SSL certificates.
+
+ Example output::
+
+ Downloading MaxMind data.
+ --2015-04-14 02:14:32-- http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
+ Resolving geolite.maxmind.com... 141.101.115.190, 141.101.114.190, 2400:cb00:2048:1::8d65:73be, ...
+ Connecting to geolite.maxmind.com|141.101.115.190|:80... connected.
+ HTTP request sent, awaiting response... 200 OK
+ Length: 17633433 (17M) [application/octet-stream]
+ Saving to: "GeoLite2-City.mmdb.gz"
+
+ 100%[==================================================================================================================================================================>] 17,633,433 7.03M/s in 2.4s
+
+ 2015-04-14 02:14:35 (7.03 MB/s) - "GeoLite2-City.mmdb.gz" saved [17633433/17633433]
+
+ Copying coverage zone file to public dir.
+
+ Installing SSL Certificates.
+
+ We're now running a script to generate a self signed X509 SSL certificate.
+ When prompted to enter a pass phrase, just enter 'pass' each time. The
+ pass phrase will be stripped from the private key before installation.
+
+ When prompted to enter a 'challenge password', just hit the ENTER key.
+
+ The remaining enformation Country, State, Locality, etc... are required to
+ generate a properly formatted SSL certificate.
+
+ Hit Enter when you are ready to continue:
+ Postinstall SSL Certificate Creation.
+
+ Generating an RSA Private Server Key.
+
+ Generating RSA private key, 1024 bit long modulus
+ ..........................++++++
+ .....................++++++
+ e is 65537 (0x10001)
+ Enter pass phrase for server.key:
+ Verifying - Enter pass phrase for server.key:
+
+ The server key has been generated.
+
+ Creating a Certificate Signing Request (CSR)
+
+ Enter pass phrase for server.key:
+ You are about to be asked to enter information that will be incorporated
+ into your certificate request.
+ What you are about to enter is what is called a Distinguished Name or a DN.
+ There are quite a few fields but you can leave some blank
+ For some fields there will be a default value,
+ If you enter '.', the field will be left blank.
+ -----
+ Country Name (2 letter code) [XX]:US
+ State or Province Name (full name) []:CO
+ Locality Name (eg, city) [Default City]:Denver
+ Organization Name (eg, company) [Default Company Ltd]:
+ Organizational Unit Name (eg, section) []:
+ Common Name (eg, your name or your server's hostname) []:
+ Email Address []:
+
+ Please enter the following 'extra' attributes
+ to be sent with your certificate request
+ A challenge password []:pass
+ An optional company name []:
+
+ The Certificate Signing Request has been generated.
+ Removing the pass phrase from the server key.
+ Enter pass phrase for server.key.orig:
+ writing RSA key
+
+ The pass phrase has been removed from the server key.
+
+ Generating a Self-signed certificate.
+ Signature ok
+ subject=/C=US/ST=CO/L=Denver/O=Default Company Ltd
+ Getting Private key
+
+ A server key and self signed certificate has been generated.
+
+ Installing the server key and server certificate.
+
+ The private key has been installed.
+
+ Installing the self signed certificate.
+
+ Saving the self signed csr.
+
+ The self signed certificate has now been installed.
+
+ You may obtain a certificate signed by a Certificate Authority using the
+ server.csr file saved in the current directory. Once you have obtained
+ a signed certificate, copy it to /etc/pki/tls/certs/localhost.crt and
+ restart Traffic Ops.
+
+
+
+ SSL Certificates have been installed.
+
+ Starting Traffic Ops.
+
+ Starting Traffic Ops
+
+ Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
+ Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
+ Loading config from /opt/traffic_ops/app/conf/cdn.conf
+ Reading log4perl config from /opt/traffic_ops/app/conf/production/log4perl.conf
+ Starting hot deployment for Hypnotoad server 32192.
+
+ Waiting for Traffic Ops to start.
+
+
+ Shutdown Traffic Ops [y/n] [n]: n
+
+ To start Traffic Ops: service traffic_ops start
+ To stop Traffic Ops: service traffic_ops stop
+
+ traffic_ops #
+
+Traffic Ops is now installed!
+
+Upgrading Traffic Ops
+=====================
+To upgrade:
+
+1. Enter the following command:``service traffic_ops stop``
+2. Enter the following command:``yum upgrade traffic_ops``
+3. See :ref:`rl-ps` to run postinstall.
+4. Enter the following command:``service traffic_ops start``
[13/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_ops_extensions.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_ops_extensions.html b/docs/latest/admin/traffic_ops_extensions.html
index d93ed48..1ac61f6 100644
--- a/docs/latest/admin/traffic_ops_extensions.html
+++ b/docs/latest/admin/traffic_ops_extensions.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Managing Traffic Ops Extensions — Traffic Control 1.8.1 documentation </title>
+ <title>Managing Traffic Ops Extensions — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Traffic Portal Administration" href="traffic_portal.html"/>
<link rel="prev" title="Using Traffic Ops" href="traffic_ops_using.html"/>
@@ -108,7 +105,7 @@
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_install.html">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Managing Traffic Ops Extensions</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Managing Traffic Ops Extensions</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_portal.html">Traffic Portal Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_monitor.html">Traffic Monitor Administration</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_router.html">Traffic Router Administration</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Managing Traffic Ops Extensions</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_ops_extensions.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_ops_extensions.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -193,7 +190,7 @@
<p>The extensions must be registered with Traffic Ops in order to display a column on the Server Check page. The list of currently registered extensions can be listed by running <code class="docutils literal"><span class="pre">/opt/traffic_ops/app/bin/extensions</span> <span class="pre">-a</span></code>.</p>
<p>The below extensions are automatically registered with the Traffic Ops database (<code class="docutils literal"><span class="pre">to_extension</span></code> table) at install time (see <code class="docutils literal"><span class="pre">traffic_ops/app/db/seeds.sql</span></code>). However, cron must still be configured to run these checks periodically.</p>
<p>The scripts are called as follows:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
+<div class="highlight-python"><div class="highlight"><pre>$TO_HOME/bin/checks/To<name>Check.pl -c "{\"base_url\": \",https://\"<traffic_ops_ip>\", \"check_name\": \"<check_name>\"}" -l <log level>
where:
<name> is the type of check script
@@ -205,48 +202,48 @@ where:
<div class="section" id="example-cron-file">
<h2>Example Cron File<a class="headerlink" href="#example-cron-file" title="Permalink to this headline">¶</a></h2>
<p>Edit with <code class="docutils literal"><span class="pre">crontab</span> <span class="pre">-e</span></code>. You may need to adjust the path to your $TO_HOME to match your system.</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">PERL5LIB</span><span class="o">=/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="p">:</span><span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">lib</span>
+<div class="highlight-python"><div class="highlight"><pre>PERL5LIB=/opt/traffic_ops/app/local/lib/perl5:/opt/traffic_ops/app/lib
-<span class="c1"># IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.</span>
-<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: [</span><span class="se">\"</span><span class="s2">hostName</span><span class="se">\"</span><span class="s2">,</span><span class="se">\"</span><span class="s2">domainName</span><span class="se">\"</span><span class="s2">]}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">IPv4 Ping</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</s
pan><span class="o">>&</span><span class="mi">1</span>
+# IPv4 ping examples - The 'select: ["hostName","domainName"]' works but, if you want to check DNS resolution use FQDN.
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": [\"hostName\",\"domainName\"]}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G\", \"name\": \"IPv4 Ping\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-<span class="c1"># IPv6 ping examples</span>
-<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G6</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">IPv6 Ping</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">&g
t;&</span><span class="mi">1</span>
-<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </s
pan><span class="se">\"</span><span class="s2">10G6</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+# IPv6 ping examples
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"name\": \"IPv6 Ping\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"10G6\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-<span class="c1"># iLO ping</span>
-<span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">ILO</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">iloIpAddress</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-<span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">ILO</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ILO ping</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">iloIpAddress</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class
="mi">1</span>
+# iLO ping
+18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"select\": \"iloIpAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+18 * * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ILO\", \"name\": \"ILO ping\", \"select\": \"iloIpAddress\", \"syslog_facility\": \"local0\"}" >/dev/null 2>&1
-<span class="c1"># MTU ping</span>
-<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Max Trans Unit</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ipAddress</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o"
>>&</span><span class="mi">1</span>
-<span class="mi">45</span> <span class="mi">0</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToPingCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&q
uot;</span><span class="s2">MTU</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Max Trans Unit</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">select</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">ip6Address</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o
">>&</span><span class="mi">1</span>
+# MTU ping
+45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ipAddress\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"select\": \"ip6Address\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ipAddress\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
+45 0 * * * root /opt/traffic_ops/app/bin/checks/ToPingCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"MTU\", \"name\": \"Max Trans Unit\", \"select\": \"ip6Address\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-<span class="c1"># FQDN</span>
-<span class="mi">27</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToFQDNCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">FQDN</span><span class="se">\"</span><span class="s2">"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-<span class="mi">27</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToFQDNCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">FQDN</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">DNS Lookup</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+# FQDN
+27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\"" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+27 * * * * root /opt/traffic_ops/app/bin/checks/ToFQDNCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"FQDN\", \"name\": \"DNS Lookup\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-<span class="c1"># DSCP</span>
-<span class="mi">36</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToDSCPCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">DSCP</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">cms_interface</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">eth0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-<span class="mi">36</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToDSCPCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&qu
ot;</span><span class="s2">DSCP</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Delivery Service</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">cms_interface</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">eth0</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class
="o">>&</span><span class="mi">1</span>
+# DSCP
+36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"cms_interface\": \"eth0\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+36 * * * * root /opt/traffic_ops/app/bin/checks/ToDSCPCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"DSCP\", \"name\": \"Delivery Service\", \"cms_interface\": \"eth0\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-<span class="c1"># RTR</span>
-<span class="mi">10</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToRTRCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&quo
t;</span><span class="s2">RTR</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-<span class="mi">10</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToRTRCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&quo
t;</span><span class="s2">RTR</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Content Router Check</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+# RTR
+10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+10 * * * * root /opt/traffic_ops/app/bin/checks/ToRTRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"RTR\", \"name\": \"Content Router Check\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
-<span class="c1"># CHR</span>
-<span class="o">*/</span><span class="mi">15</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToCHRCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </sp
an><span class="se">\"</span><span class="s2">CHR</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+# CHR
+*/15 * * * * root /opt/traffic_ops/app/bin/checks/ToCHRCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CHR\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-<span class="c1"># CDU</span>
-<span class="mi">20</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">root</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToCDUCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\&quo
t;</span><span class="s2">CDU</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+# CDU
+20 * * * * root /opt/traffic_ops/app/bin/checks/ToCDUCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"CDU\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
-<span class="c1"># ORT</span>
-<span class="mi">40</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">ssh_key_edge_user</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToORTCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span cla
ss="se">\"</span><span class="s2">ORT</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">>></span> <span class="o">/</span><span class="n">var</span><span class="o">/</span><span class="n">log</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">extensionCheck</span><span class="o">.</span><span class="n">log</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
-<span class="mi">40</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="n">ssh_key_edge_user</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="nb">bin</span><span class="o">/</span><span class="n">checks</span><span class="o">/</span><span class="n">ToORTCheck</span><span class="o">.</span><span class="n">pl</span> <span class="o">-</span><span class="n">c</span> <span class="s2">"{</span><span class="se">\"</span><span class="s2">base_url</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">https://localhost</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">check_name</span><span class="se">\"</span><span class="s2">: </span><span cla
ss="se">\"</span><span class="s2">ORT</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">name</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">Operational Readiness Test</span><span class="se">\"</span><span class="s2">, </span><span class="se">\"</span><span class="s2">syslog_facility</span><span class="se">\"</span><span class="s2">: </span><span class="se">\"</span><span class="s2">local0</span><span class="se">\"</span><span class="s2">}"</span> <span class="o">></span> <span class="o">/</span><span class="n">dev</span><span class="o">/</span><span class="n">null</span> <span class="mi">2</span><span class="o">>&</span><span class="mi">1</span>
+# ORT
+40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\"}" >> /var/log/traffic_ops/extensionCheck.log 2>&1
+40 * * * * ssh_key_edge_user /opt/traffic_ops/app/bin/checks/ToORTCheck.pl -c "{\"base_url\": \"https://localhost\", \"check_name\": \"ORT\", \"name\": \"Operational Readiness Test\", \"syslog_facility\": \"local0\"}" > /dev/null 2>&1
</pre></div>
</div>
</div>
@@ -290,7 +287,7 @@ where:
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/admin/traffic_ops_install.html
----------------------------------------------------------------------
diff --git a/docs/latest/admin/traffic_ops_install.html b/docs/latest/admin/traffic_ops_install.html
index 1b4a002..1a57ef1 100644
--- a/docs/latest/admin/traffic_ops_install.html
+++ b/docs/latest/admin/traffic_ops_install.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Installing Traffic Ops — Traffic Control 1.8.1 documentation </title>
+ <title>Installing Traffic Ops — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../genindex.html"/>
- <link rel="search" title="Search" href="../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../index.html"/>
<link rel="up" title="Administrator’s Guide" href="index.html"/>
<link rel="next" title="Configuring Traffic Ops" href="traffic_ops_config.html"/>
<link rel="prev" title="Administrator’s Guide" href="index.html"/>
@@ -105,7 +102,7 @@
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Administrator’s Guide</a><ul class="current">
-<li class="toctree-l2 current"><a class="current reference internal" href="#">Installing Traffic Ops</a></li>
+<li class="toctree-l2 current"><a class="current reference internal" href="">Installing Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_config.html">Configuring Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_using.html">Using Traffic Ops</a></li>
<li class="toctree-l2"><a class="reference internal" href="traffic_ops_extensions.html">Managing Traffic Ops Extensions</a></li>
@@ -162,14 +159,14 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="index.html">Administrator’s Guide</a> »</li>
<li>Installing Traffic Ops</li>
<li class="wy-breadcrumbs-aside">
- <a href="../_sources/admin/traffic_ops_install.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../_sources/admin/traffic_ops_install.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -257,13 +254,13 @@
</ol>
<blockquote>
<div><p>Example output:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">trafficops</span><span class="o">-</span><span class="n">vm</span> <span class="c1"># /opt/traffic_ops/install/bin/postinstall</span>
+<div class="highlight-python"><div class="highlight"><pre>trafficops-vm # /opt/traffic_ops/install/bin/postinstall
-<span class="n">This</span> <span class="n">script</span> <span class="n">will</span> <span class="n">build</span> <span class="ow">and</span> <span class="n">package</span> <span class="n">the</span> <span class="n">required</span> <span class="n">Traffic</span> <span class="n">Ops</span> <span class="n">perl</span> <span class="n">modules</span><span class="o">.</span>
-<span class="n">In</span> <span class="n">order</span> <span class="n">to</span> <span class="n">complete</span> <span class="n">this</span> <span class="n">operation</span><span class="p">,</span> <span class="n">Development</span> <span class="n">tools</span> <span class="n">such</span> <span class="k">as</span> <span class="n">the</span> <span class="n">gcc</span>
-<span class="n">compiler</span> <span class="n">must</span> <span class="n">be</span> <span class="n">installed</span> <span class="n">on</span> <span class="n">this</span> <span class="n">machine</span><span class="o">.</span>
+This script will build and package the required Traffic Ops perl modules.
+In order to complete this operation, Development tools such as the gcc
+compiler must be installed on this machine.
-<span class="n">Hit</span> <span class="n">ENTER</span> <span class="n">to</span> <span class="k">continue</span><span class="p">:</span>
+Hit ENTER to continue:
</pre></div>
</div>
<p>The first thing postinstall will do is install additional packages needed from the yum repo.</p>
@@ -274,7 +271,7 @@
</div>
<p>If there are any prompts in this phase, please just answer with the defaults (some CPAN installs can prompt for install questions).</p>
<p>When this phase is complete, you will see:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>...
+<div class="highlight-python"><div class="highlight"><pre>...
Successfully installed Test-Differences-0.63
Successfully installed DBIx-Class-Schema-Loader-0.07042
Successfully installed Time-HiRes-1.9726 (upgraded from 1.9719)
@@ -303,7 +300,7 @@ Database type [mysql]:
<p class="last">CentOS files note.</p>
</div>
<p>Example output:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span>Database type [mysql]:
+<div class="highlight-python"><div class="highlight"><pre>Database type [mysql]:
Database name [traffic_ops_db]:
Database server hostname IP or FQDN [localhost]:
Database port number [3306]:
@@ -429,7 +426,7 @@ seeding parameter data...
<td>The DNS domain that will be delegated to this Traffic Control CDN</td>
</tr>
<tr class="row-odd"><td>name of your CentOS 6.5 ISO kickstart tar file</td>
-<td>See <a class="reference internal" href="traffic_ops_config.html#creating-centos-kickstart"><span class="std std-ref">Creating the CentOS Kickstart File</span></a></td>
+<td>See <a class="reference internal" href="traffic_ops_config.html#creating-centos-kickstart"><em>Creating the CentOS Kickstart File</em></a></td>
</tr>
<tr class="row-even"><td>Administration username for Traffic Ops</td>
<td>The Administration (highest privilege) Traffic Ops user to create;
@@ -444,120 +441,120 @@ use this user to login for the first time and create other users</td>
<p>The postinstall script will now seed the database with some inital configuration settings for the CDN and the servers in the CDN.</p>
<p>The next phase is the download of the geo location database and configuration of information needed for SSL certificates.</p>
<p>Example output:</p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Downloading</span> <span class="n">MaxMind</span> <span class="n">data</span><span class="o">.</span>
-<span class="o">--</span><span class="mi">2015</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">14</span> <span class="mi">02</span><span class="p">:</span><span class="mi">14</span><span class="p">:</span><span class="mi">32</span><span class="o">--</span> <span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">geolite</span><span class="o">.</span><span class="n">maxmind</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">download</span><span class="o">/</span><span class="n">geoip</span><span class="o">/</span><span class="n">database</span><span class="o">/</span><span class="n">GeoLite2</span><span class="o">-</span><span class="n">City</span><span class="o">.</span><span class="n">mmdb</span><span class="o">.</span><span class="n">gz</span>
-<span class="n">Resolving</span> <span class="n">geolite</span><span class="o">.</span><span class="n">maxmind</span><span class="o">.</span><span class="n">com</span><span class="o">...</span> <span class="mf">141.101</span><span class="o">.</span><span class="mf">115.190</span><span class="p">,</span> <span class="mf">141.101</span><span class="o">.</span><span class="mf">114.190</span><span class="p">,</span> <span class="mi">2400</span><span class="p">:</span><span class="n">cb00</span><span class="p">:</span><span class="mi">2048</span><span class="p">:</span><span class="mi">1</span><span class="p">::</span><span class="mi">8</span><span class="n">d65</span><span class="p">:</span><span class="mi">73</span><span class="n">be</span><span class="p">,</span> <span class="o">...</span>
-<span class="n">Connecting</span> <span class="n">to</span> <span class="n">geolite</span><span class="o">.</span><span class="n">maxmind</span><span class="o">.</span><span class="n">com</span><span class="o">|</span><span class="mf">141.101</span><span class="o">.</span><span class="mf">115.190</span><span class="o">|</span><span class="p">:</span><span class="mf">80.</span><span class="o">..</span> <span class="n">connected</span><span class="o">.</span>
-<span class="n">HTTP</span> <span class="n">request</span> <span class="n">sent</span><span class="p">,</span> <span class="n">awaiting</span> <span class="n">response</span><span class="o">...</span> <span class="mi">200</span> <span class="n">OK</span>
-<span class="n">Length</span><span class="p">:</span> <span class="mi">17633433</span> <span class="p">(</span><span class="mi">17</span><span class="n">M</span><span class="p">)</span> <span class="p">[</span><span class="n">application</span><span class="o">/</span><span class="n">octet</span><span class="o">-</span><span class="n">stream</span><span class="p">]</span>
-<span class="n">Saving</span> <span class="n">to</span><span class="p">:</span> <span class="s2">"GeoLite2-City.mmdb.gz"</span>
+<div class="highlight-python"><div class="highlight"><pre>Downloading MaxMind data.
+--2015-04-14 02:14:32-- http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz
+Resolving geolite.maxmind.com... 141.101.115.190, 141.101.114.190, 2400:cb00:2048:1::8d65:73be, ...
+Connecting to geolite.maxmind.com|141.101.115.190|:80... connected.
+HTTP request sent, awaiting response... 200 OK
+Length: 17633433 (17M) [application/octet-stream]
+Saving to: "GeoLite2-City.mmdb.gz"
-<span class="mi">100</span><span class="o">%</span><span class="p">[</span><span class="o">==================================================================================================================================================================></span><span class="p">]</span> <span class="mi">17</span><span class="p">,</span><span class="mi">633</span><span class="p">,</span><span class="mi">433</span> <span class="mf">7.03</span><span class="n">M</span><span class="o">/</span><span class="n">s</span> <span class="ow">in</span> <span class="mf">2.4</span><span class="n">s</span>
+100%[==================================================================================================================================================================>] 17,633,433 7.03M/s in 2.4s
-<span class="mi">2015</span><span class="o">-</span><span class="mi">04</span><span class="o">-</span><span class="mi">14</span> <span class="mi">02</span><span class="p">:</span><span class="mi">14</span><span class="p">:</span><span class="mi">35</span> <span class="p">(</span><span class="mf">7.03</span> <span class="n">MB</span><span class="o">/</span><span class="n">s</span><span class="p">)</span> <span class="o">-</span> <span class="s2">"GeoLite2-City.mmdb.gz"</span> <span class="n">saved</span> <span class="p">[</span><span class="mi">17633433</span><span class="o">/</span><span class="mi">17633433</span><span class="p">]</span>
+2015-04-14 02:14:35 (7.03 MB/s) - "GeoLite2-City.mmdb.gz" saved [17633433/17633433]
-<span class="n">Copying</span> <span class="n">coverage</span> <span class="n">zone</span> <span class="n">file</span> <span class="n">to</span> <span class="n">public</span> <span class="nb">dir</span><span class="o">.</span>
+Copying coverage zone file to public dir.
-<span class="n">Installing</span> <span class="n">SSL</span> <span class="n">Certificates</span><span class="o">.</span>
+Installing SSL Certificates.
- <span class="n">We</span><span class="s1">'re now running a script to generate a self signed X509 SSL certificate.</span>
- <span class="n">When</span> <span class="n">prompted</span> <span class="n">to</span> <span class="n">enter</span> <span class="n">a</span> <span class="k">pass</span> <span class="n">phrase</span><span class="p">,</span> <span class="n">just</span> <span class="n">enter</span> <span class="s1">'pass'</span> <span class="n">each</span> <span class="n">time</span><span class="o">.</span> <span class="n">The</span>
- <span class="k">pass</span> <span class="n">phrase</span> <span class="n">will</span> <span class="n">be</span> <span class="n">stripped</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">private</span> <span class="n">key</span> <span class="n">before</span> <span class="n">installation</span><span class="o">.</span>
+ We're now running a script to generate a self signed X509 SSL certificate.
+ When prompted to enter a pass phrase, just enter 'pass' each time. The
+ pass phrase will be stripped from the private key before installation.
- <span class="n">When</span> <span class="n">prompted</span> <span class="n">to</span> <span class="n">enter</span> <span class="n">a</span> <span class="s1">'challenge password'</span><span class="p">,</span> <span class="n">just</span> <span class="n">hit</span> <span class="n">the</span> <span class="n">ENTER</span> <span class="n">key</span><span class="o">.</span>
+ When prompted to enter a 'challenge password', just hit the ENTER key.
- <span class="n">The</span> <span class="n">remaining</span> <span class="n">enformation</span> <span class="n">Country</span><span class="p">,</span> <span class="n">State</span><span class="p">,</span> <span class="n">Locality</span><span class="p">,</span> <span class="n">etc</span><span class="o">...</span> <span class="n">are</span> <span class="n">required</span> <span class="n">to</span>
- <span class="n">generate</span> <span class="n">a</span> <span class="n">properly</span> <span class="n">formatted</span> <span class="n">SSL</span> <span class="n">certificate</span><span class="o">.</span>
+ The remaining enformation Country, State, Locality, etc... are required to
+ generate a properly formatted SSL certificate.
-<span class="n">Hit</span> <span class="n">Enter</span> <span class="n">when</span> <span class="n">you</span> <span class="n">are</span> <span class="n">ready</span> <span class="n">to</span> <span class="k">continue</span><span class="p">:</span>
-<span class="n">Postinstall</span> <span class="n">SSL</span> <span class="n">Certificate</span> <span class="n">Creation</span><span class="o">.</span>
+Hit Enter when you are ready to continue:
+Postinstall SSL Certificate Creation.
-<span class="n">Generating</span> <span class="n">an</span> <span class="n">RSA</span> <span class="n">Private</span> <span class="n">Server</span> <span class="n">Key</span><span class="o">.</span>
+Generating an RSA Private Server Key.
-<span class="n">Generating</span> <span class="n">RSA</span> <span class="n">private</span> <span class="n">key</span><span class="p">,</span> <span class="mi">1024</span> <span class="n">bit</span> <span class="n">long</span> <span class="n">modulus</span>
-<span class="o">..........................++++++</span>
-<span class="o">.....................++++++</span>
-<span class="n">e</span> <span class="ow">is</span> <span class="mi">65537</span> <span class="p">(</span><span class="mh">0x10001</span><span class="p">)</span>
-<span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="p">:</span>
-<span class="n">Verifying</span> <span class="o">-</span> <span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="p">:</span>
+Generating RSA private key, 1024 bit long modulus
+..........................++++++
+.....................++++++
+e is 65537 (0x10001)
+Enter pass phrase for server.key:
+Verifying - Enter pass phrase for server.key:
-<span class="n">The</span> <span class="n">server</span> <span class="n">key</span> <span class="n">has</span> <span class="n">been</span> <span class="n">generated</span><span class="o">.</span>
+The server key has been generated.
-<span class="n">Creating</span> <span class="n">a</span> <span class="n">Certificate</span> <span class="n">Signing</span> <span class="n">Request</span> <span class="p">(</span><span class="n">CSR</span><span class="p">)</span>
+Creating a Certificate Signing Request (CSR)
-<span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="p">:</span>
-<span class="n">You</span> <span class="n">are</span> <span class="n">about</span> <span class="n">to</span> <span class="n">be</span> <span class="n">asked</span> <span class="n">to</span> <span class="n">enter</span> <span class="n">information</span> <span class="n">that</span> <span class="n">will</span> <span class="n">be</span> <span class="n">incorporated</span>
-<span class="n">into</span> <span class="n">your</span> <span class="n">certificate</span> <span class="n">request</span><span class="o">.</span>
-<span class="n">What</span> <span class="n">you</span> <span class="n">are</span> <span class="n">about</span> <span class="n">to</span> <span class="n">enter</span> <span class="ow">is</span> <span class="n">what</span> <span class="ow">is</span> <span class="n">called</span> <span class="n">a</span> <span class="n">Distinguished</span> <span class="n">Name</span> <span class="ow">or</span> <span class="n">a</span> <span class="n">DN</span><span class="o">.</span>
-<span class="n">There</span> <span class="n">are</span> <span class="n">quite</span> <span class="n">a</span> <span class="n">few</span> <span class="n">fields</span> <span class="n">but</span> <span class="n">you</span> <span class="n">can</span> <span class="n">leave</span> <span class="n">some</span> <span class="n">blank</span>
-<span class="n">For</span> <span class="n">some</span> <span class="n">fields</span> <span class="n">there</span> <span class="n">will</span> <span class="n">be</span> <span class="n">a</span> <span class="n">default</span> <span class="n">value</span><span class="p">,</span>
-<span class="n">If</span> <span class="n">you</span> <span class="n">enter</span> <span class="s1">'.'</span><span class="p">,</span> <span class="n">the</span> <span class="n">field</span> <span class="n">will</span> <span class="n">be</span> <span class="n">left</span> <span class="n">blank</span><span class="o">.</span>
-<span class="o">-----</span>
-<span class="n">Country</span> <span class="n">Name</span> <span class="p">(</span><span class="mi">2</span> <span class="n">letter</span> <span class="n">code</span><span class="p">)</span> <span class="p">[</span><span class="n">XX</span><span class="p">]:</span><span class="n">US</span>
-<span class="n">State</span> <span class="ow">or</span> <span class="n">Province</span> <span class="n">Name</span> <span class="p">(</span><span class="n">full</span> <span class="n">name</span><span class="p">)</span> <span class="p">[]:</span><span class="n">CO</span>
-<span class="n">Locality</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">city</span><span class="p">)</span> <span class="p">[</span><span class="n">Default</span> <span class="n">City</span><span class="p">]:</span><span class="n">Denver</span>
-<span class="n">Organization</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">company</span><span class="p">)</span> <span class="p">[</span><span class="n">Default</span> <span class="n">Company</span> <span class="n">Ltd</span><span class="p">]:</span>
-<span class="n">Organizational</span> <span class="n">Unit</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">section</span><span class="p">)</span> <span class="p">[]:</span>
-<span class="n">Common</span> <span class="n">Name</span> <span class="p">(</span><span class="n">eg</span><span class="p">,</span> <span class="n">your</span> <span class="n">name</span> <span class="ow">or</span> <span class="n">your</span> <span class="n">server</span><span class="s1">'s hostname) []:</span>
-<span class="n">Email</span> <span class="n">Address</span> <span class="p">[]:</span>
+Enter pass phrase for server.key:
+You are about to be asked to enter information that will be incorporated
+into your certificate request.
+What you are about to enter is what is called a Distinguished Name or a DN.
+There are quite a few fields but you can leave some blank
+For some fields there will be a default value,
+If you enter '.', the field will be left blank.
+-----
+Country Name (2 letter code) [XX]:US
+State or Province Name (full name) []:CO
+Locality Name (eg, city) [Default City]:Denver
+Organization Name (eg, company) [Default Company Ltd]:
+Organizational Unit Name (eg, section) []:
+Common Name (eg, your name or your server's hostname) []:
+Email Address []:
-<span class="n">Please</span> <span class="n">enter</span> <span class="n">the</span> <span class="n">following</span> <span class="s1">'extra'</span> <span class="n">attributes</span>
-<span class="n">to</span> <span class="n">be</span> <span class="n">sent</span> <span class="k">with</span> <span class="n">your</span> <span class="n">certificate</span> <span class="n">request</span>
-<span class="n">A</span> <span class="n">challenge</span> <span class="n">password</span> <span class="p">[]:</span><span class="k">pass</span>
-<span class="n">An</span> <span class="n">optional</span> <span class="n">company</span> <span class="n">name</span> <span class="p">[]:</span>
+Please enter the following 'extra' attributes
+to be sent with your certificate request
+A challenge password []:pass
+An optional company name []:
-<span class="n">The</span> <span class="n">Certificate</span> <span class="n">Signing</span> <span class="n">Request</span> <span class="n">has</span> <span class="n">been</span> <span class="n">generated</span><span class="o">.</span>
-<span class="n">Removing</span> <span class="n">the</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span> <span class="n">key</span><span class="o">.</span>
-<span class="n">Enter</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="k">for</span> <span class="n">server</span><span class="o">.</span><span class="n">key</span><span class="o">.</span><span class="n">orig</span><span class="p">:</span>
-<span class="n">writing</span> <span class="n">RSA</span> <span class="n">key</span>
+The Certificate Signing Request has been generated.
+Removing the pass phrase from the server key.
+Enter pass phrase for server.key.orig:
+writing RSA key
-<span class="n">The</span> <span class="k">pass</span> <span class="n">phrase</span> <span class="n">has</span> <span class="n">been</span> <span class="n">removed</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">server</span> <span class="n">key</span><span class="o">.</span>
+The pass phrase has been removed from the server key.
-<span class="n">Generating</span> <span class="n">a</span> <span class="n">Self</span><span class="o">-</span><span class="n">signed</span> <span class="n">certificate</span><span class="o">.</span>
-<span class="n">Signature</span> <span class="n">ok</span>
-<span class="n">subject</span><span class="o">=/</span><span class="n">C</span><span class="o">=</span><span class="n">US</span><span class="o">/</span><span class="n">ST</span><span class="o">=</span><span class="n">CO</span><span class="o">/</span><span class="n">L</span><span class="o">=</span><span class="n">Denver</span><span class="o">/</span><span class="n">O</span><span class="o">=</span><span class="n">Default</span> <span class="n">Company</span> <span class="n">Ltd</span>
-<span class="n">Getting</span> <span class="n">Private</span> <span class="n">key</span>
+Generating a Self-signed certificate.
+Signature ok
+subject=/C=US/ST=CO/L=Denver/O=Default Company Ltd
+Getting Private key
-<span class="n">A</span> <span class="n">server</span> <span class="n">key</span> <span class="ow">and</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">certificate</span> <span class="n">has</span> <span class="n">been</span> <span class="n">generated</span><span class="o">.</span>
+A server key and self signed certificate has been generated.
-<span class="n">Installing</span> <span class="n">the</span> <span class="n">server</span> <span class="n">key</span> <span class="ow">and</span> <span class="n">server</span> <span class="n">certificate</span><span class="o">.</span>
+Installing the server key and server certificate.
-<span class="n">The</span> <span class="n">private</span> <span class="n">key</span> <span class="n">has</span> <span class="n">been</span> <span class="n">installed</span><span class="o">.</span>
+The private key has been installed.
-<span class="n">Installing</span> <span class="n">the</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">certificate</span><span class="o">.</span>
+Installing the self signed certificate.
-<span class="n">Saving</span> <span class="n">the</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">csr</span><span class="o">.</span>
+Saving the self signed csr.
- <span class="n">The</span> <span class="bp">self</span> <span class="n">signed</span> <span class="n">certificate</span> <span class="n">has</span> <span class="n">now</span> <span class="n">been</span> <span class="n">installed</span><span class="o">.</span>
+ The self signed certificate has now been installed.
- <span class="n">You</span> <span class="n">may</span> <span class="n">obtain</span> <span class="n">a</span> <span class="n">certificate</span> <span class="n">signed</span> <span class="n">by</span> <span class="n">a</span> <span class="n">Certificate</span> <span class="n">Authority</span> <span class="n">using</span> <span class="n">the</span>
- <span class="n">server</span><span class="o">.</span><span class="n">csr</span> <span class="n">file</span> <span class="n">saved</span> <span class="ow">in</span> <span class="n">the</span> <span class="n">current</span> <span class="n">directory</span><span class="o">.</span> <span class="n">Once</span> <span class="n">you</span> <span class="n">have</span> <span class="n">obtained</span>
- <span class="n">a</span> <span class="n">signed</span> <span class="n">certificate</span><span class="p">,</span> <span class="n">copy</span> <span class="n">it</span> <span class="n">to</span> <span class="o">/</span><span class="n">etc</span><span class="o">/</span><span class="n">pki</span><span class="o">/</span><span class="n">tls</span><span class="o">/</span><span class="n">certs</span><span class="o">/</span><span class="n">localhost</span><span class="o">.</span><span class="n">crt</span> <span class="ow">and</span>
- <span class="n">restart</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="o">.</span>
+ You may obtain a certificate signed by a Certificate Authority using the
+ server.csr file saved in the current directory. Once you have obtained
+ a signed certificate, copy it to /etc/pki/tls/certs/localhost.crt and
+ restart Traffic Ops.
-<span class="n">SSL</span> <span class="n">Certificates</span> <span class="n">have</span> <span class="n">been</span> <span class="n">installed</span><span class="o">.</span>
+SSL Certificates have been installed.
-<span class="n">Starting</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="o">.</span>
+Starting Traffic Ops.
-<span class="n">Starting</span> <span class="n">Traffic</span> <span class="n">Ops</span>
+Starting Traffic Ops
-<span class="n">Subroutine</span> <span class="n">TrafficOps</span><span class="p">::</span><span class="n">has</span> <span class="n">redefined</span> <span class="n">at</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="o">/</span><span class="n">Mojo</span><span class="o">/</span><span class="n">Base</span><span class="o">.</span><span class="n">pm</span> <span class="n">line</span> <span class="mf">38.</span>
-<span class="n">Subroutine</span> <span class="n">TrafficOps</span><span class="p">::</span><span class="n">has</span> <span class="n">redefined</span> <span class="n">at</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">lib</span><span class="o">/</span><span class="n">perl5</span><span class="o">/</span><span class="n">Mojo</span><span class="o">/</span><span class="n">Base</span><span class="o">.</span><span class="n">pm</span> <span class="n">line</span> <span class="mf">38.</span>
-<span class="n">Loading</span> <span class="n">config</span> <span class="kn">from</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">conf</span><span class="o">/</span><span class="n">cdn</span><span class="o">.</span><span class="n">conf</span>
-<span class="n">Reading</span> <span class="n">log4perl</span> <span class="n">config</span> <span class="kn">from</span> <span class="o">/</span><span class="n">opt</span><span class="o">/</span><span class="n">traffic_ops</span><span class="o">/</span><span class="n">app</span><span class="o">/</span><span class="n">conf</span><span class="o">/</span><span class="n">production</span><span class="o">/</span><span class="n">log4perl</span><span class="o">.</span><span class="n">conf</span>
-<span class="n">Starting</span> <span class="n">hot</span> <span class="n">deployment</span> <span class="k">for</span> <span class="n">Hypnotoad</span> <span class="n">server</span> <span class="mf">32192.</span>
+Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
+Subroutine TrafficOps::has redefined at /opt/traffic_ops/app/local/lib/perl5/Mojo/Base.pm line 38.
+Loading config from /opt/traffic_ops/app/conf/cdn.conf
+Reading log4perl config from /opt/traffic_ops/app/conf/production/log4perl.conf
+Starting hot deployment for Hypnotoad server 32192.
-<span class="n">Waiting</span> <span class="k">for</span> <span class="n">Traffic</span> <span class="n">Ops</span> <span class="n">to</span> <span class="n">start</span><span class="o">.</span>
+Waiting for Traffic Ops to start.
-<span class="n">Shutdown</span> <span class="n">Traffic</span> <span class="n">Ops</span> <span class="p">[</span><span class="n">y</span><span class="o">/</span><span class="n">n</span><span class="p">]</span> <span class="p">[</span><span class="n">n</span><span class="p">]:</span> <span class="n">n</span>
+Shutdown Traffic Ops [y/n] [n]: n
-<span class="n">To</span> <span class="n">start</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="p">:</span> <span class="n">service</span> <span class="n">traffic_ops</span> <span class="n">start</span>
-<span class="n">To</span> <span class="n">stop</span> <span class="n">Traffic</span> <span class="n">Ops</span><span class="p">:</span> <span class="n">service</span> <span class="n">traffic_ops</span> <span class="n">stop</span>
+To start Traffic Ops: service traffic_ops start
+To stop Traffic Ops: service traffic_ops stop
-<span class="n">traffic_ops</span> <span class="c1">#</span>
+traffic_ops #
</pre></div>
</div>
</div></blockquote>
@@ -568,7 +565,7 @@ use this user to login for the first time and create other users</td>
<ol class="arabic simple">
<li>Enter the following command:<code class="docutils literal"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">stop</span></code></li>
<li>Enter the following command:<code class="docutils literal"><span class="pre">yum</span> <span class="pre">upgrade</span> <span class="pre">traffic_ops</span></code></li>
-<li>See <a class="reference internal" href="#rl-ps"><span class="std std-ref">Installing Traffic Ops</span></a> to run postinstall.</li>
+<li>See <a class="reference internal" href="#rl-ps"><em>Installing Traffic Ops</em></a> to run postinstall.</li>
<li>Enter the following command:<code class="docutils literal"><span class="pre">service</span> <span class="pre">traffic_ops</span> <span class="pre">start</span></code></li>
</ol>
</div>
@@ -613,7 +610,7 @@ use this user to login for the first time and create other users</td>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[43/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.txt b/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.txt
new file mode 100644
index 0000000..0240fd4
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_monitor/traffic_monitor_api.txt
@@ -0,0 +1,178 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _reference-tm-api:
+
+Traffic Monitor APIs
+====================
+The Traffic Monitor URLs below allow certain query parameters for use in controlling the data returned. The optional query parameters are the *tabbed* in values under each URL, if they exist.
+
+|
+
+**/publish/EventLog**
+
+Log of recent events.
+
+|
+
+**/publish/CacheStats**
+
+Statistics gathered for each cache.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/CacheStats/:cache**
+
+Statistics gathered for only this cache.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/DsStats**
+
+Statistics gathered for delivery services.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/DsStats/:deliveryService**
+
+Statistics gathered for this delivery service only.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/CrStates**
+
+The current state of this CDN per the health protocol.
+
+|
+
+**raw**
+
+The current state of this CDN per this Traffic Monitor only.
+
+|
+
+**/publish/CrConfig**
+
+The CrConfig served to and consumed by Traffic Router.
+
+|
+
+**/publish/PeerStates**
+
+The health state information from all peer Traffic Monitors.
+
+**Query Parameters**
+
++--------------+---------+------------------------------------------------+
+| Parameter | Type | Description |
++==============+=========+================================================+
+| ``hc`` | int | The history count, number of items to display. |
++--------------+---------+------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++--------------+---------+------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++--------------+---------+------------------------------------------------+
+
+|
+
+**/publish/Stats**
+
+The general statistics about Traffic Monitor.
+
+|
+
+**/publish/StatSummary**
+
+The summary of cache statistics.
+
+**Query Parameters**
+
++---------------+---------+-----------------------------------------------------------+
+| Parameter | Type | Description |
++===============+=========+===========================================================+
+| ``startTime`` | number | Window start. The number of milliseconds since the epoch. |
++---------------+---------+-----------------------------------------------------------+
+| ``endTime`` | number | Window end. The number of milliseconds since the epoch. |
++---------------+---------+-----------------------------------------------------------+
+| ``hc`` | int | The history count, number of items to display. |
++---------------+---------+-----------------------------------------------------------+
+| ``stats`` | string | A comma separated list of stats to display. |
++---------------+---------+-----------------------------------------------------------+
+| ``wildcard`` | boolean | Controls whether specified stats should be |
+| | | treated as partial strings. |
++---------------+---------+-----------------------------------------------------------+
+| ``cache`` | string | Summary statistics for just this cache. |
++---------------+---------+-----------------------------------------------------------+
+
+|
+
+**/publish/ConfigDoc**
+
+The overview of configuration options.
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops.rst.txt b/docs/latest/_sources/development/traffic_ops.rst.txt
deleted file mode 100644
index 5ec31e4..0000000
--- a/docs/latest/_sources/development/traffic_ops.rst.txt
+++ /dev/null
@@ -1,630 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-Traffic Ops
-***********
-
-Introduction
-============
-Traffic Ops uses a MySql or Postgres database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ to generate the user interface and REST APIs.
-
-Software Requirements
-=====================
-To work on Traffic Ops you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
-
-* `Carton 1.0.12 <http://search.cpan.org/~miyagawa/Carton-v1.0.12/lib/Carton.pm>`_
-
- * cpan JSON
- * cpan JSON::PP
-
-* `Go 1.4 <http://golang.org/doc/install>`_
-* Perl 5.10.1
-* Git
-* MySQL 5.1.52
-* `Goose <https://bitbucket.org/liamstask/goose/>`_
-
-Traffic Ops Project Tree Overview
-=======================================
-
-**/opt/traffic_ops/app**
-
-* bin/ - Directory for scripts, cronjobs, etc
-
-* conf/
-
- * /development - Development (local) specific config files.
- * /misc - Miscellaneous config files.
- * /production - Production specific config files.
- * /test - Test (unit test) specific config files.
-
-* db/ - Database related area.
-
- * /migrations - Database Migration files.
-
-* lib/
-
- * /API - Mojo Controllers for the /API area of the application.
- * /Common - Common Code between both the API and UI areas.
- * /Extensions
- * Fixtures/ - Test Case fixture data for the 'to_test' database.
- * /Integration - Integration Tests.
- * /MojoPlugins - Mojolicious Plugins for Common Controller Code.
- * Schema/ - Database Schema area.
- * /Result - DBIx ORM related files.
- * /Test - Common Test.
- * /UI - Mojo Controllers for the Traffic Ops UI itself.
- * Utils/
- * /Helper - Common utilities for the Traffic Ops application.
-
-* log/ - Log directory where the development and test files are written by the app.
-
-* public/
-
- * css/ - Stylesheets.
- * images/ - Images.
- * js/ - Javascripts
-
-* script/ - Mojo Bootstrap scripts.
-
-* t/ - Unit Tests for the UI.
-
- * api/ - Unit Tests for the API.
-
-* t_integration/ - High level tests for Integration level testing.
-
-* templates/ - Mojo Embedded Perl (.ep) files for the UI.
-
-
-
-Perl Formatting Conventions
-===========================
-Perl tidy is for use in code formatting. See the following config file for formatting conventions.
-
-::
-
-
- edit a file called $HOME/.perltidyrc
-
- -l=156
- -et=4
- -t
- -ci=4
- -st
- -se
- -vt=0
- -cti=0
- -pt=1
- -bt=1
- -sbt=1
- -bbt=1
- -nsfs
- -nolq
- -otr
- -aws
- -wls="= + - / * ."
- -wrs=\"= + - / * .\"
- -wbb="% + - * / x != == >= <= =~ < > | & **= += *= &= <<= &&= -= /= |= + >>= ||= .= %= ^= x="
-
-
-Database Management
-===================
-.. Add db naming conventions
-
-The admin.pl script is for use in managing the Traffic Ops database tables. Below is an example of its usage.
-
-``$ db/admin.pl``
-
-Usage: db/admin.pl [--env (development|test|production)] [arguments]
-
-Example: ``db/admin.pl --env=test reset``
-
-Purpose: This script is used to manage the database. The environments are defined in the dbconf.yml, as well as the database names.
-
-* To use the ``admin.pl`` script, you may need to add ``traffic_ops/lib`` and ``traffic_ops/local/lib/perl5`` to your `PERL5LIB <http://modperlbook.org/html/3-9-2-2-Using-the-PERL5LIB-environment-variable.html>`_ environment variable.
-
-+-----------+--------------------------------------------------------------------+
-| Arguments | Description |
-+===========+====================================================================+
-| create | Execute db 'create' the database for the current environment. |
-+-----------+--------------------------------------------------------------------+
-| down | Roll back a single migration from the current version. |
-+-----------+--------------------------------------------------------------------+
-| drop | Execute db 'drop' on the database for the current environment. |
-+-----------+--------------------------------------------------------------------+
-| redo | Roll back the most recently applied migration, then run it again. |
-+-----------+--------------------------------------------------------------------+
-| reset | Execute db drop, create, load_schema, migrate on the database for |
-| | the current environment. |
-+-----------+--------------------------------------------------------------------+
-| seed | Execute SQL from db/seeds.sql for loading static data. |
-+-----------+--------------------------------------------------------------------+
-| setup | Execute db drop, create, load_schema, migrate, seed on the |
-| | database for the current environment. |
-+-----------+--------------------------------------------------------------------+
-| status | Print the status of all migrations. |
-+-----------+--------------------------------------------------------------------+
-| upgrade | Execute migrate then seed on the database for the current |
-| | environment. |
-+-----------+--------------------------------------------------------------------+
-
-Installing The Developer Environment
-====================================
-To install the Traffic Ops Developer environment:
-
-1. Clone the traffic_control repository from `github.com <https://github.com/apache/incubator-trafficcontrol>`_.
-2. Install the local dependencies using Carton (cpanfile).
-
- ::
-
- $ cd traffic_ops/app
- $ carton
-
-3. Set up a user in MySQL.
-
- Example: ::
-
- master $ mysql
- Welcome to the MySQL monitor. Commands end with ; or \g.
- Your MySQL connection id is 305
- Server version: 5.6.19 Homebrew
-
- Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
-
- Oracle is a registered trademark of Oracle Corporation and/or its
- affiliates. Other names may be trademarks of their respective
- owners.
-
- Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
-
- mysql> create user 'to_user'@'localhost';
- mysql> grant all on to_development.* to 'to_user'@'localhost' identified by 'twelve';
- mysql> grant all on to_test.* to 'to_user'@'localhost' identified by 'twelve';
- mysql> grant all on to_integration.* to 'to_user'@'localhost' identified by 'twelve';
-
-
-4. Enter ``db/admin.pl --env=<enviroment name> setup`` to set up the traffic_ops database(s).
-
- * Unit test database: ``$ db/admin.pl --env=test setup``
- * Development database: ``$ db/admin.pl --env=development setup``
- * Integration database: ``$ db/admin.pl --env=integration setup``
-
- |
-
- Running the the admin.pl script in setup mode should look like this: ::
-
- master $ db/admin.pl --env=development setup
- Using database.conf: conf/development/database.conf
- Using database.conf: conf/development/database.conf
- Using database.conf: conf/development/database.conf
- Using database.conf: conf/development/database.conf
- Using database.conf: conf/development/database.conf
- Using database.conf: conf/development/database.conf
- Executing 'drop database to_development'
- Executing 'create database to_development'
- Creating database tables...
- Warning: Using a password on the command line interface can be insecure.
- Migrating database...
- goose: migrating db environment 'development', current version: 0, target: 20150210100000
- OK 20141222103718_extension.sql
- OK 20150108100000_add_job_deliveryservice.sql
- OK 20150205100000_cg_location.sql
- OK 20150209100000_cran_to_asn.sql
- OK 20150210100000_ds_keyinfo.sql
- Seeding database...
- Warning: Using a password on the command line interface can be insecure.
-
-5. (Optional) To load temporary data into the tables: ``$ perl bin/db/setup_kabletown.pl``
-
-6. Run the postinstall script: ``traffic_ops/install/bin/postinstall``
-
-7. To start Traffic Ops, enter ``$ bin/start.pl``
-
- The local Traffic Ops instance uses an open source framework called morbo, starting following the start command execution.
-
- Start up success includes the following:
-
- ::
-
-
- [2015-02-24 10:44:34,991] [INFO] Listening at "http://*:3000".
-
- Server available at http://127.0.0.1:3000.
-
-
-8. Using a browser, navigate to the given address: ``http://127.0.0.1:3000``
-9. For the initial log in:
-
- * User name: admin
- * Password: password
-
-10. Change the log in information.
-
-Test Cases
-==========
-Use prove to execute test cases. Execute after a carton install:
-
-* To run the Unit Tests: ``$ local/bin/prove -qrp t/``
-* To run the Integration Tests: ``$ local/bin/prove -qrp t_integration/``
-
-The KableTown CDN example
--------------------------
-The integration tests will load an example CDN with most of the features of Traffic Control being used. This is mostly for testing purposes, but can also be used as an example of how to configure certain features. To load the KableTown CDN example and access it:
-
-1. Run the integration tests
-2. Start morbo against the integration database: ``export MOJO_MODE=integration; ./bin/start.pl``
-3. Using a browser, navigate to the given address: ``http://127.0.0.1:3000``
-4. For the initial log in:
-
- * User name: admin
- * Password: password
-
-
-Extensions
-==========
-Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are three types of extensions:
-
-1. Check Extensions
-
- These allow you to add custom checks to the "Health->Server Checks" view.
-
-2. Configuration Extensions
-
- These allow you to add custom configuration file generators.
-
-3. Data source Extensions
-
- These allow you to add statistic sources for the graph views and APIs.
-
-Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see :ref:`admin-to-ext-script`.
-
-Check Extensions
-----------------
-
-In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the "Health->Server Checks" view and that usually run periodically out of cron.
-
-.. |checkmark| image:: ../../../traffic_ops/app/public/images/good.png
-
-.. |X| image:: ../../../traffic_ops/app/public/images/bad.png
-
-
-It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results.
-
-An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops' ``/api/1.1/servers.json`` REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops ``/api/1.1/servercheck/`` target.
-
-A check extension can have a column of |checkmark|'s and |X|'s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below: ::
-
-
- Script here.
-
-Check Extension scripts are located in the $TO_HOME/bin/checks directory.
-
-Currently, the following Check Extensions are available and installed by default:
-
-**Cache Disk Usage Check - CDU**
- This check shows how much of the available total cache disk is in use. A "warm" cache should show 100.00.
-
-**Cache Hit Ratio Check - CHR**
- The cache hit ratio for the cache in the last 15 minutes (the interval is determined by the cron entry).
-
-**DiffServe CodePoint Check - DSCP**
- Checks if the returning traffic from the cache has the correct DSCP value as assigned in the delivery service. (Some routers will overwrite DSCP)
-
-**Maximum Transmission Check - MTU**
- Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the ``ip_address`` of the server in the server table.
-
-**Operational Readiness Check - ORT**
- See :ref:`reference-traffic-ops-ort` for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.
-
-**Ping Check - 10G, ILO, 10G6, FQDN**
- The bin/checks/ToPingCheck.pl is to check basic IP connectivity, and in the default setup it checks IP connectivity to the following:
-
- 10G
- Is the ``ip_address`` (the main IPv4 address) from the server table pingable?
- ILO
- Is the ``ilo_ip_address`` (the lights-out-mangement IPv4 address) from the server table pingable?
- 10G6
- Is the ``ip6_address`` (the main IPv6 address) from the server table pingable?
- FQDN
- Is the Fully Qualified Domain name (the concatenation of ``host_name`` and ``.`` and ``domain_name`` from the server table) pingable?
-
-**Traffic Router Check - RTR**
- Checks the state of each cache as perceived by all Traffic Monitors (via Traffic Router). This extension asks each Traffic Router for the state of the cache. A check failure is indicated if one or more monitors report an error for a cache. A cache is only marked as good if all reports are positive. (This is a pessimistic approach, opposite of how TM marks a cache as up, "the optimistic approach")
-
-
-Configuration Extensions
-------------------------
-NOTE: Config Extensions are Beta at this time.
-
-
-Data Source Extensions
-----------------------
-Traffic Ops has the ability to load custom code at runtime that allow any CDN user to build custom APIs for any requirement that Traffic Ops does not fulfill. There are two classes of Data Source Extensions, private and public. Private extensions are Traffic Ops extensions that are not publicly available, and should be kept in the /opt/traffic_ops_extensions/private/lib. Public extensions are Traffic Ops extensions that are Open Source in nature and free to enhance or contribute back to the Traffic Ops Open Source project and should be kept in /opt/traffic_ops/app/lib/Extensions.
-
-
-Extensions at Runtime
----------------------
-The search path for extensions depends on the configuration of the PERL5LIB, which is preconfigured in the Traffic Ops start scripts. The following directory structure is where Traffic Ops will look for Extensions in this order.
-
-Extension Directories
----------------------
-PERL5LIB Example Configuration: ::
-
- export PERL5LIB=/opt/traffic_ops_extensions/private/lib/Extensions:/opt/traffic_ops/app/lib/Extensions/TrafficStats
-
-Perl Package Naming Convention
-------------------------------
-To prevent Extension namespace collisions within Traffic Ops all Extensions should follow the package naming convention below:
-
-Extensions::<ExtensionName>
-
-Data Source Extension Perl package name example
-Extensions::TrafficStats
-Extensions::YourCustomExtension
-
-TrafficOpsRoutes.pm
--------------------
-Traffic Ops accesses each extension through the addition of a URL route as a custom hook. These routes will be defined in a file called TrafficOpsRoutes.pm that should live in the top directory of your Extension. The routes that are defined should follow the Mojolicious route conventions.
-
-
-Development Configuration
---------------------------
-To incorporate any custom Extensions during development set your PERL5LIB with any number of directories with the understanding that the PERL5LIB search order will come into play, so keep in mind that top-down is how your code will be located. Once Perl locates your custom route or Perl package/class it 'pins' on that class or Mojo Route and doesn't look any further, which allows for the developer to *override* Traffic Ops functionality.
-
-API
-===
-The Traffic Ops API provides programmatic access to read and write CDN data providing authorized API consumers with the ability to monitor CDN performance and configure CDN settings and parameters.
-
-Response Structure
-------------------
-All successful responses have the following structure: ::
-
- {
- "response": <JSON object with main response>,
- }
-
-To make the documentation easier to read, only the ``<JSON object with main response>`` is documented, even though the response and version fields are always present.
-
-Using API Endpoints
--------------------
-1. Authenticate with your Traffic Portal or Traffic Ops user account credentials.
-2. Upon successful user authentication, note the mojolicious cookie value in the response headers.
-3. Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.
-
-Example: ::
-
- [jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
- {"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
- [jvd@laika ~]$
- [jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login
- * Hostname was NOT found in DNS cache
- * Trying ::1...
- * connect to ::1 port 3000 failed: Connection refused
- * Trying 127.0.0.1...
- * Connected to localhost (127.0.0.1) port 3000 (#0)
- > POST /api/1.1/user/login HTTP/1.1
- > User-Agent: curl/7.37.1
- > Host: localhost:3000
- > Accept: application/json
- > Content-Length: 32
- > Content-Type: application/x-www-form-urlencoded
- >
- * upload completely sent off: 32 out of 32 bytes
- < HTTP/1.1 200 OK
- < Connection: keep-alive
- < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- < Access-Control-Allow-Origin: http://localhost:8080
- < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- < Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862; expires=Sun, 19 Apr 2015 00:10:01 GMT; path=/; HttpOnly
- < Content-Type: application/json
- < Date: Sat, 18 Apr 2015 20:10:01 GMT
- < Access-Control-Allow-Credentials: true
- < Content-Length: 81
- < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- * Server Mojolicious (Perl) is not blacklisted
- < Server: Mojolicious (Perl)
- <
- * Connection #0 to host localhost left intact
- {"alerts":[{"level":"success","text":"Successfully logged in."}]}
- [jvd@laika ~]$
-
- [jvd@laika ~]$ curl -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asns.json
- {"response":{"asns":[{"lastUpdated":"2012-09-17 15:41:22", .. asn data deleted .. ,}
- [jvd@laika ~]$
-
-API Errors
-----------
-
-**Response Properties**
-
-+----------------------+--------+------------------------------------------------+
-| Parameter | Type | Description |
-+======================+========+================================================+
-|``alerts`` | array | A collection of alert messages. |
-+----------------------+--------+------------------------------------------------+
-| ``>level`` | string | Success, info, warning or error. |
-+----------------------+--------+------------------------------------------------+
-| ``>text`` | string | Alert message. |
-+----------------------+--------+------------------------------------------------+
-
-The 3 most common errors returned by Traffic Ops are:
-
-401 Unauthorized
- When you don't supply the right cookie, this is the response. ::
-
- [jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
- * Hostname was NOT found in DNS cache
- * Trying ::1...
- * connect to ::1 port 3000 failed: Connection refused
- * Trying 127.0.0.1...
- * Connected to localhost (127.0.0.1) port 3000 (#0)
- > GET /api/1.1/usage/asns.json HTTP/1.1
- > User-Agent: curl/7.37.1
- > Host: localhost:3000
- > Accept: application/json
- >
- < HTTP/1.1 401 Unauthorized
- < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- < Content-Length: 84
- * Server Mojolicious (Perl) is not blacklisted
- < Server: Mojolicious (Perl)
- < Connection: keep-alive
- < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- < Access-Control-Allow-Origin: http://localhost:8080
- < Date: Sat, 18 Apr 2015 20:36:12 GMT
- < Content-Type: application/json
- < Access-Control-Allow-Credentials: true
- <
- * Connection #0 to host localhost left intact
- {"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
- [jvd@laika ~]$
-
-404 Not Found
- When the resource (path) is non existent Traffic Ops returns a 404::
-
- [jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
- * Hostname was NOT found in DNS cache
- * Trying ::1...
- * connect to ::1 port 3000 failed: Connection refused
- * Trying 127.0.0.1...
- * Connected to localhost (127.0.0.1) port 3000 (#0)
- > GET /api/1.1/asnsjj.json HTTP/1.1
- > User-Agent: curl/7.37.1
- > Host: localhost:3000
- > Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
- > Accept: application/json
- >
- < HTTP/1.1 404 Not Found
- * Server Mojolicious (Perl) is not blacklisted
- < Server: Mojolicious (Perl)
- < Content-Length: 75
- < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- < Content-Type: application/json
- < Date: Sat, 18 Apr 2015 20:37:43 GMT
- < Access-Control-Allow-Credentials: true
- < Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAzODYzLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--8a5a61b91473bc785d4073fe711de8d2c63f02dd; expires=Sun, 19 Apr 2015 00:37:43 GMT; path=/; HttpOnly
- < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- < Connection: keep-alive
- < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- < Access-Control-Allow-Origin: http://localhost:8080
- <
- * Connection #0 to host localhost left intact
- {"alerts":[{"text":"Resource not found.","level":"error"}]}
- [jvd@laika ~]$
-
-500 Internal Server Error
- When you are asking for a correct path, but the database doesn't match, it returns a 500::
-
- [jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
- * Hostname was NOT found in DNS cache
- * Trying ::1...
- * connect to ::1 port 3000 failed: Connection refused
- * Trying 127.0.0.1...
- * Connected to localhost (127.0.0.1) port 3000 (#0)
- > GET /api/1.1/servers/hostname/jj/details.json HTTP/1.1
- > User-Agent: curl/7.37.1
- > Host: localhost:3000
- > Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
- > Accept: application/json
- >
- < HTTP/1.1 500 Internal Server Error
- * Server Mojolicious (Perl) is not blacklisted
- < Server: Mojolicious (Perl)
- < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
- < Content-Length: 93
- < Set-Cookie: mojolicious=eyJhdXRoX2RhdGEiOiJhZG1pbiIsImV4cGlyZXMiOjE0Mjk0MDQzMDZ9--1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853; expires=Sun, 19 Apr 2015 00:45:06 GMT; path=/; HttpOnly
- < Content-Type: application/json
- < Date: Sat, 18 Apr 2015 20:45:06 GMT
- < Access-Control-Allow-Credentials: true
- < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
- < Connection: keep-alive
- < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
- < Access-Control-Allow-Origin: http://localhost:8080
- <
- * Connection #0 to host localhost left intact
- {"alerts":[{"level":"error","text":"An error occurred. Please contact your administrator."}]}
- [jvd@laika ~]$
-
- The rest of the API documentation will only document the ``200 OK`` case, where no errors have occured.
-
-Traffic Ops API Routes
-----------------------
-
-.. toctree::
- :maxdepth: 1
-
- traffic_ops_api/routes
-
-API 1.1 Reference
------------------
-
-.. toctree::
- :maxdepth: 1
-
- traffic_ops_api/v11/asn
- traffic_ops_api/v11/cachegroup
- traffic_ops_api/v11/cdn
- traffic_ops_api/v11/changelog
- traffic_ops_api/v11/deliveryservice
- traffic_ops_api/v11/hwinfo
- traffic_ops_api/v11/parameter
- traffic_ops_api/v11/phys_location
- traffic_ops_api/v11/profile
- traffic_ops_api/v11/region
- traffic_ops_api/v11/role
- traffic_ops_api/v11/server
- traffic_ops_api/v11/static_dns
- traffic_ops_api/v11/status
- traffic_ops_api/v11/system
- traffic_ops_api/v11/to_extension
- traffic_ops_api/v11/type
- traffic_ops_api/v11/user
-
-API 1.2 Reference
------------------
-
-.. toctree::
- :maxdepth: 1
-
- traffic_ops_api/v12/asn
- traffic_ops_api/v12/cachegroup
- traffic_ops_api/v12/cache_stats
- traffic_ops_api/v12/cdn
- traffic_ops_api/v12/changelog
- traffic_ops_api/v12/deliveryservice
- traffic_ops_api/v12/deliveryservice_stats
- traffic_ops_api/v12/division
- traffic_ops_api/v12/federation
- traffic_ops_api/v12/hwinfo
- traffic_ops_api/v12/parameter
- traffic_ops_api/v12/phys_location
- traffic_ops_api/v12/profile
- traffic_ops_api/v12/profile_parameter
- traffic_ops_api/v12/influxdb
- traffic_ops_api/v12/region
- traffic_ops_api/v12/role
- traffic_ops_api/v12/server
- traffic_ops_api/v12/static_dns
- traffic_ops_api/v12/status
- traffic_ops_api/v12/system
- traffic_ops_api/v12/to_extension
- traffic_ops_api/v12/type
- traffic_ops_api/v12/user
- traffic_ops_api/v12/topology
-
-
-
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops.txt b/docs/latest/_sources/development/traffic_ops.txt
new file mode 100644
index 0000000..5ec31e4
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops.txt
@@ -0,0 +1,630 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+Traffic Ops
+***********
+
+Introduction
+============
+Traffic Ops uses a MySql or Postgres database to store the configuration information, and the `Mojolicious framework <http://mojolicio.us/>`_ to generate the user interface and REST APIs.
+
+Software Requirements
+=====================
+To work on Traffic Ops you need a \*nix (MacOS and Linux are most commonly used) environment that has the following installed:
+
+* `Carton 1.0.12 <http://search.cpan.org/~miyagawa/Carton-v1.0.12/lib/Carton.pm>`_
+
+ * cpan JSON
+ * cpan JSON::PP
+
+* `Go 1.4 <http://golang.org/doc/install>`_
+* Perl 5.10.1
+* Git
+* MySQL 5.1.52
+* `Goose <https://bitbucket.org/liamstask/goose/>`_
+
+Traffic Ops Project Tree Overview
+=======================================
+
+**/opt/traffic_ops/app**
+
+* bin/ - Directory for scripts, cronjobs, etc
+
+* conf/
+
+ * /development - Development (local) specific config files.
+ * /misc - Miscellaneous config files.
+ * /production - Production specific config files.
+ * /test - Test (unit test) specific config files.
+
+* db/ - Database related area.
+
+ * /migrations - Database Migration files.
+
+* lib/
+
+ * /API - Mojo Controllers for the /API area of the application.
+ * /Common - Common Code between both the API and UI areas.
+ * /Extensions
+ * Fixtures/ - Test Case fixture data for the 'to_test' database.
+ * /Integration - Integration Tests.
+ * /MojoPlugins - Mojolicious Plugins for Common Controller Code.
+ * Schema/ - Database Schema area.
+ * /Result - DBIx ORM related files.
+ * /Test - Common Test.
+ * /UI - Mojo Controllers for the Traffic Ops UI itself.
+ * Utils/
+ * /Helper - Common utilities for the Traffic Ops application.
+
+* log/ - Log directory where the development and test files are written by the app.
+
+* public/
+
+ * css/ - Stylesheets.
+ * images/ - Images.
+ * js/ - Javascripts
+
+* script/ - Mojo Bootstrap scripts.
+
+* t/ - Unit Tests for the UI.
+
+ * api/ - Unit Tests for the API.
+
+* t_integration/ - High level tests for Integration level testing.
+
+* templates/ - Mojo Embedded Perl (.ep) files for the UI.
+
+
+
+Perl Formatting Conventions
+===========================
+Perl tidy is for use in code formatting. See the following config file for formatting conventions.
+
+::
+
+
+ edit a file called $HOME/.perltidyrc
+
+ -l=156
+ -et=4
+ -t
+ -ci=4
+ -st
+ -se
+ -vt=0
+ -cti=0
+ -pt=1
+ -bt=1
+ -sbt=1
+ -bbt=1
+ -nsfs
+ -nolq
+ -otr
+ -aws
+ -wls="= + - / * ."
+ -wrs=\"= + - / * .\"
+ -wbb="% + - * / x != == >= <= =~ < > | & **= += *= &= <<= &&= -= /= |= + >>= ||= .= %= ^= x="
+
+
+Database Management
+===================
+.. Add db naming conventions
+
+The admin.pl script is for use in managing the Traffic Ops database tables. Below is an example of its usage.
+
+``$ db/admin.pl``
+
+Usage: db/admin.pl [--env (development|test|production)] [arguments]
+
+Example: ``db/admin.pl --env=test reset``
+
+Purpose: This script is used to manage the database. The environments are defined in the dbconf.yml, as well as the database names.
+
+* To use the ``admin.pl`` script, you may need to add ``traffic_ops/lib`` and ``traffic_ops/local/lib/perl5`` to your `PERL5LIB <http://modperlbook.org/html/3-9-2-2-Using-the-PERL5LIB-environment-variable.html>`_ environment variable.
+
++-----------+--------------------------------------------------------------------+
+| Arguments | Description |
++===========+====================================================================+
+| create | Execute db 'create' the database for the current environment. |
++-----------+--------------------------------------------------------------------+
+| down | Roll back a single migration from the current version. |
++-----------+--------------------------------------------------------------------+
+| drop | Execute db 'drop' on the database for the current environment. |
++-----------+--------------------------------------------------------------------+
+| redo | Roll back the most recently applied migration, then run it again. |
++-----------+--------------------------------------------------------------------+
+| reset | Execute db drop, create, load_schema, migrate on the database for |
+| | the current environment. |
++-----------+--------------------------------------------------------------------+
+| seed | Execute SQL from db/seeds.sql for loading static data. |
++-----------+--------------------------------------------------------------------+
+| setup | Execute db drop, create, load_schema, migrate, seed on the |
+| | database for the current environment. |
++-----------+--------------------------------------------------------------------+
+| status | Print the status of all migrations. |
++-----------+--------------------------------------------------------------------+
+| upgrade | Execute migrate then seed on the database for the current |
+| | environment. |
++-----------+--------------------------------------------------------------------+
+
+Installing The Developer Environment
+====================================
+To install the Traffic Ops Developer environment:
+
+1. Clone the traffic_control repository from `github.com <https://github.com/apache/incubator-trafficcontrol>`_.
+2. Install the local dependencies using Carton (cpanfile).
+
+ ::
+
+ $ cd traffic_ops/app
+ $ carton
+
+3. Set up a user in MySQL.
+
+ Example: ::
+
+ master $ mysql
+ Welcome to the MySQL monitor. Commands end with ; or \g.
+ Your MySQL connection id is 305
+ Server version: 5.6.19 Homebrew
+
+ Copyright (c) 2000, 2014, Oracle and/or its affiliates. All rights reserved.
+
+ Oracle is a registered trademark of Oracle Corporation and/or its
+ affiliates. Other names may be trademarks of their respective
+ owners.
+
+ Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
+
+ mysql> create user 'to_user'@'localhost';
+ mysql> grant all on to_development.* to 'to_user'@'localhost' identified by 'twelve';
+ mysql> grant all on to_test.* to 'to_user'@'localhost' identified by 'twelve';
+ mysql> grant all on to_integration.* to 'to_user'@'localhost' identified by 'twelve';
+
+
+4. Enter ``db/admin.pl --env=<enviroment name> setup`` to set up the traffic_ops database(s).
+
+ * Unit test database: ``$ db/admin.pl --env=test setup``
+ * Development database: ``$ db/admin.pl --env=development setup``
+ * Integration database: ``$ db/admin.pl --env=integration setup``
+
+ |
+
+ Running the the admin.pl script in setup mode should look like this: ::
+
+ master $ db/admin.pl --env=development setup
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Using database.conf: conf/development/database.conf
+ Executing 'drop database to_development'
+ Executing 'create database to_development'
+ Creating database tables...
+ Warning: Using a password on the command line interface can be insecure.
+ Migrating database...
+ goose: migrating db environment 'development', current version: 0, target: 20150210100000
+ OK 20141222103718_extension.sql
+ OK 20150108100000_add_job_deliveryservice.sql
+ OK 20150205100000_cg_location.sql
+ OK 20150209100000_cran_to_asn.sql
+ OK 20150210100000_ds_keyinfo.sql
+ Seeding database...
+ Warning: Using a password on the command line interface can be insecure.
+
+5. (Optional) To load temporary data into the tables: ``$ perl bin/db/setup_kabletown.pl``
+
+6. Run the postinstall script: ``traffic_ops/install/bin/postinstall``
+
+7. To start Traffic Ops, enter ``$ bin/start.pl``
+
+ The local Traffic Ops instance uses an open source framework called morbo, starting following the start command execution.
+
+ Start up success includes the following:
+
+ ::
+
+
+ [2015-02-24 10:44:34,991] [INFO] Listening at "http://*:3000".
+
+ Server available at http://127.0.0.1:3000.
+
+
+8. Using a browser, navigate to the given address: ``http://127.0.0.1:3000``
+9. For the initial log in:
+
+ * User name: admin
+ * Password: password
+
+10. Change the log in information.
+
+Test Cases
+==========
+Use prove to execute test cases. Execute after a carton install:
+
+* To run the Unit Tests: ``$ local/bin/prove -qrp t/``
+* To run the Integration Tests: ``$ local/bin/prove -qrp t_integration/``
+
+The KableTown CDN example
+-------------------------
+The integration tests will load an example CDN with most of the features of Traffic Control being used. This is mostly for testing purposes, but can also be used as an example of how to configure certain features. To load the KableTown CDN example and access it:
+
+1. Run the integration tests
+2. Start morbo against the integration database: ``export MOJO_MODE=integration; ./bin/start.pl``
+3. Using a browser, navigate to the given address: ``http://127.0.0.1:3000``
+4. For the initial log in:
+
+ * User name: admin
+ * Password: password
+
+
+Extensions
+==========
+Traffic Ops Extensions are a way to enhance the basic functionality of Traffic Ops in a custom manner. There are three types of extensions:
+
+1. Check Extensions
+
+ These allow you to add custom checks to the "Health->Server Checks" view.
+
+2. Configuration Extensions
+
+ These allow you to add custom configuration file generators.
+
+3. Data source Extensions
+
+ These allow you to add statistic sources for the graph views and APIs.
+
+Extensions are managed using the $TO_HOME/bin/extensions command line script. For more information see :ref:`admin-to-ext-script`.
+
+Check Extensions
+----------------
+
+In other words, check extensions are scripts that, after registering with Traffic Ops, have a column reserved in the "Health->Server Checks" view and that usually run periodically out of cron.
+
+.. |checkmark| image:: ../../../traffic_ops/app/public/images/good.png
+
+.. |X| image:: ../../../traffic_ops/app/public/images/bad.png
+
+
+It is the responsibility of the check extension script to iterate over the servers it wants to check and post the results.
+
+An example script might proceed by logging into the Traffic Ops server using the HTTPS base_url provided on the command line. The script is hardcoded with an auth token that is also provisioned in the Traffic Ops User database. This token allows the script to obtain a cookie used in later communications with the Traffic Ops API. The script then obtains a list of all caches to be polled by accessing Traffic Ops' ``/api/1.1/servers.json`` REST target. This list is walked, running a command to gather the stats from that cache. For some extensions, an HTTP GET request might be made to the ATS astats plugin, while for others the cache might be pinged, or a command run over SSH. The results are then compiled into a numeric or boolean result and the script POSTs tha result back to the Traffic Ops ``/api/1.1/servercheck/`` target.
+
+A check extension can have a column of |checkmark|'s and |X|'s (CHECK_EXTENSION_BOOL) or a column that shows a number (CHECK_EXTENSION_NUM).A simple example of a check extension of type CHECK_EXTENSION_NUM that will show 99.33 for all servers of type EDGE is shown below: ::
+
+
+ Script here.
+
+Check Extension scripts are located in the $TO_HOME/bin/checks directory.
+
+Currently, the following Check Extensions are available and installed by default:
+
+**Cache Disk Usage Check - CDU**
+ This check shows how much of the available total cache disk is in use. A "warm" cache should show 100.00.
+
+**Cache Hit Ratio Check - CHR**
+ The cache hit ratio for the cache in the last 15 minutes (the interval is determined by the cron entry).
+
+**DiffServe CodePoint Check - DSCP**
+ Checks if the returning traffic from the cache has the correct DSCP value as assigned in the delivery service. (Some routers will overwrite DSCP)
+
+**Maximum Transmission Check - MTU**
+ Checks if the Traffic Ops host (if that is the one running the check) can send and receive 8192 size packets to the ``ip_address`` of the server in the server table.
+
+**Operational Readiness Check - ORT**
+ See :ref:`reference-traffic-ops-ort` for more information on the ort script. The ORT column shows how many changes the traffic_ops_ort.pl script would apply if it was run. The number in this column should be 0.
+
+**Ping Check - 10G, ILO, 10G6, FQDN**
+ The bin/checks/ToPingCheck.pl is to check basic IP connectivity, and in the default setup it checks IP connectivity to the following:
+
+ 10G
+ Is the ``ip_address`` (the main IPv4 address) from the server table pingable?
+ ILO
+ Is the ``ilo_ip_address`` (the lights-out-mangement IPv4 address) from the server table pingable?
+ 10G6
+ Is the ``ip6_address`` (the main IPv6 address) from the server table pingable?
+ FQDN
+ Is the Fully Qualified Domain name (the concatenation of ``host_name`` and ``.`` and ``domain_name`` from the server table) pingable?
+
+**Traffic Router Check - RTR**
+ Checks the state of each cache as perceived by all Traffic Monitors (via Traffic Router). This extension asks each Traffic Router for the state of the cache. A check failure is indicated if one or more monitors report an error for a cache. A cache is only marked as good if all reports are positive. (This is a pessimistic approach, opposite of how TM marks a cache as up, "the optimistic approach")
+
+
+Configuration Extensions
+------------------------
+NOTE: Config Extensions are Beta at this time.
+
+
+Data Source Extensions
+----------------------
+Traffic Ops has the ability to load custom code at runtime that allow any CDN user to build custom APIs for any requirement that Traffic Ops does not fulfill. There are two classes of Data Source Extensions, private and public. Private extensions are Traffic Ops extensions that are not publicly available, and should be kept in the /opt/traffic_ops_extensions/private/lib. Public extensions are Traffic Ops extensions that are Open Source in nature and free to enhance or contribute back to the Traffic Ops Open Source project and should be kept in /opt/traffic_ops/app/lib/Extensions.
+
+
+Extensions at Runtime
+---------------------
+The search path for extensions depends on the configuration of the PERL5LIB, which is preconfigured in the Traffic Ops start scripts. The following directory structure is where Traffic Ops will look for Extensions in this order.
+
+Extension Directories
+---------------------
+PERL5LIB Example Configuration: ::
+
+ export PERL5LIB=/opt/traffic_ops_extensions/private/lib/Extensions:/opt/traffic_ops/app/lib/Extensions/TrafficStats
+
+Perl Package Naming Convention
+------------------------------
+To prevent Extension namespace collisions within Traffic Ops all Extensions should follow the package naming convention below:
+
+Extensions::<ExtensionName>
+
+Data Source Extension Perl package name example
+Extensions::TrafficStats
+Extensions::YourCustomExtension
+
+TrafficOpsRoutes.pm
+-------------------
+Traffic Ops accesses each extension through the addition of a URL route as a custom hook. These routes will be defined in a file called TrafficOpsRoutes.pm that should live in the top directory of your Extension. The routes that are defined should follow the Mojolicious route conventions.
+
+
+Development Configuration
+--------------------------
+To incorporate any custom Extensions during development set your PERL5LIB with any number of directories with the understanding that the PERL5LIB search order will come into play, so keep in mind that top-down is how your code will be located. Once Perl locates your custom route or Perl package/class it 'pins' on that class or Mojo Route and doesn't look any further, which allows for the developer to *override* Traffic Ops functionality.
+
+API
+===
+The Traffic Ops API provides programmatic access to read and write CDN data providing authorized API consumers with the ability to monitor CDN performance and configure CDN settings and parameters.
+
+Response Structure
+------------------
+All successful responses have the following structure: ::
+
+ {
+ "response": <JSON object with main response>,
+ }
+
+To make the documentation easier to read, only the ``<JSON object with main response>`` is documented, even though the response and version fields are always present.
+
+Using API Endpoints
+-------------------
+1. Authenticate with your Traffic Portal or Traffic Ops user account credentials.
+2. Upon successful user authentication, note the mojolicious cookie value in the response headers.
+3. Pass the mojolicious cookie value, along with any subsequent calls to an authenticated API endpoint.
+
+Example: ::
+
+ [jvd@laika ~]$ curl -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+ {"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
+ [jvd@laika ~]$
+ [jvd@laika ~]$ curl -v -H "Accept: application/json" -v -X POST --data '{ "u":"admin", "p":"secret_passwd" }' http://localhost:3000/api/1.1/user/login
+ * Hostname was NOT found in DNS cache
+ * Trying ::1...
+ * connect to ::1 port 3000 failed: Connection refused
+ * Trying 127.0.0.1...
+ * Connected to localhost (127.0.0.1) port 3000 (#0)
+ > POST /api/1.1/user/login HTTP/1.1
+ > User-Agent: curl/7.37.1
+ > Host: localhost:3000
+ > Accept: application/json
+ > Content-Length: 32
+ > Content-Type: application/x-www-form-urlencoded
+ >
+ * upload completely sent off: 32 out of 32 bytes
+ < HTTP/1.1 200 OK
+ < Connection: keep-alive
+ < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ < Access-Control-Allow-Origin: http://localhost:8080
+ < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ < Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862; expires=Sun, 19 Apr 2015 00:10:01 GMT; path=/; HttpOnly
+ < Content-Type: application/json
+ < Date: Sat, 18 Apr 2015 20:10:01 GMT
+ < Access-Control-Allow-Credentials: true
+ < Content-Length: 81
+ < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ * Server Mojolicious (Perl) is not blacklisted
+ < Server: Mojolicious (Perl)
+ <
+ * Connection #0 to host localhost left intact
+ {"alerts":[{"level":"success","text":"Successfully logged in."}]}
+ [jvd@laika ~]$
+
+ [jvd@laika ~]$ curl -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asns.json
+ {"response":{"asns":[{"lastUpdated":"2012-09-17 15:41:22", .. asn data deleted .. ,}
+ [jvd@laika ~]$
+
+API Errors
+----------
+
+**Response Properties**
+
++----------------------+--------+------------------------------------------------+
+| Parameter | Type | Description |
++======================+========+================================================+
+|``alerts`` | array | A collection of alert messages. |
++----------------------+--------+------------------------------------------------+
+| ``>level`` | string | Success, info, warning or error. |
++----------------------+--------+------------------------------------------------+
+| ``>text`` | string | Alert message. |
++----------------------+--------+------------------------------------------------+
+
+The 3 most common errors returned by Traffic Ops are:
+
+401 Unauthorized
+ When you don't supply the right cookie, this is the response. ::
+
+ [jvd@laika ~]$ curl -v -H "Accept: application/json" http://localhost:3000/api/1.1/usage/asns.json
+ * Hostname was NOT found in DNS cache
+ * Trying ::1...
+ * connect to ::1 port 3000 failed: Connection refused
+ * Trying 127.0.0.1...
+ * Connected to localhost (127.0.0.1) port 3000 (#0)
+ > GET /api/1.1/usage/asns.json HTTP/1.1
+ > User-Agent: curl/7.37.1
+ > Host: localhost:3000
+ > Accept: application/json
+ >
+ < HTTP/1.1 401 Unauthorized
+ < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ < Content-Length: 84
+ * Server Mojolicious (Perl) is not blacklisted
+ < Server: Mojolicious (Perl)
+ < Connection: keep-alive
+ < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ < Access-Control-Allow-Origin: http://localhost:8080
+ < Date: Sat, 18 Apr 2015 20:36:12 GMT
+ < Content-Type: application/json
+ < Access-Control-Allow-Credentials: true
+ <
+ * Connection #0 to host localhost left intact
+ {"alerts":[{"level":"error","text":"Unauthorized, please log in."}]}
+ [jvd@laika ~]$
+
+404 Not Found
+ When the resource (path) is non existent Traffic Ops returns a 404::
+
+ [jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/asnsjj.json
+ * Hostname was NOT found in DNS cache
+ * Trying ::1...
+ * connect to ::1 port 3000 failed: Connection refused
+ * Trying 127.0.0.1...
+ * Connected to localhost (127.0.0.1) port 3000 (#0)
+ > GET /api/1.1/asnsjj.json HTTP/1.1
+ > User-Agent: curl/7.37.1
+ > Host: localhost:3000
+ > Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
+ > Accept: application/json
+ >
+ < HTTP/1.1 404 Not Found
+ * Server Mojolicious (Perl) is not blacklisted
+ < Server: Mojolicious (Perl)
+ < Content-Length: 75
+ < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ < Content-Type: application/json
+ < Date: Sat, 18 Apr 2015 20:37:43 GMT
+ < Access-Control-Allow-Credentials: true
+ < Set-Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAzODYzLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--8a5a61b91473bc785d4073fe711de8d2c63f02dd; expires=Sun, 19 Apr 2015 00:37:43 GMT; path=/; HttpOnly
+ < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ < Connection: keep-alive
+ < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ < Access-Control-Allow-Origin: http://localhost:8080
+ <
+ * Connection #0 to host localhost left intact
+ {"alerts":[{"text":"Resource not found.","level":"error"}]}
+ [jvd@laika ~]$
+
+500 Internal Server Error
+ When you are asking for a correct path, but the database doesn't match, it returns a 500::
+
+ [jvd@laika ~]$ curl -v -H'Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;' -H "Accept: application/json" http://localhost:3000/api/1.1/servers/hostname/jj/details.json
+ * Hostname was NOT found in DNS cache
+ * Trying ::1...
+ * connect to ::1 port 3000 failed: Connection refused
+ * Trying 127.0.0.1...
+ * Connected to localhost (127.0.0.1) port 3000 (#0)
+ > GET /api/1.1/servers/hostname/jj/details.json HTTP/1.1
+ > User-Agent: curl/7.37.1
+ > Host: localhost:3000
+ > Cookie: mojolicious=eyJleHBpcmVzIjoxNDI5NDAyMjAxLCJhdXRoX2RhdGEiOiJhZG1pbiJ9--f990d03b7180b1ece97c3bb5ca69803cd6a79862;
+ > Accept: application/json
+ >
+ < HTTP/1.1 500 Internal Server Error
+ * Server Mojolicious (Perl) is not blacklisted
+ < Server: Mojolicious (Perl)
+ < Cache-Control: no-cache, no-store, max-age=0, must-revalidate
+ < Content-Length: 93
+ < Set-Cookie: mojolicious=eyJhdXRoX2RhdGEiOiJhZG1pbiIsImV4cGlyZXMiOjE0Mjk0MDQzMDZ9--1b08977e91f8f68b0ff5d5e5f6481c76ddfd0853; expires=Sun, 19 Apr 2015 00:45:06 GMT; path=/; HttpOnly
+ < Content-Type: application/json
+ < Date: Sat, 18 Apr 2015 20:45:06 GMT
+ < Access-Control-Allow-Credentials: true
+ < Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ < Connection: keep-alive
+ < Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
+ < Access-Control-Allow-Origin: http://localhost:8080
+ <
+ * Connection #0 to host localhost left intact
+ {"alerts":[{"level":"error","text":"An error occurred. Please contact your administrator."}]}
+ [jvd@laika ~]$
+
+ The rest of the API documentation will only document the ``200 OK`` case, where no errors have occured.
+
+Traffic Ops API Routes
+----------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ traffic_ops_api/routes
+
+API 1.1 Reference
+-----------------
+
+.. toctree::
+ :maxdepth: 1
+
+ traffic_ops_api/v11/asn
+ traffic_ops_api/v11/cachegroup
+ traffic_ops_api/v11/cdn
+ traffic_ops_api/v11/changelog
+ traffic_ops_api/v11/deliveryservice
+ traffic_ops_api/v11/hwinfo
+ traffic_ops_api/v11/parameter
+ traffic_ops_api/v11/phys_location
+ traffic_ops_api/v11/profile
+ traffic_ops_api/v11/region
+ traffic_ops_api/v11/role
+ traffic_ops_api/v11/server
+ traffic_ops_api/v11/static_dns
+ traffic_ops_api/v11/status
+ traffic_ops_api/v11/system
+ traffic_ops_api/v11/to_extension
+ traffic_ops_api/v11/type
+ traffic_ops_api/v11/user
+
+API 1.2 Reference
+-----------------
+
+.. toctree::
+ :maxdepth: 1
+
+ traffic_ops_api/v12/asn
+ traffic_ops_api/v12/cachegroup
+ traffic_ops_api/v12/cache_stats
+ traffic_ops_api/v12/cdn
+ traffic_ops_api/v12/changelog
+ traffic_ops_api/v12/deliveryservice
+ traffic_ops_api/v12/deliveryservice_stats
+ traffic_ops_api/v12/division
+ traffic_ops_api/v12/federation
+ traffic_ops_api/v12/hwinfo
+ traffic_ops_api/v12/parameter
+ traffic_ops_api/v12/phys_location
+ traffic_ops_api/v12/profile
+ traffic_ops_api/v12/profile_parameter
+ traffic_ops_api/v12/influxdb
+ traffic_ops_api/v12/region
+ traffic_ops_api/v12/role
+ traffic_ops_api/v12/server
+ traffic_ops_api/v12/static_dns
+ traffic_ops_api/v12/status
+ traffic_ops_api/v12/system
+ traffic_ops_api/v12/to_extension
+ traffic_ops_api/v12/type
+ traffic_ops_api/v12/user
+ traffic_ops_api/v12/topology
+
+
+
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/routes.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/routes.rst.txt b/docs/latest/_sources/development/traffic_ops_api/routes.rst.txt
deleted file mode 100644
index ec90963..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/routes.rst.txt
+++ /dev/null
@@ -1,116 +0,0 @@
-.. raw:: html
-
- <style>
- table {
- table-layout: fixed;
- width: 100%;
- }
-
- td {
- word-wrap:break-word;
- }
- table.docutils col:nth-child(1) {
- width: 30%;
- }
- table.docutils col:nth-child(2) {
- width: 30%;
- }
- table.docutils col:nth-child(3) {
- width: 30%;
- }
- .wy-nav-content {
- max-width: 1200px;
- width: 90%;
- }
- </style>
-
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-routes:
-
-API Routes
-==========
-
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| 1.0 | 1.1 | 1.2 |
-+====================================+====================================================+====================================================+
-| /asns | :ref:`to-api-v11-asns-route` | :ref:`to-api-v12-asns-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /availableds | :ref:`to-api-v11-ds-route` | :ref:`to-api-v12-ds-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| *Not Implemented* | *Not Implemented* | :ref:`to-api-v12-cache-stats-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datacrans | /api/1.1/crans.json | /api/1.2/crans.json |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datacrans/orderby/:field | /api/1.1/crans.json | /api/1.2/crans.json |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datadeliveryservice | :ref:`to-api-v11-ds-route` | :ref:`to-api-v12-ds-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datadeliveryserviceserver | /api/1.1/deliveryserviceserver.json | /api/1.2/deliveryserviceserver.json |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datadomains | /api/1.1/cdns/domains.json | /api/1.2/cdns/domains.json |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| *Not Implemented* | *Not Implemented* | :ref:`to-api-v12-ds-stats-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datahwinfo | :ref:`to-api-v11-hwinfo-route` | :ref:`to-api-v12-hwinfo-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datalinks | /api/1.1/deliveryserviceserver.json | /api/1.2/deliveryserviceserver.json |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datalinks/orderby/:field | /api/1.1/deliveryserviceserver.json | /api/1.2/deliveryserviceserver.json |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datalogs | :ref:`to-api-v11-change-logs-route` | :ref:`to-api-v12-change-logs-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datalocation/orderby/id | :ref:`to-api-v11-cachegroups-route` | :ref:`to-api-v12-cachegroups-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datalocationparameters | :ref:`to-api-v11-cachegroups-route` | :ref:`to-api-v12-cachegroups-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /dataparameter | :ref:`to-api-v11-parameters-route` | :ref:`to-api-v12-parameters-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /dataparameter/:parameter | /api/1.1/parameters/profile/:parameter.json | /api/1.2/parameters/profile/:parameter.json |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /dataphys_location | :ref:`to-api-v11-phys-loc-route` | :ref:`to-api-v12-phys-loc-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /dataprofile | :ref:`to-api-v11-profiles-route` | :ref:`to-api-v12-profiles-route` |
-| | | |
-| /dataprofile/orderby/name | | |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /dataregion | :ref:`to-api-v11-regions-route` | :ref:`to-api-v12-regions-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datarole | :ref:`to-api-v11-roles-route` | :ref:`to-api-v12-roles-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datarole/orderby/:field | :ref:`to-api-v11-roles-route` | :ref:`to-api-v12-roles-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /dataserver | :ref:`to-api-v11-servers-route` | :ref:`to-api-v12-servers-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /dataserver/orderby/:field | :ref:`to-api-v11-servers-route` | :ref:`to-api-v12-servers-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /dataserverdetail/select/:hostname | /api/1.1/servers/hostname/:hostname/details.json | /api/1.2/servers/hostname/:hostname/details.json |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datastaticdnsentry | :ref:`to-api-v11-static-dns-route` | :ref:`to-api-v12-static-dns-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datastatus | :ref:`to-api-v11-statuses-route` | :ref:`to-api-v12-statuses-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datastatus/orderby/name | :ref:`to-api-v11-statuses-route` | :ref:`to-api-v12-statuses-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datatype | :ref:`to-api-v11-types-route` | :ref:`to-api-v12-types-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datatype/orderby/:field | :ref:`to-api-v11-types-route` | :ref:`to-api-v12-types-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datauser | :ref:`to-api-v11-users-route` | :ref:`to-api-v12-users-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
-| /datauser/orderby/:field | :ref:`to-api-v11-users-route` | :ref:`to-api-v12-users-route` |
-+------------------------------------+----------------------------------------------------+----------------------------------------------------+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/routes.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/routes.txt b/docs/latest/_sources/development/traffic_ops_api/routes.txt
new file mode 100644
index 0000000..ec90963
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/routes.txt
@@ -0,0 +1,116 @@
+.. raw:: html
+
+ <style>
+ table {
+ table-layout: fixed;
+ width: 100%;
+ }
+
+ td {
+ word-wrap:break-word;
+ }
+ table.docutils col:nth-child(1) {
+ width: 30%;
+ }
+ table.docutils col:nth-child(2) {
+ width: 30%;
+ }
+ table.docutils col:nth-child(3) {
+ width: 30%;
+ }
+ .wy-nav-content {
+ max-width: 1200px;
+ width: 90%;
+ }
+ </style>
+
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-routes:
+
+API Routes
+==========
+
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| 1.0 | 1.1 | 1.2 |
++====================================+====================================================+====================================================+
+| /asns | :ref:`to-api-v11-asns-route` | :ref:`to-api-v12-asns-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /availableds | :ref:`to-api-v11-ds-route` | :ref:`to-api-v12-ds-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| *Not Implemented* | *Not Implemented* | :ref:`to-api-v12-cache-stats-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datacrans | /api/1.1/crans.json | /api/1.2/crans.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datacrans/orderby/:field | /api/1.1/crans.json | /api/1.2/crans.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datadeliveryservice | :ref:`to-api-v11-ds-route` | :ref:`to-api-v12-ds-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datadeliveryserviceserver | /api/1.1/deliveryserviceserver.json | /api/1.2/deliveryserviceserver.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datadomains | /api/1.1/cdns/domains.json | /api/1.2/cdns/domains.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| *Not Implemented* | *Not Implemented* | :ref:`to-api-v12-ds-stats-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datahwinfo | :ref:`to-api-v11-hwinfo-route` | :ref:`to-api-v12-hwinfo-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalinks | /api/1.1/deliveryserviceserver.json | /api/1.2/deliveryserviceserver.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalinks/orderby/:field | /api/1.1/deliveryserviceserver.json | /api/1.2/deliveryserviceserver.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalogs | :ref:`to-api-v11-change-logs-route` | :ref:`to-api-v12-change-logs-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalocation/orderby/id | :ref:`to-api-v11-cachegroups-route` | :ref:`to-api-v12-cachegroups-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datalocationparameters | :ref:`to-api-v11-cachegroups-route` | :ref:`to-api-v12-cachegroups-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataparameter | :ref:`to-api-v11-parameters-route` | :ref:`to-api-v12-parameters-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataparameter/:parameter | /api/1.1/parameters/profile/:parameter.json | /api/1.2/parameters/profile/:parameter.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataphys_location | :ref:`to-api-v11-phys-loc-route` | :ref:`to-api-v12-phys-loc-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataprofile | :ref:`to-api-v11-profiles-route` | :ref:`to-api-v12-profiles-route` |
+| | | |
+| /dataprofile/orderby/name | | |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataregion | :ref:`to-api-v11-regions-route` | :ref:`to-api-v12-regions-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datarole | :ref:`to-api-v11-roles-route` | :ref:`to-api-v12-roles-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datarole/orderby/:field | :ref:`to-api-v11-roles-route` | :ref:`to-api-v12-roles-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataserver | :ref:`to-api-v11-servers-route` | :ref:`to-api-v12-servers-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataserver/orderby/:field | :ref:`to-api-v11-servers-route` | :ref:`to-api-v12-servers-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /dataserverdetail/select/:hostname | /api/1.1/servers/hostname/:hostname/details.json | /api/1.2/servers/hostname/:hostname/details.json |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datastaticdnsentry | :ref:`to-api-v11-static-dns-route` | :ref:`to-api-v12-static-dns-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datastatus | :ref:`to-api-v11-statuses-route` | :ref:`to-api-v12-statuses-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datastatus/orderby/name | :ref:`to-api-v11-statuses-route` | :ref:`to-api-v12-statuses-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datatype | :ref:`to-api-v11-types-route` | :ref:`to-api-v12-types-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datatype/orderby/:field | :ref:`to-api-v11-types-route` | :ref:`to-api-v12-types-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datauser | :ref:`to-api-v11-users-route` | :ref:`to-api-v12-users-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
+| /datauser/orderby/:field | :ref:`to-api-v11-users-route` | :ref:`to-api-v12-users-route` |
++------------------------------------+----------------------------------------------------+----------------------------------------------------+
[15/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/jquery.js
----------------------------------------------------------------------
diff --git a/docs/latest/_static/jquery.js b/docs/latest/_static/jquery.js
index f6a6a99..ab28a24 100644
--- a/docs/latest/_static/jquery.js
+++ b/docs/latest/_static/jquery.js
@@ -1,4 +1,4 @@
-/*! jQuery v3.1.0 | (c) jQuery Foundation | jquery.org/license */
-!function(a,b){"use strict";"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){"use strict";var c=[],d=a.document,e=Object.getPrototypeOf,f=c.slice,g=c.concat,h=c.push,i=c.indexOf,j={},k=j.toString,l=j.hasOwnProperty,m=l.toString,n=m.call(Object),o={};function p(a,b){b=b||d;var c=b.createElement("script");c.text=a,b.head.appendChild(c).parentNode.removeChild(c)}var q="3.1.0",r=function(a,b){return new r.fn.init(a,b)},s=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,t=/^-ms-/,u=/-([a-z])/g,v=function(a,b){return b.toUpperCase()};r.fn=r.prototype={jquery:q,constructor:r,length:0,toArray:function(){return f.call(this)},get:function(a){return null!=a?a<0?this[a+this.length]:this[a]:f.call(this)},pushStack:function(a){var b=r.merge(this.constructor(),a);return b.prevObject=this,b},each:function(a){retu
rn r.each(this,a)},map:function(a){return this.pushStack(r.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(f.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(a<0?b:0);return this.pushStack(c>=0&&c<b?[this[c]]:[])},end:function(){return this.prevObject||this.constructor()},push:h,sort:c.sort,splice:c.splice},r.extend=r.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||r.isFunction(g)||(g={}),h===i&&(g=this,h--);h<i;h++)if(null!=(a=arguments[h]))for(b in a)c=g[b],d=a[b],g!==d&&(j&&d&&(r.isPlainObject(d)||(e=r.isArray(d)))?(e?(e=!1,f=c&&r.isArray(c)?c:[]):f=c&&r.isPlainObject(c)?c:{},g[b]=r.extend(j,f,d)):void 0!==d&&(g[b]=d));return g},r.extend({expando:"jQuery"+(q+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:funct
ion(){},isFunction:function(a){return"function"===r.type(a)},isArray:Array.isArray,isWindow:function(a){return null!=a&&a===a.window},isNumeric:function(a){var b=r.type(a);return("number"===b||"string"===b)&&!isNaN(a-parseFloat(a))},isPlainObject:function(a){var b,c;return!(!a||"[object Object]"!==k.call(a))&&(!(b=e(a))||(c=l.call(b,"constructor")&&b.constructor,"function"==typeof c&&m.call(c)===n))},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?j[k.call(a)]||"object":typeof a},globalEval:function(a){p(a)},camelCase:function(a){return a.replace(t,"ms-").replace(u,v)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b){var c,d=0;if(w(a)){for(c=a.length;d<c;d++)if(b.call(a[d],d,a[d])===!1)break}else for(d in a)if(b.call(a[d],d,a[d])===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(s,"")},makeArray:function(a,b){var c=b
||[];return null!=a&&(w(Object(a))?r.merge(c,"string"==typeof a?[a]:a):h.call(c,a)),c},inArray:function(a,b,c){return null==b?-1:i.call(b,a,c)},merge:function(a,b){for(var c=+b.length,d=0,e=a.length;d<c;d++)a[e++]=b[d];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;f<g;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,e,f=0,h=[];if(w(a))for(d=a.length;f<d;f++)e=b(a[f],f,c),null!=e&&h.push(e);else for(f in a)e=b(a[f],f,c),null!=e&&h.push(e);return g.apply([],h)},guid:1,proxy:function(a,b){var c,d,e;if("string"==typeof b&&(c=a[b],b=a,a=c),r.isFunction(a))return d=f.call(arguments,2),e=function(){return a.apply(b||this,d.concat(f.call(arguments)))},e.guid=a.guid=a.guid||r.guid++,e},now:Date.now,support:o}),"function"==typeof Symbol&&(r.fn[Symbol.iterator]=c[Symbol.iterator]),r.each("Boolean Number String Function Array Date RegExp Object Error Symbol".split(" "),function(a,b){j["[object "+b+"]"]=b.toLowerCase()});function w(a){var b=
!!a&&"length"in a&&a.length,c=r.type(a);return"function"!==c&&!r.isWindow(a)&&("array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a)}var x=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+1*new Date,v=a.document,w=0,x=0,y=ha(),z=ha(),A=ha(),B=function(a,b){return a===b&&(l=!0),0},C={}.hasOwnProperty,D=[],E=D.pop,F=D.push,G=D.push,H=D.slice,I=function(a,b){for(var c=0,d=a.length;c<d;c++)if(a[c]===b)return c;return-1},J="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",K="[\\x20\\t\\r\\n\\f]",L="(?:\\\\.|[\\w-]|[^\0-\\xa0])+",M="\\["+K+"*("+L+")(?:"+K+"*([*^$|!~]?=)"+K+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+L+"))|)"+K+"*\\]",N=":("+L+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+M+")*)|.*)\\)|)",O=new RegExp(K+"+","g"),P=new RegExp("^"+K+"+|((?:^|[^\\\\])(?:\\\\.)*)"+K+"+$","g"),Q=new RegExp("^"+K+"*,"+K+"*"),R=new RegExp("^"+K+"*([>
+~]|"+K+")"+K+"*"),S=new RegExp("="+K+"*([^\\]'\"]*?)"+K+"*\\]","g"),T=new RegExp(N),U=new RegExp("^"+L+"$"),V={ID:new RegExp("^#("+L+")"),CLASS:new RegExp("^\\.("+L+")"),TAG:new RegExp("^("+L+"|[*])"),ATTR:new RegExp("^"+M),PSEUDO:new RegExp("^"+N),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+K+"*(even|odd|(([+-]|)(\\d*)n|)"+K+"*(?:([+-]|)"+K+"*(\\d+)|))"+K+"*\\)|)","i"),bool:new RegExp("^(?:"+J+")$","i"),needsContext:new RegExp("^"+K+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+K+"*((?:-\\d)?\\d*)"+K+"*\\)|)(?=[^-]|$)","i")},W=/^(?:input|select|textarea|button)$/i,X=/^h\d$/i,Y=/^[^{]+\{\s*\[native \w/,Z=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,$=/[+~]/,_=new RegExp("\\\\([\\da-f]{1,6}"+K+"?|("+K+")|.)","ig"),aa=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:d<0?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)},ba=/([\0-\x1f\x7f]|^-?\d)|^-$|[^\x80-\uFFFF\w-]/g,ca=function(a,b){return b?"\0"===a?"\ufffd":a.slice(0,-1)+"\\"
+a.charCodeAt(a.length-1).toString(16)+" ":"\\"+a},da=function(){m()},ea=ta(function(a){return a.disabled===!0},{dir:"parentNode",next:"legend"});try{G.apply(D=H.call(v.childNodes),v.childNodes),D[v.childNodes.length].nodeType}catch(fa){G={apply:D.length?function(a,b){F.apply(a,H.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function ga(a,b,d,e){var f,h,j,k,l,o,r,s=b&&b.ownerDocument,w=b?b.nodeType:9;if(d=d||[],"string"!=typeof a||!a||1!==w&&9!==w&&11!==w)return d;if(!e&&((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,p)){if(11!==w&&(l=Z.exec(a)))if(f=l[1]){if(9===w){if(!(j=b.getElementById(f)))return d;if(j.id===f)return d.push(j),d}else if(s&&(j=s.getElementById(f))&&t(b,j)&&j.id===f)return d.push(j),d}else{if(l[2])return G.apply(d,b.getElementsByTagName(a)),d;if((f=l[3])&&c.getElementsByClassName&&b.getElementsByClassName)return G.apply(d,b.getElementsByClassName(f)),d}if(c.qsa&&!A[a+" "]&&(!q||!q.test(a))){if(1!==w)s=b,r=a;else if("object"!==b.nodeNam
e.toLowerCase()){(k=b.getAttribute("id"))?k=k.replace(ba,ca):b.setAttribute("id",k=u),o=g(a),h=o.length;while(h--)o[h]="#"+k+" "+sa(o[h]);r=o.join(","),s=$.test(a)&&qa(b.parentNode)||b}if(r)try{return G.apply(d,s.querySelectorAll(r)),d}catch(x){}finally{k===u&&b.removeAttribute("id")}}}return i(a.replace(P,"$1"),b,d,e)}function ha(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function ia(a){return a[u]=!0,a}function ja(a){var b=n.createElement("fieldset");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function ka(a,b){var c=a.split("|"),e=c.length;while(e--)d.attrHandle[c[e]]=b}function la(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&a.sourceIndex-b.sourceIndex;if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function ma(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function na(a){return function(b){var c=b.nodeN
ame.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function oa(a){return function(b){return"label"in b&&b.disabled===a||"form"in b&&b.disabled===a||"form"in b&&b.disabled===!1&&(b.isDisabled===a||b.isDisabled!==!a&&("label"in b||!ea(b))!==a)}}function pa(a){return ia(function(b){return b=+b,ia(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function qa(a){return a&&"undefined"!=typeof a.getElementsByTagName&&a}c=ga.support={},f=ga.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return!!b&&"HTML"!==b.nodeName},m=ga.setDocument=function(a){var b,e,g=a?a.ownerDocument||a:v;return g!==n&&9===g.nodeType&&g.documentElement?(n=g,o=n.documentElement,p=!f(n),v!==n&&(e=n.defaultView)&&e.top!==e&&(e.addEventListener?e.addEventListener("unload",da,!1):e.attachEvent&&e.attachEvent("onunload",da)),c.attributes=ja(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ja(function(a){retur
n a.appendChild(n.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=Y.test(n.getElementsByClassName),c.getById=ja(function(a){return o.appendChild(a).id=u,!n.getElementsByName||!n.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if("undefined"!=typeof b.getElementById&&p){var c=b.getElementById(a);return c?[c]:[]}},d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(_,aa);return function(a){var c="undefined"!=typeof a.getAttributeNode&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return"undefined"!=typeof b.getElementsByTagName?b.getElementsByTagName(a):c.qsa?b.querySelectorAll(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){if("undefine
d"!=typeof b.getElementsByClassName&&p)return b.getElementsByClassName(a)},r=[],q=[],(c.qsa=Y.test(n.querySelectorAll))&&(ja(function(a){o.appendChild(a).innerHTML="<a id='"+u+"'></a><select id='"+u+"-\r\\' msallowcapture=''><option selected=''></option></select>",a.querySelectorAll("[msallowcapture^='']").length&&q.push("[*^$]="+K+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+K+"*(?:value|"+J+")"),a.querySelectorAll("[id~="+u+"-]").length||q.push("~="),a.querySelectorAll(":checked").length||q.push(":checked"),a.querySelectorAll("a#"+u+"+*").length||q.push(".#.+[+~]")}),ja(function(a){a.innerHTML="<a href='' disabled='disabled'></a><select disabled='disabled'><option/></select>";var b=n.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+K+"*[*^$|!~]?="),2!==a.querySelectorAll(":enabled").length&&q.push(":enabled",":disabled"),o.appendChild(a).disabled=!0,2!==a.q
uerySelectorAll(":disabled").length&&q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=Y.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ja(function(a){c.disconnectedMatch=s.call(a,"*"),s.call(a,"[s!='']:x"),r.push("!=",N)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=Y.test(o.compareDocumentPosition),t=b||Y.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===n||a.ownerDocument==
=v&&t(v,a)?-1:b===n||b.ownerDocument===v&&t(v,b)?1:k?I(k,a)-I(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,e=a.parentNode,f=b.parentNode,g=[a],h=[b];if(!e||!f)return a===n?-1:b===n?1:e?-1:f?1:k?I(k,a)-I(k,b):0;if(e===f)return la(a,b);c=a;while(c=c.parentNode)g.unshift(c);c=b;while(c=c.parentNode)h.unshift(c);while(g[d]===h[d])d++;return d?la(g[d],h[d]):g[d]===v?-1:h[d]===v?1:0},n):n},ga.matches=function(a,b){return ga(a,null,null,b)},ga.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(S,"='$1']"),c.matchesSelector&&p&&!A[b+" "]&&(!r||!r.test(b))&&(!q||!q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return ga(b,n,null,[a]).length>0},ga.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},ga.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&C.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.
attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},ga.escape=function(a){return(a+"").replace(ba,ca)},ga.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},ga.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=ga.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=ga.selectors={cacheLength:50,createPseudo:ia,match:V,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(_,aa),a[3]=(a[3]||a[4]||a[5]||"").replace(_,aa),"~="===a[2]&
&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||ga.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&ga.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return V.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&T.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(_,aa).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+K+")"+a+"("+K+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||"undefined"!=typeof a.getAttribute&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=ga.attr(d,a);return null==e?"!="===b:!b||(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.index
Of(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e.replace(O," ")+" ").indexOf(c)>-1:"|="===b&&(e===c||e.slice(0,c.length+1)===c+"-"))}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h,t=!1;if(q){if(f){while(p){m=b;while(m=m[p])if(h?m.nodeName.toLowerCase()===r:1===m.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){m=q,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n&&j[2],m=n&&q.childNodes[n];while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if(1===m.nodeType&&++t&&m===b){k[a]=[w,n,t];break}}else if(s&&(m=b,l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),j=k[a]||[],n=j[0]===w&&j[1],t=n),t===!1)while(m=++n&&m&&m[p]||(t=n=0)||o.pop())if((h?m.nodeNa
me.toLowerCase()===r:1===m.nodeType)&&++t&&(s&&(l=m[u]||(m[u]={}),k=l[m.uniqueID]||(l[m.uniqueID]={}),k[a]=[w,t]),m===b))break;return t-=e,t===d||t%d===0&&t/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||ga.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?ia(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=I(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:ia(function(a){var b=[],c=[],d=h(a.replace(P,"$1"));return d[u]?ia(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),b[0]=null,!c.pop()}}),has:ia(function(a){return function(b){return ga(a,b).length>0}}),contains:ia(function(a){return a=a.replace(_,aa),function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:ia(function(a){return U.test(a||"")||ga.error("unsupported lang: "+a),a=a.replace(_,aa).toL
owerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:oa(!1),disabled:oa(!0),checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return X.test(a.nodeName)},input:function(a){return W.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){
var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:pa(function(){return[0]}),last:pa(function(a,b){return[b-1]}),eq:pa(function(a,b,c){return[c<0?c+b:c]}),even:pa(function(a,b){for(var c=0;c<b;c+=2)a.push(c);return a}),odd:pa(function(a,b){for(var c=1;c<b;c+=2)a.push(c);return a}),lt:pa(function(a,b,c){for(var d=c<0?c+b:c;--d>=0;)a.push(d);return a}),gt:pa(function(a,b,c){for(var d=c<0?c+b:c;++d<b;)a.push(d);return a})}},d.pseudos.nth=d.pseudos.eq;for(b in{radio:!0,checkbox:!0,file:!0,password:!0,image:!0})d.pseudos[b]=ma(b);for(b in{submit:!0,reset:!0})d.pseudos[b]=na(b);function ra(){}ra.prototype=d.filters=d.pseudos,d.setFilters=new ra,g=ga.tokenize=function(a,b){var c,e,f,g,h,i,j,k=z[a+" "];if(k)return b?0:k.slice(0);h=a,i=[],j=d.preFilter;while(h){c&&!(e=Q.exec(h))||(e&&(h=h.slice(e[0].length)||h),i.push(f=[])),c=!1,(e=R.exec(h))&&(c=e.shift(),f.push({value:c,type:e[0].replace(P," ")}),h=h.slice(c
.length));for(g in d.filter)!(e=V[g].exec(h))||j[g]&&!(e=j[g](e))||(c=e.shift(),f.push({value:c,type:g,matches:e}),h=h.slice(c.length));if(!c)break}return b?h.length:h?ga.error(a):z(a,i).slice(0)};function sa(a){for(var b=0,c=a.length,d="";b<c;b++)d+=a[b].value;return d}function ta(a,b,c){var d=b.dir,e=b.next,f=e||d,g=c&&"parentNode"===f,h=x++;return b.first?function(b,c,e){while(b=b[d])if(1===b.nodeType||g)return a(b,c,e)}:function(b,c,i){var j,k,l,m=[w,h];if(i){while(b=b[d])if((1===b.nodeType||g)&&a(b,c,i))return!0}else while(b=b[d])if(1===b.nodeType||g)if(l=b[u]||(b[u]={}),k=l[b.uniqueID]||(l[b.uniqueID]={}),e&&e===b.nodeName.toLowerCase())b=b[d]||b;else{if((j=k[f])&&j[0]===w&&j[1]===h)return m[2]=j[2];if(k[f]=m,m[2]=a(b,c,i))return!0}}}function ua(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function va(a,b,c){for(var d=0,e=b.length;d<e;d++)ga(a,b[d],c);return c}function wa(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=
b;h<i;h++)(f=a[h])&&(c&&!c(f,d,e)||(g.push(f),j&&b.push(h)));return g}function xa(a,b,c,d,e,f){return d&&!d[u]&&(d=xa(d)),e&&!e[u]&&(e=xa(e,f)),ia(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||va(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:wa(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=wa(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?I(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=wa(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):G.apply(g,r)})}function ya(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=ta(function(a){return a===b},h,!0),l=ta(function(a){return I(b,a)>-1},h,!0),m=[function(a,c,d){var e=!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d));return b=null,e}];i<f;i++)if(c=d.relative[a[i].type])m=[ta(ua(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++
i;e<f;e++)if(d.relative[a[e].type])break;return xa(i>1&&ua(m),i>1&&sa(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(P,"$1"),c,i<e&&ya(a.slice(i,e)),e<f&&ya(a=a.slice(e)),e<f&&sa(a))}m.push(c)}return ua(m)}function za(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,o,q,r=0,s="0",t=f&&[],u=[],v=j,x=f||e&&d.find.TAG("*",k),y=w+=null==v?1:Math.random()||.1,z=x.length;for(k&&(j=g===n||g||k);s!==z&&null!=(l=x[s]);s++){if(e&&l){o=0,g||l.ownerDocument===n||(m(l),h=!p);while(q=a[o++])if(q(l,g||n,h)){i.push(l);break}k&&(w=y)}c&&((l=!q&&l)&&r--,f&&t.push(l))}if(r+=s,c&&s!==r){o=0;while(q=b[o++])q(t,u,g,h);if(f){if(r>0)while(s--)t[s]||u[s]||(u[s]=E.call(i));u=wa(u)}G.apply(i,u),k&&!f&&u.length>0&&r+b.length>1&&ga.uniqueSort(i)}return k&&(w=y,j=v),t};return c?ia(f):f}return h=ga.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=ya(b[c]),f[u]?d.push(f):e.push(f);f=A(a,za(e,d)),f.selector=a}return f},i=ga.select=function(a,
b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(_,aa),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=V.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(_,aa),$.test(j[0].type)&&qa(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&sa(j),!a)return G.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,!b||$.test(a)&&qa(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ja(function(a){return 1&a.compareDocumentPosition(n.createElement("fieldset"))}),ja(function(a){return a.innerHTML="<a href='#'></a>","#"===a.firstChild.getAttribute("href")})||ka("type|href|height|width",function(a,b,c){if(!c)return a.getAttribute(b,"type"===b.toLowerCa
se()?1:2)}),c.attributes&&ja(function(a){return a.innerHTML="<input/>",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||ka("value",function(a,b,c){if(!c&&"input"===a.nodeName.toLowerCase())return a.defaultValue}),ja(function(a){return null==a.getAttribute("disabled")})||ka(J,function(a,b,c){var d;if(!c)return a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),ga}(a);r.find=x,r.expr=x.selectors,r.expr[":"]=r.expr.pseudos,r.uniqueSort=r.unique=x.uniqueSort,r.text=x.getText,r.isXMLDoc=x.isXML,r.contains=x.contains,r.escapeSelector=x.escape;var y=function(a,b,c){var d=[],e=void 0!==c;while((a=a[b])&&9!==a.nodeType)if(1===a.nodeType){if(e&&r(a).is(c))break;d.push(a)}return d},z=function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c},A=r.expr.match.needsContext,B=/^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i,C=/^.[^:#\[\.,]*$/;function D(a,b,c){if(r.isFunction(b))return r.grep(
a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return r.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(C.test(b))return r.filter(b,a,c);b=r.filter(b,a)}return r.grep(a,function(a){return i.call(b,a)>-1!==c&&1===a.nodeType})}r.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?r.find.matchesSelector(d,a)?[d]:[]:r.find.matches(a,r.grep(b,function(a){return 1===a.nodeType}))},r.fn.extend({find:function(a){var b,c,d=this.length,e=this;if("string"!=typeof a)return this.pushStack(r(a).filter(function(){for(b=0;b<d;b++)if(r.contains(e[b],this))return!0}));for(c=this.pushStack([]),b=0;b<d;b++)r.find(a,e[b],c);return d>1?r.uniqueSort(c):c},filter:function(a){return this.pushStack(D(this,a||[],!1))},not:function(a){return this.pushStack(D(this,a||[],!0))},is:function(a){return!!D(this,"string"==typeof a&&A.test(a)?r(a):a||[],!1).length}});var E,F=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,G=r.fn.init=function(a,b,c){var e,f;if(!a)
return this;if(c=c||E,"string"==typeof a){if(e="<"===a[0]&&">"===a[a.length-1]&&a.length>=3?[null,a,null]:F.exec(a),!e||!e[1]&&b)return!b||b.jquery?(b||c).find(a):this.constructor(b).find(a);if(e[1]){if(b=b instanceof r?b[0]:b,r.merge(this,r.parseHTML(e[1],b&&b.nodeType?b.ownerDocument||b:d,!0)),B.test(e[1])&&r.isPlainObject(b))for(e in b)r.isFunction(this[e])?this[e](b[e]):this.attr(e,b[e]);return this}return f=d.getElementById(e[2]),f&&(this[0]=f,this.length=1),this}return a.nodeType?(this[0]=a,this.length=1,this):r.isFunction(a)?void 0!==c.ready?c.ready(a):a(r):r.makeArray(a,this)};G.prototype=r.fn,E=r(d);var H=/^(?:parents|prev(?:Until|All))/,I={children:!0,contents:!0,next:!0,prev:!0};r.fn.extend({has:function(a){var b=r(a,this),c=b.length;return this.filter(function(){for(var a=0;a<c;a++)if(r.contains(this,b[a]))return!0})},closest:function(a,b){var c,d=0,e=this.length,f=[],g="string"!=typeof a&&r(a);if(!A.test(a))for(;d<e;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeTyp
e<11&&(g?g.index(c)>-1:1===c.nodeType&&r.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?r.uniqueSort(f):f)},index:function(a){return a?"string"==typeof a?i.call(r(a),this[0]):i.call(this,a.jquery?a[0]:a):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(r.uniqueSort(r.merge(this.get(),r(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function J(a,b){while((a=a[b])&&1!==a.nodeType);return a}r.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return y(a,"parentNode")},parentsUntil:function(a,b,c){return y(a,"parentNode",c)},next:function(a){return J(a,"nextSibling")},prev:function(a){return J(a,"previousSibling")},nextAll:function(a){return y(a,"nextSibling")},prevAll:function(a){return y(a,"previousSibling")},nextUntil:function(a,b,c){return y(a,"nextSibling",c)},prevUntil:function(a,b,c){return y(a,"previ
ousSibling",c)},siblings:function(a){return z((a.parentNode||{}).firstChild,a)},children:function(a){return z(a.firstChild)},contents:function(a){return a.contentDocument||r.merge([],a.childNodes)}},function(a,b){r.fn[a]=function(c,d){var e=r.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=r.filter(d,e)),this.length>1&&(I[a]||r.uniqueSort(e),H.test(a)&&e.reverse()),this.pushStack(e)}});var K=/\S+/g;function L(a){var b={};return r.each(a.match(K)||[],function(a,c){b[c]=!0}),b}r.Callbacks=function(a){a="string"==typeof a?L(a):r.extend({},a);var b,c,d,e,f=[],g=[],h=-1,i=function(){for(e=a.once,d=b=!0;g.length;h=-1){c=g.shift();while(++h<f.length)f[h].apply(c[0],c[1])===!1&&a.stopOnFalse&&(h=f.length,c=!1)}a.memory||(c=!1),b=!1,e&&(f=c?[]:"")},j={add:function(){return f&&(c&&!b&&(h=f.length-1,g.push(c)),function d(b){r.each(b,function(b,c){r.isFunction(c)?a.unique&&j.has(c)||f.push(c):c&&c.length&&"string"!==r.type(c)&&d(c)})}(arguments),c&&!b&&i()),this},remo
ve:function(){return r.each(arguments,function(a,b){var c;while((c=r.inArray(b,f,c))>-1)f.splice(c,1),c<=h&&h--}),this},has:function(a){return a?r.inArray(a,f)>-1:f.length>0},empty:function(){return f&&(f=[]),this},disable:function(){return e=g=[],f=c="",this},disabled:function(){return!f},lock:function(){return e=g=[],c||b||(f=c=""),this},locked:function(){return!!e},fireWith:function(a,c){return e||(c=c||[],c=[a,c.slice?c.slice():c],g.push(c),b||i()),this},fire:function(){return j.fireWith(this,arguments),this},fired:function(){return!!d}};return j};function M(a){return a}function N(a){throw a}function O(a,b,c){var d;try{a&&r.isFunction(d=a.promise)?d.call(a).done(b).fail(c):a&&r.isFunction(d=a.then)?d.call(a,b,c):b.call(void 0,a)}catch(a){c.call(void 0,a)}}r.extend({Deferred:function(b){var c=[["notify","progress",r.Callbacks("memory"),r.Callbacks("memory"),2],["resolve","done",r.Callbacks("once memory"),r.Callbacks("once memory"),0,"resolved"],["reject","fail",r.Callbacks("once
memory"),r.Callbacks("once memory"),1,"rejected"]],d="pending",e={state:function(){return d},always:function(){return f.done(arguments).fail(arguments),this},"catch":function(a){return e.then(null,a)},pipe:function(){var a=arguments;return r.Deferred(function(b){r.each(c,function(c,d){var e=r.isFunction(a[d[4]])&&a[d[4]];f[d[1]](function(){var a=e&&e.apply(this,arguments);a&&r.isFunction(a.promise)?a.promise().progress(b.notify).done(b.resolve).fail(b.reject):b[d[0]+"With"](this,e?[a]:arguments)})}),a=null}).promise()},then:function(b,d,e){var f=0;function g(b,c,d,e){return function(){var h=this,i=arguments,j=function(){var a,j;if(!(b<f)){if(a=d.apply(h,i),a===c.promise())throw new TypeError("Thenable self-resolution");j=a&&("object"==typeof a||"function"==typeof a)&&a.then,r.isFunction(j)?e?j.call(a,g(f,c,M,e),g(f,c,N,e)):(f++,j.call(a,g(f,c,M,e),g(f,c,N,e),g(f,c,M,c.notifyWith))):(d!==M&&(h=void 0,i=[a]),(e||c.resolveWith)(h,i))}},k=e?j:function(){try{j()}catch(a){r.Deferred.excep
tionHook&&r.Deferred.exceptionHook(a,k.stackTrace),b+1>=f&&(d!==N&&(h=void 0,i=[a]),c.rejectWith(h,i))}};b?k():(r.Deferred.getStackHook&&(k.stackTrace=r.Deferred.getStackHook()),a.setTimeout(k))}}return r.Deferred(function(a){c[0][3].add(g(0,a,r.isFunction(e)?e:M,a.notifyWith)),c[1][3].add(g(0,a,r.isFunction(b)?b:M)),c[2][3].add(g(0,a,r.isFunction(d)?d:N))}).promise()},promise:function(a){return null!=a?r.extend(a,e):e}},f={};return r.each(c,function(a,b){var g=b[2],h=b[5];e[b[1]]=g.add,h&&g.add(function(){d=h},c[3-a][2].disable,c[0][2].lock),g.add(b[3].fire),f[b[0]]=function(){return f[b[0]+"With"](this===f?void 0:this,arguments),this},f[b[0]+"With"]=g.fireWith}),e.promise(f),b&&b.call(f,f),f},when:function(a){var b=arguments.length,c=b,d=Array(c),e=f.call(arguments),g=r.Deferred(),h=function(a){return function(c){d[a]=this,e[a]=arguments.length>1?f.call(arguments):c,--b||g.resolveWith(d,e)}};if(b<=1&&(O(a,g.done(h(c)).resolve,g.reject),"pending"===g.state()||r.isFunction(e[c]&&e[c
].then)))return g.then();while(c--)O(e[c],h(c),g.reject);return g.promise()}});var P=/^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;r.Deferred.exceptionHook=function(b,c){a.console&&a.console.warn&&b&&P.test(b.name)&&a.console.warn("jQuery.Deferred exception: "+b.message,b.stack,c)},r.readyException=function(b){a.setTimeout(function(){throw b})};var Q=r.Deferred();r.fn.ready=function(a){return Q.then(a)["catch"](function(a){r.readyException(a)}),this},r.extend({isReady:!1,readyWait:1,holdReady:function(a){a?r.readyWait++:r.ready(!0)},ready:function(a){(a===!0?--r.readyWait:r.isReady)||(r.isReady=!0,a!==!0&&--r.readyWait>0||Q.resolveWith(d,[r]))}}),r.ready.then=Q.then;function R(){d.removeEventListener("DOMContentLoaded",R),a.removeEventListener("load",R),r.ready()}"complete"===d.readyState||"loading"!==d.readyState&&!d.documentElement.doScroll?a.setTimeout(r.ready):(d.addEventListener("DOMContentLoaded",R),a.addEventListener("load",R));var S=function(a,b,c,d,e,f,g){var h=0
,i=a.length,j=null==c;if("object"===r.type(c)){e=!0;for(h in c)S(a,b,h,c[h],!0,f,g)}else if(void 0!==d&&(e=!0,
-r.isFunction(d)||(g=!0),j&&(g?(b.call(a,d),b=null):(j=b,b=function(a,b,c){return j.call(r(a),c)})),b))for(;h<i;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},T=function(a){return 1===a.nodeType||9===a.nodeType||!+a.nodeType};function U(){this.expando=r.expando+U.uid++}U.uid=1,U.prototype={cache:function(a){var b=a[this.expando];return b||(b={},T(a)&&(a.nodeType?a[this.expando]=b:Object.defineProperty(a,this.expando,{value:b,configurable:!0}))),b},set:function(a,b,c){var d,e=this.cache(a);if("string"==typeof b)e[r.camelCase(b)]=c;else for(d in b)e[r.camelCase(d)]=b[d];return e},get:function(a,b){return void 0===b?this.cache(a):a[this.expando]&&a[this.expando][r.camelCase(b)]},access:function(a,b,c){return void 0===b||b&&"string"==typeof b&&void 0===c?this.get(a,b):(this.set(a,b,c),void 0!==c?c:b)},remove:function(a,b){var c,d=a[this.expando];if(void 0!==d){if(void 0!==b){r.isArray(b)?b=b.map(r.camelCase):(b=r.camelCase(b),b=b in d?[b]:b.match(K)||[])
,c=b.length;while(c--)delete d[b[c]]}(void 0===b||r.isEmptyObject(d))&&(a.nodeType?a[this.expando]=void 0:delete a[this.expando])}},hasData:function(a){var b=a[this.expando];return void 0!==b&&!r.isEmptyObject(b)}};var V=new U,W=new U,X=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,Y=/[A-Z]/g;function Z(a,b,c){var d;if(void 0===c&&1===a.nodeType)if(d="data-"+b.replace(Y,"-$&").toLowerCase(),c=a.getAttribute(d),"string"==typeof c){try{c="true"===c||"false"!==c&&("null"===c?null:+c+""===c?+c:X.test(c)?JSON.parse(c):c)}catch(e){}W.set(a,b,c)}else c=void 0;return c}r.extend({hasData:function(a){return W.hasData(a)||V.hasData(a)},data:function(a,b,c){return W.access(a,b,c)},removeData:function(a,b){W.remove(a,b)},_data:function(a,b,c){return V.access(a,b,c)},_removeData:function(a,b){V.remove(a,b)}}),r.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=W.get(f),1===f.nodeType&&!V.get(f,"hasDataAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.in
dexOf("data-")&&(d=r.camelCase(d.slice(5)),Z(f,d,e[d])));V.set(f,"hasDataAttrs",!0)}return e}return"object"==typeof a?this.each(function(){W.set(this,a)}):S(this,function(b){var c;if(f&&void 0===b){if(c=W.get(f,a),void 0!==c)return c;if(c=Z(f,a),void 0!==c)return c}else this.each(function(){W.set(this,a,b)})},null,b,arguments.length>1,null,!0)},removeData:function(a){return this.each(function(){W.remove(this,a)})}}),r.extend({queue:function(a,b,c){var d;if(a)return b=(b||"fx")+"queue",d=V.get(a,b),c&&(!d||r.isArray(c)?d=V.access(a,b,r.makeArray(c)):d.push(c)),d||[]},dequeue:function(a,b){b=b||"fx";var c=r.queue(a,b),d=c.length,e=c.shift(),f=r._queueHooks(a,b),g=function(){r.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return V.get(a,c)||V.access(a,c,{empty:r.Callbacks("once memory").add(function(){V.remove(a,[b+"queue",c])})})}}),r.fn.extend({
queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.length<c?r.queue(this[0],a):void 0===b?this:this.each(function(){var c=r.queue(this,a,b);r._queueHooks(this,a),"fx"===a&&"inprogress"!==c[0]&&r.dequeue(this,a)})},dequeue:function(a){return this.each(function(){r.dequeue(this,a)})},clearQueue:function(a){return this.queue(a||"fx",[])},promise:function(a,b){var c,d=1,e=r.Deferred(),f=this,g=this.length,h=function(){--d||e.resolveWith(f,[f])};"string"!=typeof a&&(b=a,a=void 0),a=a||"fx";while(g--)c=V.get(f[g],a+"queueHooks"),c&&c.empty&&(d++,c.empty.add(h));return h(),e.promise(b)}});var $=/[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source,_=new RegExp("^(?:([+-])=|)("+$+")([a-z%]*)$","i"),aa=["Top","Right","Bottom","Left"],ba=function(a,b){return a=b||a,"none"===a.style.display||""===a.style.display&&r.contains(a.ownerDocument,a)&&"none"===r.css(a,"display")},ca=function(a,b,c,d){var e,f,g={};for(f in b)g[f]=a.style[f],a.style[f]=b[f];e=c.apply(a,d||[]);for(f
in b)a.style[f]=g[f];return e};function da(a,b,c,d){var e,f=1,g=20,h=d?function(){return d.cur()}:function(){return r.css(a,b,"")},i=h(),j=c&&c[3]||(r.cssNumber[b]?"":"px"),k=(r.cssNumber[b]||"px"!==j&&+i)&&_.exec(r.css(a,b));if(k&&k[3]!==j){j=j||k[3],c=c||[],k=+i||1;do f=f||".5",k/=f,r.style(a,b,k+j);while(f!==(f=h()/i)&&1!==f&&--g)}return c&&(k=+k||+i||0,e=c[1]?k+(c[1]+1)*c[2]:+c[2],d&&(d.unit=j,d.start=k,d.end=e)),e}var ea={};function fa(a){var b,c=a.ownerDocument,d=a.nodeName,e=ea[d];return e?e:(b=c.body.appendChild(c.createElement(d)),e=r.css(b,"display"),b.parentNode.removeChild(b),"none"===e&&(e="block"),ea[d]=e,e)}function ga(a,b){for(var c,d,e=[],f=0,g=a.length;f<g;f++)d=a[f],d.style&&(c=d.style.display,b?("none"===c&&(e[f]=V.get(d,"display")||null,e[f]||(d.style.display="")),""===d.style.display&&ba(d)&&(e[f]=fa(d))):"none"!==c&&(e[f]="none",V.set(d,"display",c)));for(f=0;f<g;f++)null!=e[f]&&(a[f].style.display=e[f]);return a}r.fn.extend({show:function(){return ga(this,!0)
},hide:function(){return ga(this)},toggle:function(a){return"boolean"==typeof a?a?this.show():this.hide():this.each(function(){ba(this)?r(this).show():r(this).hide()})}});var ha=/^(?:checkbox|radio)$/i,ia=/<([a-z][^\/\0>\x20\t\r\n\f]+)/i,ja=/^$|\/(?:java|ecma)script/i,ka={option:[1,"<select multiple='multiple'>","</select>"],thead:[1,"<table>","</table>"],col:[2,"<table><colgroup>","</colgroup></table>"],tr:[2,"<table><tbody>","</tbody></table>"],td:[3,"<table><tbody><tr>","</tr></tbody></table>"],_default:[0,"",""]};ka.optgroup=ka.option,ka.tbody=ka.tfoot=ka.colgroup=ka.caption=ka.thead,ka.th=ka.td;function la(a,b){var c="undefined"!=typeof a.getElementsByTagName?a.getElementsByTagName(b||"*"):"undefined"!=typeof a.querySelectorAll?a.querySelectorAll(b||"*"):[];return void 0===b||b&&r.nodeName(a,b)?r.merge([a],c):c}function ma(a,b){for(var c=0,d=a.length;c<d;c++)V.set(a[c],"globalEval",!b||V.get(b[c],"globalEval"))}var na=/<|&#?\w+;/;function oa(a,b,c,d,e){for(var f,g,h,i,j,k,l=b.c
reateDocumentFragment(),m=[],n=0,o=a.length;n<o;n++)if(f=a[n],f||0===f)if("object"===r.type(f))r.merge(m,f.nodeType?[f]:f);else if(na.test(f)){g=g||l.appendChild(b.createElement("div")),h=(ia.exec(f)||["",""])[1].toLowerCase(),i=ka[h]||ka._default,g.innerHTML=i[1]+r.htmlPrefilter(f)+i[2],k=i[0];while(k--)g=g.lastChild;r.merge(m,g.childNodes),g=l.firstChild,g.textContent=""}else m.push(b.createTextNode(f));l.textContent="",n=0;while(f=m[n++])if(d&&r.inArray(f,d)>-1)e&&e.push(f);else if(j=r.contains(f.ownerDocument,f),g=la(l.appendChild(f),"script"),j&&ma(g),c){k=0;while(f=g[k++])ja.test(f.type||"")&&c.push(f)}return l}!function(){var a=d.createDocumentFragment(),b=a.appendChild(d.createElement("div")),c=d.createElement("input");c.setAttribute("type","radio"),c.setAttribute("checked","checked"),c.setAttribute("name","t"),b.appendChild(c),o.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,b.innerHTML="<textarea>x</textarea>",o.noCloneChecked=!!b.cloneNode(!0).lastChild.defaul
tValue}();var pa=d.documentElement,qa=/^key/,ra=/^(?:mouse|pointer|contextmenu|drag|drop)|click/,sa=/^([^.]*)(?:\.(.+)|)/;function ta(){return!0}function ua(){return!1}function va(){try{return d.activeElement}catch(a){}}function wa(a,b,c,d,e,f){var g,h;if("object"==typeof b){"string"!=typeof c&&(d=d||c,c=void 0);for(h in b)wa(a,h,c,d,b[h],f);return a}if(null==d&&null==e?(e=c,d=c=void 0):null==e&&("string"==typeof c?(e=d,d=void 0):(e=d,d=c,c=void 0)),e===!1)e=ua;else if(!e)return a;return 1===f&&(g=e,e=function(a){return r().off(a),g.apply(this,arguments)},e.guid=g.guid||(g.guid=r.guid++)),a.each(function(){r.event.add(this,b,e,d,c)})}r.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=V.get(a);if(q){c.handler&&(f=c,c=f.handler,e=f.selector),e&&r.find.matchesSelector(pa,e),c.guid||(c.guid=r.guid++),(i=q.events)||(i=q.events={}),(g=q.handle)||(g=q.handle=function(b){return"undefined"!=typeof r&&r.event.triggered!==b.type?r.event.dispatch.apply(a,arguments):void 0}),
b=(b||"").match(K)||[""],j=b.length;while(j--)h=sa.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n&&(l=r.event.special[n]||{},n=(e?l.delegateType:l.bindType)||n,l=r.event.special[n]||{},k=r.extend({type:n,origType:p,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&r.expr.match.needsContext.test(e),namespace:o.join(".")},f),(m=i[n])||(m=i[n]=[],m.delegateCount=0,l.setup&&l.setup.call(a,d,o,g)!==!1||a.addEventListener&&a.addEventListener(n,g)),l.add&&(l.add.call(a,k),k.handler.guid||(k.handler.guid=c.guid)),e?m.splice(m.delegateCount++,0,k):m.push(k),r.event.global[n]=!0)}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,m,n,o,p,q=V.hasData(a)&&V.get(a);if(q&&(i=q.events)){b=(b||"").match(K)||[""],j=b.length;while(j--)if(h=sa.exec(b[j])||[],n=p=h[1],o=(h[2]||"").split(".").sort(),n){l=r.event.special[n]||{},n=(d?l.delegateType:l.bindType)||n,m=i[n]||[],h=h[2]&&new RegExp("(^|\\.)"+o.join("\\.(?:.*\\.|)")+"(\\.|$)"),g=f=m.length;while(f--)k=m[f],!e&&p!==k.origType||c&&c.gu
id!==k.guid||h&&!h.test(k.namespace)||d&&d!==k.selector&&("**"!==d||!k.selector)||(m.splice(f,1),k.selector&&m.delegateCount--,l.remove&&l.remove.call(a,k));g&&!m.length&&(l.teardown&&l.teardown.call(a,o,q.handle)!==!1||r.removeEvent(a,n,q.handle),delete i[n])}else for(n in i)r.event.remove(a,n+b[j],c,d,!0);r.isEmptyObject(i)&&V.remove(a,"handle events")}},dispatch:function(a){var b=r.event.fix(a),c,d,e,f,g,h,i=new Array(arguments.length),j=(V.get(this,"events")||{})[b.type]||[],k=r.event.special[b.type]||{};for(i[0]=b,c=1;c<arguments.length;c++)i[c]=arguments[c];if(b.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,b)!==!1){h=r.event.handlers.call(this,b,j),c=0;while((f=h[c++])&&!b.isPropagationStopped()){b.currentTarget=f.elem,d=0;while((g=f.handlers[d++])&&!b.isImmediatePropagationStopped())b.rnamespace&&!b.rnamespace.test(g.namespace)||(b.handleObj=g,b.data=g.data,e=((r.event.special[g.origType]||{}).handle||g.handler).apply(f.elem,i),void 0!==e&&(b.result=e)===!1&&(b
.preventDefault(),b.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,b),b.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&("click"!==a.type||isNaN(a.button)||a.button<1))for(;i!==this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(d=[],c=0;c<h;c++)f=b[c],e=f.selector+" ",void 0===d[e]&&(d[e]=f.needsContext?r(e,this).index(i)>-1:r.find(e,this,null,[i]).length),d[e]&&d.push(f);d.length&&g.push({elem:i,handlers:d})}return h<b.length&&g.push({elem:this,handlers:b.slice(h)}),g},addProp:function(a,b){Object.defineProperty(r.Event.prototype,a,{enumerable:!0,configurable:!0,get:r.isFunction(b)?function(){if(this.originalEvent)return b(this.originalEvent)}:function(){if(this.originalEvent)return this.originalEvent[a]},set:function(b){Object.defineProperty(this,a,{enumerable:!0,configurable:!0,writable:!0,value:b})}})},fix:function(a){return a[r.expando]?a:new r.Event(a)},special:{load:{noBubb
le:!0},focus:{trigger:function(){if(this!==va()&&this.focus)return this.focus(),!1},delegateType:"focusin"},blur:{trigger:function(){if(this===va()&&this.blur)return this.blur(),!1},delegateType:"focusout"},click:{trigger:function(){if("checkbox"===this.type&&this.click&&r.nodeName(this,"input"))return this.click(),!1},_default:function(a){return r.nodeName(a.target,"a")}},beforeunload:{postDispatch:function(a){void 0!==a.result&&a.originalEvent&&(a.originalEvent.returnValue=a.result)}}}},r.removeEvent=function(a,b,c){a.removeEventListener&&a.removeEventListener(b,c)},r.Event=function(a,b){return this instanceof r.Event?(a&&a.type?(this.originalEvent=a,this.type=a.type,this.isDefaultPrevented=a.defaultPrevented||void 0===a.defaultPrevented&&a.returnValue===!1?ta:ua,this.target=a.target&&3===a.target.nodeType?a.target.parentNode:a.target,this.currentTarget=a.currentTarget,this.relatedTarget=a.relatedTarget):this.type=a,b&&r.extend(this,b),this.timeStamp=a&&a.timeStamp||r.now(),void(t
his[r.expando]=!0)):new r.Event(a,b)},r.Event.prototype={constructor:r.Event,isDefaultPrevented:ua,isPropagationStopped:ua,isImmediatePropagationStopped:ua,isSimulated:!1,preventDefault:function(){var a=this.originalEvent;this.isDefaultPrevented=ta,a&&!this.isSimulated&&a.preventDefault()},stopPropagation:function(){var a=this.originalEvent;this.isPropagationStopped=ta,a&&!this.isSimulated&&a.stopPropagation()},stopImmediatePropagation:function(){var a=this.originalEvent;this.isImmediatePropagationStopped=ta,a&&!this.isSimulated&&a.stopImmediatePropagation(),this.stopPropagation()}},r.each({altKey:!0,bubbles:!0,cancelable:!0,changedTouches:!0,ctrlKey:!0,detail:!0,eventPhase:!0,metaKey:!0,pageX:!0,pageY:!0,shiftKey:!0,view:!0,"char":!0,charCode:!0,key:!0,keyCode:!0,button:!0,buttons:!0,clientX:!0,clientY:!0,offsetX:!0,offsetY:!0,pointerId:!0,pointerType:!0,screenX:!0,screenY:!0,targetTouches:!0,toElement:!0,touches:!0,which:function(a){var b=a.button;return null==a.which&&qa.test(a.t
ype)?null!=a.charCode?a.charCode:a.keyCode:!a.which&&void 0!==b&&ra.test(a.type)?1&b?1:2&b?3:4&b?2:0:a.which}},r.event.addProp),r.each({mouseenter:"mouseover",mouseleave:"mouseout",pointerenter:"pointerover",pointerleave:"pointerout"},function(a,b){r.event.special[a]={delegateType:b,bindType:b,handle:function(a){var c,d=this,e=a.relatedTarget,f=a.handleObj;return e&&(e===d||r.contains(d,e))||(a.type=f.origType,c=f.handler.apply(this,arguments),a.type=b),c}}}),r.fn.extend({on:function(a,b,c,d){return wa(this,a,b,c,d)},one:function(a,b,c,d){return wa(this,a,b,c,d,1)},off:function(a,b,c){var d,e;if(a&&a.preventDefault&&a.handleObj)return d=a.handleObj,r(a.delegateTarget).off(d.namespace?d.origType+"."+d.namespace:d.origType,d.selector,d.handler),this;if("object"==typeof a){for(e in a)this.off(e,b,a[e]);return this}return b!==!1&&"function"!=typeof b||(c=b,b=void 0),c===!1&&(c=ua),this.each(function(){r.event.remove(this,a,c,b)})}});var xa=/<(?!area|br|col|embed|hr|img|input|link|meta|p
aram)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi,ya=/<script|<style|<link/i,za=/checked\s*(?:[^=]|=\s*.checked.)/i,Aa=/^true\/(.*)/,Ba=/^\s*<!(?:\[CDATA\[|--)|(?:\]\]|--)>\s*$/g;function Ca(a,b){return r.nodeName(a,"table")&&r.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a:a}function Da(a){return a.type=(null!==a.getAttribute("type"))+"/"+a.type,a}function Ea(a){var b=Aa.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function Fa(a,b){var c,d,e,f,g,h,i,j;if(1===b.nodeType){if(V.hasData(a)&&(f=V.access(a),g=V.set(b,f),j=f.events)){delete g.handle,g.events={};for(e in j)for(c=0,d=j[e].length;c<d;c++)r.event.add(b,e,j[e][c])}W.hasData(a)&&(h=W.access(a),i=r.extend({},h),W.set(b,i))}}function Ga(a,b){var c=b.nodeName.toLowerCase();"input"===c&&ha.test(a.type)?b.checked=a.checked:"input"!==c&&"textarea"!==c||(b.defaultValue=a.defaultValue)}function Ha(a,b,c,d){b=g.apply([],b);var e,f,h,i,j,k,l=0,m=a.length,n=m-1,q=b[0],s=r.isFunction(q);if
(s||m>1&&"string"==typeof q&&!o.checkClone&&za.test(q))return a.each(function(e){var f=a.eq(e);s&&(b[0]=q.call(this,e,f.html())),Ha(f,b,c,d)});if(m&&(e=oa(b,a[0].ownerDocument,!1,a,d),f=e.firstChild,1===e.childNodes.length&&(e=f),f||d)){for(h=r.map(la(e,"script"),Da),i=h.length;l<m;l++)j=e,l!==n&&(j=r.clone(j,!0,!0),i&&r.merge(h,la(j,"script"))),c.call(a[l],j,l);if(i)for(k=h[h.length-1].ownerDocument,r.map(h,Ea),l=0;l<i;l++)j=h[l],ja.test(j.type||"")&&!V.access(j,"globalEval")&&r.contains(k,j)&&(j.src?r._evalUrl&&r._evalUrl(j.src):p(j.textContent.replace(Ba,""),k))}return a}function Ia(a,b,c){for(var d,e=b?r.filter(b,a):a,f=0;null!=(d=e[f]);f++)c||1!==d.nodeType||r.cleanData(la(d)),d.parentNode&&(c&&r.contains(d.ownerDocument,d)&&ma(la(d,"script")),d.parentNode.removeChild(d));return a}r.extend({htmlPrefilter:function(a){return a.replace(xa,"<$1></$2>")},clone:function(a,b,c){var d,e,f,g,h=a.cloneNode(!0),i=r.contains(a.ownerDocument,a);if(!(o.noCloneChecked||1!==a.nodeType&&11!==a.
nodeType||r.isXMLDoc(a)))for(g=la(h),f=la(a),d=0,e=f.length;d<e;d++)Ga(f[d],g[d]);if(b)if(c)for(f=f||la(a),g=g||la(h),d=0,e=f.length;d<e;d++)Fa(f[d],g[d]);else Fa(a,h);return g=la(h,"script"),g.length>0&&ma(g,!i&&la(a,"script")),h},cleanData:function(a){for(var b,c,d,e=r.event.special,f=0;void 0!==(c=a[f]);f++)if(T(c)){if(b=c[V.expando]){if(b.events)for(d in b.events)e[d]?r.event.remove(c,d):r.removeEvent(c,d,b.handle);c[V.expando]=void 0}c[W.expando]&&(c[W.expando]=void 0)}}}),r.fn.extend({detach:function(a){return Ia(this,a,!0)},remove:function(a){return Ia(this,a)},text:function(a){return S(this,function(a){return void 0===a?r.text(this):this.empty().each(function(){1!==this.nodeType&&11!==this.nodeType&&9!==this.nodeType||(this.textContent=a)})},null,a,arguments.length)},append:function(){return Ha(this,arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ca(this,a);b.appendChild(a)}})},prepend:function(){return Ha(this,arguments,function(a){i
f(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=Ca(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return Ha(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return Ha(this,arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},empty:function(){for(var a,b=0;null!=(a=this[b]);b++)1===a.nodeType&&(r.cleanData(la(a,!1)),a.textContent="");return this},clone:function(a,b){return a=null!=a&&a,b=null==b?a:b,this.map(function(){return r.clone(this,a,b)})},html:function(a){return S(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a&&1===b.nodeType)return b.innerHTML;if("string"==typeof a&&!ya.test(a)&&!ka[(ia.exec(a)||["",""])[1].toLowerCase()]){a=r.htmlPrefilter(a);try{for(;c<d;c++)b=this[c]||{},1===b.nodeType&&(r.cleanData(la(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=[];return Ha(
this,arguments,function(b){var c=this.parentNode;r.inArray(this,a)<0&&(r.cleanData(la(this)),c&&c.replaceChild(b,this))},a)}}),r.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){r.fn[a]=function(a){for(var c,d=[],e=r(a),f=e.length-1,g=0;g<=f;g++)c=g===f?this:this.clone(!0),r(e[g])[b](c),h.apply(d,c.get());return this.pushStack(d)}});var Ja=/^margin/,Ka=new RegExp("^("+$+")(?!px)[a-z%]+$","i"),La=function(b){var c=b.ownerDocument.defaultView;return c&&c.opener||(c=a),c.getComputedStyle(b)};!function(){function b(){if(i){i.style.cssText="box-sizing:border-box;position:relative;display:block;margin:auto;border:1px;padding:1px;top:1%;width:50%",i.innerHTML="",pa.appendChild(h);var b=a.getComputedStyle(i);c="1%"!==b.top,g="2px"===b.marginLeft,e="4px"===b.width,i.style.marginRight="50%",f="4px"===b.marginRight,pa.removeChild(h),i=null}}var c,e,f,g,h=d.createElement("div"),i=d.createElement("div");i.style&&(i.styl
e.backgroundClip="content-box",i.cloneNode(!0).style.backgroundClip="",o.clearCloneStyle="content-box"===i.style.backgroundClip,h.style.cssText="border:0;width:8px;height:0;top:0;left:-9999px;padding:0;margin-top:1px;position:absolute",h.appendChild(i),r.extend(o,{pixelPosition:function(){return b(),c},boxSizingReliable:function(){return b(),e},pixelMarginRight:function(){return b(),f},reliableMarginLeft:function(){return b(),g}}))}();function Ma(a,b,c){var d,e,f,g,h=a.style;return c=c||La(a),c&&(g=c.getPropertyValue(b)||c[b],""!==g||r.contains(a.ownerDocument,a)||(g=r.style(a,b)),!o.pixelMarginRight()&&Ka.test(g)&&Ja.test(b)&&(d=h.width,e=h.minWidth,f=h.maxWidth,h.minWidth=h.maxWidth=h.width=g,g=c.width,h.width=d,h.minWidth=e,h.maxWidth=f)),void 0!==g?g+"":g}function Na(a,b){return{get:function(){return a()?void delete this.get:(this.get=b).apply(this,arguments)}}}var Oa=/^(none|table(?!-c[ea]).+)/,Pa={position:"absolute",visibility:"hidden",display:"block"},Qa={letterSpacing:"0",f
ontWeight:"400"},Ra=["Webkit","Moz","ms"],Sa=d.createElement("div").style;function Ta(a){if(a in Sa)return a;var b=a[0].toUpperCase()+a.slice(1),c=Ra.length;while(c--)if(a=Ra[c]+b,a in Sa)return a}function Ua(a,b,c){var d=_.exec(b);return d?Math.max(0,d[2]-(c||0))+(d[3]||"px"):b}function Va(a,b,c,d,e){for(var f=c===(d?"border":"content")?4:"width"===b?1:0,g=0;f<4;f+=2)"margin"===c&&(g+=r.css(a,c+aa[f],!0,e)),d?("content"===c&&(g-=r.css(a,"padding"+aa[f],!0,e)),"margin"!==c&&(g-=r.css(a,"border"+aa[f]+"Width",!0,e))):(g+=r.css(a,"padding"+aa[f],!0,e),"padding"!==c&&(g+=r.css(a,"border"+aa[f]+"Width",!0,e)));return g}function Wa(a,b,c){var d,e=!0,f=La(a),g="border-box"===r.css(a,"boxSizing",!1,f);if(a.getClientRects().length&&(d=a.getBoundingClientRect()[b]),d<=0||null==d){if(d=Ma(a,b,f),(d<0||null==d)&&(d=a.style[b]),Ka.test(d))return d;e=g&&(o.boxSizingReliable()||d===a.style[b]),d=parseFloat(d)||0}return d+Va(a,b,c||(g?"border":"content"),e,f)+"px"}r.extend({cssHooks:{opacity:{get:
function(a,b){if(b){var c=Ma(a,"opacity");return""===c?"1":c}}}},cssNumber:{animationIterationCount:!0,columnCount:!0,fillOpacity:!0,flexGrow:!0,flexShrink:!0,fontWeight:!0,lineHeight:!0,opacity:!0,order:!0,orphans:!0,widows:!0,zIndex:!0,zoom:!0},cssProps:{"float":"cssFloat"},style:function(a,b,c,d){if(a&&3!==a.nodeType&&8!==a.nodeType&&a.style){var e,f,g,h=r.camelCase(b),i=a.style;return b=r.cssProps[h]||(r.cssProps[h]=Ta(h)||h),g=r.cssHooks[b]||r.cssHooks[h],void 0===c?g&&"get"in g&&void 0!==(e=g.get(a,!1,d))?e:i[b]:(f=typeof c,"string"===f&&(e=_.exec(c))&&e[1]&&(c=da(a,b,e),f="number"),null!=c&&c===c&&("number"===f&&(c+=e&&e[3]||(r.cssNumber[h]?"":"px")),o.clearCloneStyle||""!==c||0!==b.indexOf("background")||(i[b]="inherit"),g&&"set"in g&&void 0===(c=g.set(a,c,d))||(i[b]=c)),void 0)}},css:function(a,b,c,d){var e,f,g,h=r.camelCase(b);return b=r.cssProps[h]||(r.cssProps[h]=Ta(h)||h),g=r.cssHooks[b]||r.cssHooks[h],g&&"get"in g&&(e=g.get(a,!0,c)),void 0===e&&(e=Ma(a,b,d)),"normal"==
=e&&b in Qa&&(e=Qa[b]),""===c||c?(f=parseFloat(e),c===!0||isFinite(f)?f||0:e):e}}),r.each(["height","width"],function(a,b){r.cssHooks[b]={get:function(a,c,d){if(c)return!Oa.test(r.css(a,"display"))||a.getClientRects().length&&a.getBoundingClientRect().width?Wa(a,b,d):ca(a,Pa,function(){return Wa(a,b,d)})},set:function(a,c,d){var e,f=d&&La(a),g=d&&Va(a,b,d,"border-box"===r.css(a,"boxSizing",!1,f),f);return g&&(e=_.exec(c))&&"px"!==(e[3]||"px")&&(a.style[b]=c,c=r.css(a,b)),Ua(a,c,g)}}}),r.cssHooks.marginLeft=Na(o.reliableMarginLeft,function(a,b){if(b)return(parseFloat(Ma(a,"marginLeft"))||a.getBoundingClientRect().left-ca(a,{marginLeft:0},function(){return a.getBoundingClientRect().left}))+"px"}),r.each({margin:"",padding:"",border:"Width"},function(a,b){r.cssHooks[a+b]={expand:function(c){for(var d=0,e={},f="string"==typeof c?c.split(" "):[c];d<4;d++)e[a+aa[d]+b]=f[d]||f[d-2]||f[0];return e}},Ja.test(a)||(r.cssHooks[a+b].set=Ua)}),r.fn.extend({css:function(a,b){return S(this,function
(a,b,c){var d,e,f={},g=0;if(r.isArray(b)){for(d=La(a),e=b.length;g<e;g++)f[b[g]]=r.css(a,b[g],!1,d);return f}return void 0!==c?r.style(a,b,c):r.css(a,b)},a,b,arguments.length>1)}});function Xa(a,b,c,d,e){return new Xa.prototype.init(a,b,c,d,e)}r.Tween=Xa,Xa.prototype={constructor:Xa,init:function(a,b,c,d,e,f){this.elem=a,this.prop=c,this.easing=e||r.easing._default,this.options=b,this.start=this.now=this.cur(),this.end=d,this.unit=f||(r.cssNumber[c]?"":"px")},cur:function(){var a=Xa.propHooks[this.prop];return a&&a.get?a.get(this):Xa.propHooks._default.get(this)},run:function(a){var b,c=Xa.propHooks[this.prop];return this.options.duration?this.pos=b=r.easing[this.easing](a,this.options.duration*a,0,1,this.options.duration):this.pos=b=a,this.now=(this.end-this.start)*b+this.start,this.options.step&&this.options.step.call(this.elem,this.now,this),c&&c.set?c.set(this):Xa.propHooks._default.set(this),this}},Xa.prototype.init.prototype=Xa.prototype,Xa.propHooks={_default:{get:function(a)
{var b;return 1!==a.elem.nodeType||null!=a.elem[a.prop]&&null==a.elem.style[a.prop]?a.elem[a.prop]:(b=r.css(a.elem,a.prop,""),b&&"auto"!==b?b:0)},set:function(a){r.fx.step[a.prop]?r.fx.step[a.prop](a):1!==a.elem.nodeType||null==a.elem.style[r.cssProps[a.prop]]&&!r.cssHooks[a.prop]?a.elem[a.prop]=a.now:r.style(a.elem,a.prop,a.now+a.unit)}}},Xa.propHooks.scrollTop=Xa.propHooks.scrollLeft={set:function(a){a.elem.nodeType&&a.elem.parentNode&&(a.elem[a.prop]=a.now)}},r.easing={linear:function(a){return a},swing:function(a){return.5-Math.cos(a*Math.PI)/2},_default:"swing"},r.fx=Xa.prototype.init,r.fx.step={};var Ya,Za,$a=/^(?:toggle|show|hide)$/,_a=/queueHooks$/;function ab(){Za&&(a.requestAnimationFrame(ab),r.fx.tick())}function bb(){return a.setTimeout(function(){Ya=void 0}),Ya=r.now()}function cb(a,b){var c,d=0,e={height:a};for(b=b?1:0;d<4;d+=2-b)c=aa[d],e["margin"+c]=e["padding"+c]=a;return b&&(e.opacity=e.width=a),e}function db(a,b,c){for(var d,e=(gb.tweeners[b]||[]).concat(gb.tweene
rs["*"]),f=0,g=e.length;f<g;f++)if(d=e[f].call(c,b,a))return d}function eb(a,b,c){var d,e,f,g,h,i,j,k,l="width"in b||"height"in b,m=this,n={},o=a.style,p=a.nodeType&&ba(a),q=V.get(a,"fxshow");c.queue||(g=r._queueHooks(a,"fx"),null==g.unqueued&&(g.unqueued=0,h=g.empty.fire,g.empty.fire=function(){g.unqueued||h()}),g.unqueued++,m.always(function(){m.always(function(){g.unqueued--,r.queue(a,"fx").length||g.empty.fire()})}));for(d in b)if(e=b[d],$a.test(e)){if(delete b[d],f=f||"toggle"===e,e===(p?"hide":"show")){if("show"!==e||!q||void 0===q[d])continue;p=!0}n[d]=q&&q[d]||r.style(a,d)}if(i=!r.isEmptyObject(b),i||!r.isEmptyObject(n)){l&&1===a.nodeType&&(c.overflow=[o.overflow,o.overflowX,o.overflowY],j=q&&q.display,null==j&&(j=V.get(a,"display")),k=r.css(a,"display"),"none"===k&&(j?k=j:(ga([a],!0),j=a.style.display||j,k=r.css(a,"display"),ga([a]))),("inline"===k||"inline-block"===k&&null!=j)&&"none"===r.css(a,"float")&&(i||(m.done(function(){o.display=j}),null==j&&(k=o.display,j="none"==
=k?"":k)),o.display="inline-block")),c.overflow&&(o.overflow="hidden",m.always(function(){o.overflow=c.overflow[0],o.overflowX=c.overflow[1],o.overflowY=c.overflow[2]})),i=!1;for(d in n)i||(q?"hidden"in q&&(p=q.hidden):q=V.access(a,"fxshow",{display:j}),f&&(q.hidden=!p),p&&ga([a],!0),m.done(function(){p||ga([a]),V.remove(a,"fxshow");for(d in n)r.style(a,d,n[d])})),i=db(p?q[d]:0,d,m),d in q||(q[d]=i.start,p&&(i.end=i.start,i.start=0))}}function fb(a,b){var c,d,e,f,g;for(c in a)if(d=r.camelCase(c),e=b[d],f=a[c],r.isArray(f)&&(e=f[1],f=a[c]=f[0]),c!==d&&(a[d]=f,delete a[c]),g=r.cssHooks[d],g&&"expand"in g){f=g.expand(f),delete a[d];for(c in f)c in a||(a[c]=f[c],b[c]=e)}else b[d]=e}function gb(a,b,c){var d,e,f=0,g=gb.prefilters.length,h=r.Deferred().always(function(){delete i.elem}),i=function(){if(e)return!1;for(var b=Ya||bb(),c=Math.max(0,j.startTime+j.duration-b),d=c/j.duration||0,f=1-d,g=0,i=j.tweens.length;g<i;g++)j.tweens[g].run(f);return h.notifyWith(a,[j,f,c]),f<1&&i?c:(h.resolv
eWith(a,[j]),!1)},j=h.promise({elem:a,props:r.extend({},b),opts:r.extend(!0,{specialEasing:{},easing:r.easing._default},c),originalProperties:b,originalOptions:c,startTime:Ya||bb(),duration:c.duration,tweens:[],createTween:function(b,c){var d=r.Tween(a,j.opts,b,c,j.opts.specialEasing[b]||j.opts.easing);return j.tweens.push(d),d},stop:function(b){var c=0,d=b?j.tweens.length:0;if(e)return this;for(e=!0;c<d;c++)j.tweens[c].run(1);return b?(h.notifyWith(a,[j,1,0]),h.resolveWith(a,[j,b])):h.rejectWith(a,[j,b]),this}}),k=j.props;for(fb(k,j.opts.specialEasing);f<g;f++)if(d=gb.prefilters[f].call(j,a,k,j.opts))return r.isFunction(d.stop)&&(r._queueHooks(j.elem,j.opts.queue).stop=r.proxy(d.stop,d)),d;return r.map(k,db,j),r.isFunction(j.opts.start)&&j.opts.start.call(a,j),r.fx.timer(r.extend(i,{elem:a,anim:j,queue:j.opts.queue})),j.progress(j.opts.progress).done(j.opts.done,j.opts.complete).fail(j.opts.fail).always(j.opts.always)}r.Animation=r.extend(gb,{tweeners:{"*":[function(a,b){var c=this
.createTween(a,b);return da(c.elem,a,_.exec(b),c),c}]},tweener:function(a,b){r.isFunction(a)?(b=a,a=["*"]):a=a.match(K);for(var c,d=0,e=a.length;d<e;d++)c=a[d],gb.tweeners[c]=gb.tweeners[c]||[],gb.tweeners[c].unshift(b)},prefilters:[eb],prefilter:function(a,b){b?gb.prefilters.unshift(a):gb.prefilters.push(a)}}),r.speed=function(a,b,c){var e=a&&"object"==typeof a?r.extend({},a):{complete:c||!c&&b||r.isFunction(a)&&a,duration:a,easing:c&&b||b&&!r.isFunction(b)&&b};return r.fx.off||d.hidden?e.duration=0:e.duration="number"==typeof e.duration?e.duration:e.duration in r.fx.speeds?r.fx.speeds[e.duration]:r.fx.speeds._default,null!=e.queue&&e.queue!==!0||(e.queue="fx"),e.old=e.complete,e.complete=function(){r.isFunction(e.old)&&e.old.call(this),e.queue&&r.dequeue(this,e.queue)},e},r.fn.extend({fadeTo:function(a,b,c,d){return this.filter(ba).css("opacity",0).show().end().animate({opacity:b},a,c,d)},animate:function(a,b,c,d){var e=r.isEmptyObject(a),f=r.speed(b,c,d),g=function(){var b=gb(thi
s,r.extend({},a),f);(e||V.get(this,"finish"))&&b.stop(!0)};return g.finish=g,e||f.queue===!1?this.each(g):this.queue(f.queue,g)},stop:function(a,b,c){var d=function(a){var b=a.stop;delete a.stop,b(c)};return"string"!=typeof a&&(c=b,b=a,a=void 0),b&&a!==!1&&this.queue(a||"fx",[]),this.each(function(){var b=!0,e=null!=a&&a+"queueHooks",f=r.timers,g=V.get(this);if(e)g[e]&&g[e].stop&&d(g[e]);else for(e in g)g[e]&&g[e].stop&&_a.test(e)&&d(g[e]);for(e=f.length;e--;)f[e].elem!==this||null!=a&&f[e].queue!==a||(f[e].anim.stop(c),b=!1,f.splice(e,1));!b&&c||r.dequeue(this,a)})},finish:function(a){return a!==!1&&(a=a||"fx"),this.each(function(){var b,c=V.get(this),d=c[a+"queue"],e=c[a+"queueHooks"],f=r.timers,g=d?d.length:0;for(c.finish=!0,r.queue(this,a,[]),e&&e.stop&&e.stop.call(this,!0),b=f.length;b--;)f[b].elem===this&&f[b].queue===a&&(f[b].anim.stop(!0),f.splice(b,1));for(b=0;b<g;b++)d[b]&&d[b].finish&&d[b].finish.call(this);delete c.finish})}}),r.each(["toggle","show","hide"],function(a,b
){var c=r.fn[b];r.fn[b]=function(a,d,e){return null==a||"boolean"==typeof a?c.apply(this,arguments):this.animate(cb(b,!0),a,d,e)}}),r.each({slideDown:cb("show"),slideUp:cb("hide"),slideToggle:cb("toggle"),fadeIn:{opacity:"show"},fadeOut:{opacity:"hide"},fadeToggle:{opacity:"toggle"}},function(a,b){r.fn[a]=function(a,c,d){return this.animate(b,a,c,d)}}),r.timers=[],r.fx.tick=function(){var a,b=0,c=r.timers;for(Ya=r.now();b<c.length;b++)a=c[b],a()||c[b]!==a||c.splice(b--,1);c.length||r.fx.stop(),Ya=void 0},r.fx.timer=function(a){r.timers.push(a),a()?r.fx.start():r.timers.pop()},r.fx.interval=13,r.fx.start=function(){Za||(Za=a.requestAnimationFrame?a.requestAnimationFrame(ab):a.setInterval(r.fx.tick,r.fx.interval))},r.fx.stop=function(){a.cancelAnimationFrame?a.cancelAnimationFrame(Za):a.clearInterval(Za),Za=null},r.fx.speeds={slow:600,fast:200,_default:400},r.fn.delay=function(b,c){return b=r.fx?r.fx.speeds[b]||b:b,c=c||"fx",this.queue(c,function(c,d){var e=a.setTimeout(c,b);d.stop=fu
nction(){a.clearTimeout(e)}})},function(){var a=d.createElement("input"),b=d.createElement("select"),c=b.appendChild(d.createElement("option"));a.type="checkbox",o.checkOn=""!==a.value,o.optSelected=c.selected,a=d.createElement("input"),a.value="t",a.type="radio",o.radioValue="t"===a.value}();var hb,ib=r.expr.attrHandle;r.fn.extend({attr:function(a,b){return S(this,r.attr,a,b,arguments.length>1)},removeAttr:function(a){return this.each(function(){r.removeAttr(this,a)})}}),r.extend({attr:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return"undefined"==typeof a.getAttribute?r.prop(a,b,c):(1===f&&r.isXMLDoc(a)||(e=r.attrHooks[b.toLowerCase()]||(r.expr.match.bool.test(b)?hb:void 0)),void 0!==c?null===c?void r.removeAttr(a,b):e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:(a.setAttribute(b,c+""),c):e&&"get"in e&&null!==(d=e.get(a,b))?d:(d=r.find.attr(a,b),null==d?void 0:d))},attrHooks:{type:{set:function(a,b){if(!o.radioValue&&"radio"===b&&r.nodeName(a,"input")){var c=a.value;re
turn a.setAttribute("type",b),c&&(a.value=c),b}}}},removeAttr:function(a,b){var c,d=0,e=b&&b.match(K);
-if(e&&1===a.nodeType)while(c=e[d++])a.removeAttribute(c)}}),hb={set:function(a,b,c){return b===!1?r.removeAttr(a,c):a.setAttribute(c,c),c}},r.each(r.expr.match.bool.source.match(/\w+/g),function(a,b){var c=ib[b]||r.find.attr;ib[b]=function(a,b,d){var e,f,g=b.toLowerCase();return d||(f=ib[g],ib[g]=e,e=null!=c(a,b,d)?g:null,ib[g]=f),e}});var jb=/^(?:input|select|textarea|button)$/i,kb=/^(?:a|area)$/i;r.fn.extend({prop:function(a,b){return S(this,r.prop,a,b,arguments.length>1)},removeProp:function(a){return this.each(function(){delete this[r.propFix[a]||a]})}}),r.extend({prop:function(a,b,c){var d,e,f=a.nodeType;if(3!==f&&8!==f&&2!==f)return 1===f&&r.isXMLDoc(a)||(b=r.propFix[b]||b,e=r.propHooks[b]),void 0!==c?e&&"set"in e&&void 0!==(d=e.set(a,c,b))?d:a[b]=c:e&&"get"in e&&null!==(d=e.get(a,b))?d:a[b]},propHooks:{tabIndex:{get:function(a){var b=r.find.attr(a,"tabindex");return b?parseInt(b,10):jb.test(a.nodeName)||kb.test(a.nodeName)&&a.href?0:-1}}},propFix:{"for":"htmlFor","class":"cla
ssName"}}),o.optSelected||(r.propHooks.selected={get:function(a){var b=a.parentNode;return b&&b.parentNode&&b.parentNode.selectedIndex,null},set:function(a){var b=a.parentNode;b&&(b.selectedIndex,b.parentNode&&b.parentNode.selectedIndex)}}),r.each(["tabIndex","readOnly","maxLength","cellSpacing","cellPadding","rowSpan","colSpan","useMap","frameBorder","contentEditable"],function(){r.propFix[this.toLowerCase()]=this});var lb=/[\t\r\n\f]/g;function mb(a){return a.getAttribute&&a.getAttribute("class")||""}r.fn.extend({addClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).addClass(a.call(this,b,mb(this)))});if("string"==typeof a&&a){b=a.match(K)||[];while(c=this[i++])if(e=mb(c),d=1===c.nodeType&&(" "+e+" ").replace(lb," ")){g=0;while(f=b[g++])d.indexOf(" "+f+" ")<0&&(d+=f+" ");h=r.trim(d),e!==h&&c.setAttribute("class",h)}}return this},removeClass:function(a){var b,c,d,e,f,g,h,i=0;if(r.isFunction(a))return this.each(function(b){r(this).removeC
lass(a.call(this,b,mb(this)))});if(!arguments.length)return this.attr("class","");if("string"==typeof a&&a){b=a.match(K)||[];while(c=this[i++])if(e=mb(c),d=1===c.nodeType&&(" "+e+" ").replace(lb," ")){g=0;while(f=b[g++])while(d.indexOf(" "+f+" ")>-1)d=d.replace(" "+f+" "," ");h=r.trim(d),e!==h&&c.setAttribute("class",h)}}return this},toggleClass:function(a,b){var c=typeof a;return"boolean"==typeof b&&"string"===c?b?this.addClass(a):this.removeClass(a):r.isFunction(a)?this.each(function(c){r(this).toggleClass(a.call(this,c,mb(this),b),b)}):this.each(function(){var b,d,e,f;if("string"===c){d=0,e=r(this),f=a.match(K)||[];while(b=f[d++])e.hasClass(b)?e.removeClass(b):e.addClass(b)}else void 0!==a&&"boolean"!==c||(b=mb(this),b&&V.set(this,"__className__",b),this.setAttribute&&this.setAttribute("class",b||a===!1?"":V.get(this,"__className__")||""))})},hasClass:function(a){var b,c,d=0;b=" "+a+" ";while(c=this[d++])if(1===c.nodeType&&(" "+mb(c)+" ").replace(lb," ").indexOf(b)>-1)return!0;re
turn!1}});var nb=/\r/g,ob=/[\x20\t\r\n\f]+/g;r.fn.extend({val:function(a){var b,c,d,e=this[0];{if(arguments.length)return d=r.isFunction(a),this.each(function(c){var e;1===this.nodeType&&(e=d?a.call(this,c,r(this).val()):a,null==e?e="":"number"==typeof e?e+="":r.isArray(e)&&(e=r.map(e,function(a){return null==a?"":a+""})),b=r.valHooks[this.type]||r.valHooks[this.nodeName.toLowerCase()],b&&"set"in b&&void 0!==b.set(this,e,"value")||(this.value=e))});if(e)return b=r.valHooks[e.type]||r.valHooks[e.nodeName.toLowerCase()],b&&"get"in b&&void 0!==(c=b.get(e,"value"))?c:(c=e.value,"string"==typeof c?c.replace(nb,""):null==c?"":c)}}}),r.extend({valHooks:{option:{get:function(a){var b=r.find.attr(a,"value");return null!=b?b:r.trim(r.text(a)).replace(ob," ")}},select:{get:function(a){for(var b,c,d=a.options,e=a.selectedIndex,f="select-one"===a.type,g=f?null:[],h=f?e+1:d.length,i=e<0?h:f?e:0;i<h;i++)if(c=d[i],(c.selected||i===e)&&!c.disabled&&(!c.parentNode.disabled||!r.nodeName(c.parentNode,"
optgroup"))){if(b=r(c).val(),f)return b;g.push(b)}return g},set:function(a,b){var c,d,e=a.options,f=r.makeArray(b),g=e.length;while(g--)d=e[g],(d.selected=r.inArray(r.valHooks.option.get(d),f)>-1)&&(c=!0);return c||(a.selectedIndex=-1),f}}}}),r.each(["radio","checkbox"],function(){r.valHooks[this]={set:function(a,b){if(r.isArray(b))return a.checked=r.inArray(r(a).val(),b)>-1}},o.checkOn||(r.valHooks[this].get=function(a){return null===a.getAttribute("value")?"on":a.value})});var pb=/^(?:focusinfocus|focusoutblur)$/;r.extend(r.event,{trigger:function(b,c,e,f){var g,h,i,j,k,m,n,o=[e||d],p=l.call(b,"type")?b.type:b,q=l.call(b,"namespace")?b.namespace.split("."):[];if(h=i=e=e||d,3!==e.nodeType&&8!==e.nodeType&&!pb.test(p+r.event.triggered)&&(p.indexOf(".")>-1&&(q=p.split("."),p=q.shift(),q.sort()),k=p.indexOf(":")<0&&"on"+p,b=b[r.expando]?b:new r.Event(p,"object"==typeof b&&b),b.isTrigger=f?2:3,b.namespace=q.join("."),b.rnamespace=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")
+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=e),c=null==c?[b]:r.makeArray(c,[b]),n=r.event.special[p]||{},f||!n.trigger||n.trigger.apply(e,c)!==!1)){if(!f&&!n.noBubble&&!r.isWindow(e)){for(j=n.delegateType||p,pb.test(j+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),i=h;i===(e.ownerDocument||d)&&o.push(i.defaultView||i.parentWindow||a)}g=0;while((h=o[g++])&&!b.isPropagationStopped())b.type=g>1?j:n.bindType||p,m=(V.get(h,"events")||{})[b.type]&&V.get(h,"handle"),m&&m.apply(h,c),m=k&&h[k],m&&m.apply&&T(h)&&(b.result=m.apply(h,c),b.result===!1&&b.preventDefault());return b.type=p,f||b.isDefaultPrevented()||n._default&&n._default.apply(o.pop(),c)!==!1||!T(e)||k&&r.isFunction(e[p])&&!r.isWindow(e)&&(i=e[k],i&&(e[k]=null),r.event.triggered=p,e[p](),r.event.triggered=void 0,i&&(e[k]=i)),b.result}},simulate:function(a,b,c){var d=r.extend(new r.Event,c,{type:a,isSimulated:!0});r.event.trigger(d,null,b)}}),r.fn.extend({trigger:function(a,b){return this.each(function(){r.event.trigger(
a,b,this)})},triggerHandler:function(a,b){var c=this[0];if(c)return r.event.trigger(a,b,c,!0)}}),r.each("blur focus focusin focusout resize scroll click dblclick mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave change select submit keydown keypress keyup contextmenu".split(" "),function(a,b){r.fn[b]=function(a,c){return arguments.length>0?this.on(b,null,a,c):this.trigger(b)}}),r.fn.extend({hover:function(a,b){return this.mouseenter(a).mouseleave(b||a)}}),o.focusin="onfocusin"in a,o.focusin||r.each({focus:"focusin",blur:"focusout"},function(a,b){var c=function(a){r.event.simulate(b,a.target,r.event.fix(a))};r.event.special[b]={setup:function(){var d=this.ownerDocument||this,e=V.access(d,b);e||d.addEventListener(a,c,!0),V.access(d,b,(e||0)+1)},teardown:function(){var d=this.ownerDocument||this,e=V.access(d,b)-1;e?V.access(d,b,e):(d.removeEventListener(a,c,!0),V.remove(d,b))}}});var qb=a.location,rb=r.now(),sb=/\?/;r.parseXML=function(b){var c;if(!b||"string"!=typeo
f b)return null;try{c=(new a.DOMParser).parseFromString(b,"text/xml")}catch(d){c=void 0}return c&&!c.getElementsByTagName("parsererror").length||r.error("Invalid XML: "+b),c};var tb=/\[\]$/,ub=/\r?\n/g,vb=/^(?:submit|button|image|reset|file)$/i,wb=/^(?:input|select|textarea|keygen)/i;function xb(a,b,c,d){var e;if(r.isArray(b))r.each(b,function(b,e){c||tb.test(a)?d(a,e):xb(a+"["+("object"==typeof e&&null!=e?b:"")+"]",e,c,d)});else if(c||"object"!==r.type(b))d(a,b);else for(e in b)xb(a+"["+e+"]",b[e],c,d)}r.param=function(a,b){var c,d=[],e=function(a,b){var c=r.isFunction(b)?b():b;d[d.length]=encodeURIComponent(a)+"="+encodeURIComponent(null==c?"":c)};if(r.isArray(a)||a.jquery&&!r.isPlainObject(a))r.each(a,function(){e(this.name,this.value)});else for(c in a)xb(c,a[c],b,e);return d.join("&")},r.fn.extend({serialize:function(){return r.param(this.serializeArray())},serializeArray:function(){return this.map(function(){var a=r.prop(this,"elements");return a?r.makeArray(a):this}).filter(f
unction(){var a=this.type;return this.name&&!r(this).is(":disabled")&&wb.test(this.nodeName)&&!vb.test(a)&&(this.checked||!ha.test(a))}).map(function(a,b){var c=r(this).val();return null==c?null:r.isArray(c)?r.map(c,function(a){return{name:b.name,value:a.replace(ub,"\r\n")}}):{name:b.name,value:c.replace(ub,"\r\n")}}).get()}});var yb=/%20/g,zb=/#.*$/,Ab=/([?&])_=[^&]*/,Bb=/^(.*?):[ \t]*([^\r\n]*)$/gm,Cb=/^(?:about|app|app-storage|.+-extension|file|res|widget):$/,Db=/^(?:GET|HEAD)$/,Eb=/^\/\//,Fb={},Gb={},Hb="*/".concat("*"),Ib=d.createElement("a");Ib.href=qb.href;function Jb(a){return function(b,c){"string"!=typeof b&&(c=b,b="*");var d,e=0,f=b.toLowerCase().match(K)||[];if(r.isFunction(c))while(d=f[e++])"+"===d[0]?(d=d.slice(1)||"*",(a[d]=a[d]||[]).unshift(c)):(a[d]=a[d]||[]).push(c)}}function Kb(a,b,c,d){var e={},f=a===Gb;function g(h){var i;return e[h]=!0,r.each(a[h]||[],function(a,h){var j=h(b,c,d);return"string"!=typeof j||f||e[j]?f?!(i=j):void 0:(b.dataTypes.unshift(j),g(j),!1)
}),i}return g(b.dataTypes[0])||!e["*"]&&g("*")}function Lb(a,b){var c,d,e=r.ajaxSettings.flatOptions||{};for(c in b)void 0!==b[c]&&((e[c]?a:d||(d={}))[c]=b[c]);return d&&r.extend(!0,a,d),a}function Mb(a,b,c){var d,e,f,g,h=a.contents,i=a.dataTypes;while("*"===i[0])i.shift(),void 0===d&&(d=a.mimeType||b.getResponseHeader("Content-Type"));if(d)for(e in h)if(h[e]&&h[e].test(d)){i.unshift(e);break}if(i[0]in c)f=i[0];else{for(e in c){if(!i[0]||a.converters[e+" "+i[0]]){f=e;break}g||(g=e)}f=f||g}if(f)return f!==i[0]&&i.unshift(f),c[f]}function Nb(a,b,c,d){var e,f,g,h,i,j={},k=a.dataTypes.slice();if(k[1])for(g in a.converters)j[g.toLowerCase()]=a.converters[g];f=k.shift();while(f)if(a.responseFields[f]&&(c[a.responseFields[f]]=b),!i&&d&&a.dataFilter&&(b=a.dataFilter(b,a.dataType)),i=f,f=k.shift())if("*"===f)f=i;else if("*"!==i&&i!==f){if(g=j[i+" "+f]||j["* "+f],!g)for(e in j)if(h=e.split(" "),h[1]===f&&(g=j[i+" "+h[0]]||j["* "+h[0]])){g===!0?g=j[e]:j[e]!==!0&&(f=h[0],k.unshift(h[1]));break}
if(g!==!0)if(g&&a["throws"])b=g(b);else try{b=g(b)}catch(l){return{state:"parsererror",error:g?l:"No conversion from "+i+" to "+f}}}return{state:"success",data:b}}r.extend({active:0,lastModified:{},etag:{},ajaxSettings:{url:qb.href,type:"GET",isLocal:Cb.test(qb.protocol),global:!0,processData:!0,async:!0,contentType:"application/x-www-form-urlencoded; charset=UTF-8",accepts:{"*":Hb,text:"text/plain",html:"text/html",xml:"application/xml, text/xml",json:"application/json, text/javascript"},contents:{xml:/\bxml\b/,html:/\bhtml/,json:/\bjson\b/},responseFields:{xml:"responseXML",text:"responseText",json:"responseJSON"},converters:{"* text":String,"text html":!0,"text json":JSON.parse,"text xml":r.parseXML},flatOptions:{url:!0,context:!0}},ajaxSetup:function(a,b){return b?Lb(Lb(a,r.ajaxSettings),b):Lb(r.ajaxSettings,a)},ajaxPrefilter:Jb(Fb),ajaxTransport:Jb(Gb),ajax:function(b,c){"object"==typeof b&&(c=b,b=void 0),c=c||{};var e,f,g,h,i,j,k,l,m,n,o=r.ajaxSetup({},c),p=o.context||o,q=o.co
ntext&&(p.nodeType||p.jquery)?r(p):r.event,s=r.Deferred(),t=r.Callbacks("once memory"),u=o.statusCode||{},v={},w={},x="canceled",y={readyState:0,getResponseHeader:function(a){var b;if(k){if(!h){h={};while(b=Bb.exec(g))h[b[1].toLowerCase()]=b[2]}b=h[a.toLowerCase()]}return null==b?null:b},getAllResponseHeaders:function(){return k?g:null},setRequestHeader:function(a,b){return null==k&&(a=w[a.toLowerCase()]=w[a.toLowerCase()]||a,v[a]=b),this},overrideMimeType:function(a){return null==k&&(o.mimeType=a),this},statusCode:function(a){var b;if(a)if(k)y.always(a[y.status]);else for(b in a)u[b]=[u[b],a[b]];return this},abort:function(a){var b=a||x;return e&&e.abort(b),A(0,b),this}};if(s.promise(y),o.url=((b||o.url||qb.href)+"").replace(Eb,qb.protocol+"//"),o.type=c.method||c.type||o.method||o.type,o.dataTypes=(o.dataType||"*").toLowerCase().match(K)||[""],null==o.crossDomain){j=d.createElement("a");try{j.href=o.url,j.href=j.href,o.crossDomain=Ib.protocol+"//"+Ib.host!=j.protocol+"//"+j.host}c
atch(z){o.crossDomain=!0}}if(o.data&&o.processData&&"string"!=typeof o.data&&(o.data=r.param(o.data,o.traditional)),Kb(Fb,o,c,y),k)return y;l=r.event&&o.global,l&&0===r.active++&&r.event.trigger("ajaxStart"),o.type=o.type.toUpperCase(),o.hasContent=!Db.test(o.type),f=o.url.replace(zb,""),o.hasContent?o.data&&o.processData&&0===(o.contentType||"").indexOf("application/x-www-form-urlencoded")&&(o.data=o.data.replace(yb,"+")):(n=o.url.slice(f.length),o.data&&(f+=(sb.test(f)?"&":"?")+o.data,delete o.data),o.cache===!1&&(f=f.replace(Ab,""),n=(sb.test(f)?"&":"?")+"_="+rb++ +n),o.url=f+n),o.ifModified&&(r.lastModified[f]&&y.setRequestHeader("If-Modified-Since",r.lastModified[f]),r.etag[f]&&y.setRequestHeader("If-None-Match",r.etag[f])),(o.data&&o.hasContent&&o.contentType!==!1||c.contentType)&&y.setRequestHeader("Content-Type",o.contentType),y.setRequestHeader("Accept",o.dataTypes[0]&&o.accepts[o.dataTypes[0]]?o.accepts[o.dataTypes[0]]+("*"!==o.dataTypes[0]?", "+Hb+"; q=0.01":""):o.accepts
["*"]);for(m in o.headers)y.setRequestHeader(m,o.headers[m]);if(o.beforeSend&&(o.beforeSend.call(p,y,o)===!1||k))return y.abort();if(x="abort",t.add(o.complete),y.done(o.success),y.fail(o.error),e=Kb(Gb,o,c,y)){if(y.readyState=1,l&&q.trigger("ajaxSend",[y,o]),k)return y;o.async&&o.timeout>0&&(i=a.setTimeout(function(){y.abort("timeout")},o.timeout));try{k=!1,e.send(v,A)}catch(z){if(k)throw z;A(-1,z)}}else A(-1,"No Transport");function A(b,c,d,h){var j,m,n,v,w,x=c;k||(k=!0,i&&a.clearTimeout(i),e=void 0,g=h||"",y.readyState=b>0?4:0,j=b>=200&&b<300||304===b,d&&(v=Mb(o,y,d)),v=Nb(o,v,y,j),j?(o.ifModified&&(w=y.getResponseHeader("Last-Modified"),w&&(r.lastModified[f]=w),w=y.getResponseHeader("etag"),w&&(r.etag[f]=w)),204===b||"HEAD"===o.type?x="nocontent":304===b?x="notmodified":(x=v.state,m=v.data,n=v.error,j=!n)):(n=x,!b&&x||(x="error",b<0&&(b=0))),y.status=b,y.statusText=(c||x)+"",j?s.resolveWith(p,[m,x,y]):s.rejectWith(p,[y,x,n]),y.statusCode(u),u=void 0,l&&q.trigger(j?"ajaxSuccess":
"ajaxError",[y,o,j?m:n]),t.fireWith(p,[y,x]),l&&(q.trigger("ajaxComplete",[y,o]),--r.active||r.event.trigger("ajaxStop")))}return y},getJSON:function(a,b,c){return r.get(a,b,c,"json")},getScript:function(a,b){return r.get(a,void 0,b,"script")}}),r.each(["get","post"],function(a,b){r[b]=function(a,c,d,e){return r.isFunction(c)&&(e=e||d,d=c,c=void 0),r.ajax(r.extend({url:a,type:b,dataType:e,data:c,success:d},r.isPlainObject(a)&&a))}}),r._evalUrl=function(a){return r.ajax({url:a,type:"GET",dataType:"script",cache:!0,async:!1,global:!1,"throws":!0})},r.fn.extend({wrapAll:function(a){var b;return this[0]&&(r.isFunction(a)&&(a=a.call(this[0])),b=r(a,this[0].ownerDocument).eq(0).clone(!0),this[0].parentNode&&b.insertBefore(this[0]),b.map(function(){var a=this;while(a.firstElementChild)a=a.firstElementChild;return a}).append(this)),this},wrapInner:function(a){return r.isFunction(a)?this.each(function(b){r(this).wrapInner(a.call(this,b))}):this.each(function(){var b=r(this),c=b.contents();c.
length?c.wrapAll(a):b.append(a)})},wrap:function(a){var b=r.isFunction(a);return this.each(function(c){r(this).wrapAll(b?a.call(this,c):a)})},unwrap:function(a){return this.parent(a).not("body").each(function(){r(this).replaceWith(this.childNodes)}),this}}),r.expr.pseudos.hidden=function(a){return!r.expr.pseudos.visible(a)},r.expr.pseudos.visible=function(a){return!!(a.offsetWidth||a.offsetHeight||a.getClientRects().length)},r.ajaxSettings.xhr=function(){try{return new a.XMLHttpRequest}catch(b){}};var Ob={0:200,1223:204},Pb=r.ajaxSettings.xhr();o.cors=!!Pb&&"withCredentials"in Pb,o.ajax=Pb=!!Pb,r.ajaxTransport(function(b){var c,d;if(o.cors||Pb&&!b.crossDomain)return{send:function(e,f){var g,h=b.xhr();if(h.open(b.type,b.url,b.async,b.username,b.password),b.xhrFields)for(g in b.xhrFields)h[g]=b.xhrFields[g];b.mimeType&&h.overrideMimeType&&h.overrideMimeType(b.mimeType),b.crossDomain||e["X-Requested-With"]||(e["X-Requested-With"]="XMLHttpRequest");for(g in e)h.setRequestHeader(g,e[g]);
c=function(a){return function(){c&&(c=d=h.onload=h.onerror=h.onabort=h.onreadystatechange=null,"abort"===a?h.abort():"error"===a?"number"!=typeof h.status?f(0,"error"):f(h.status,h.statusText):f(Ob[h.status]||h.status,h.statusText,"text"!==(h.responseType||"text")||"string"!=typeof h.responseText?{binary:h.response}:{text:h.responseText},h.getAllResponseHeaders()))}},h.onload=c(),d=h.onerror=c("error"),void 0!==h.onabort?h.onabort=d:h.onreadystatechange=function(){4===h.readyState&&a.setTimeout(function(){c&&d()})},c=c("abort");try{h.send(b.hasContent&&b.data||null)}catch(i){if(c)throw i}},abort:function(){c&&c()}}}),r.ajaxPrefilter(function(a){a.crossDomain&&(a.contents.script=!1)}),r.ajaxSetup({accepts:{script:"text/javascript, application/javascript, application/ecmascript, application/x-ecmascript"},contents:{script:/\b(?:java|ecma)script\b/},converters:{"text script":function(a){return r.globalEval(a),a}}}),r.ajaxPrefilter("script",function(a){void 0===a.cache&&(a.cache=!1),a.c
rossDomain&&(a.type="GET")}),r.ajaxTransport("script",function(a){if(a.crossDomain){var b,c;return{send:function(e,f){b=r("<script>").prop({charset:a.scriptCharset,src:a.url}).on("load error",c=function(a){b.remove(),c=null,a&&f("error"===a.type?404:200,a.type)}),d.head.appendChild(b[0])},abort:function(){c&&c()}}}});var Qb=[],Rb=/(=)\?(?=&|$)|\?\?/;r.ajaxSetup({jsonp:"callback",jsonpCallback:function(){var a=Qb.pop()||r.expando+"_"+rb++;return this[a]=!0,a}}),r.ajaxPrefilter("json jsonp",function(b,c,d){var e,f,g,h=b.jsonp!==!1&&(Rb.test(b.url)?"url":"string"==typeof b.data&&0===(b.contentType||"").indexOf("application/x-www-form-urlencoded")&&Rb.test(b.data)&&"data");if(h||"jsonp"===b.dataTypes[0])return e=b.jsonpCallback=r.isFunction(b.jsonpCallback)?b.jsonpCallback():b.jsonpCallback,h?b[h]=b[h].replace(Rb,"$1"+e):b.jsonp!==!1&&(b.url+=(sb.test(b.url)?"&":"?")+b.jsonp+"="+e),b.converters["script json"]=function(){return g||r.error(e+" was not called"),g[0]},b.dataTypes[0]="json",
f=a[e],a[e]=function(){g=arguments},d.always(function(){void 0===f?r(a).removeProp(e):a[e]=f,b[e]&&(b.jsonpCallback=c.jsonpCallback,Qb.push(e)),g&&r.isFunction(f)&&f(g[0]),g=f=void 0}),"script"}),o.createHTMLDocument=function(){var a=d.implementation.createHTMLDocument("").body;return a.innerHTML="<form></form><form></form>",2===a.childNodes.length}(),r.parseHTML=function(a,b,c){if("string"!=typeof a)return[];"boolean"==typeof b&&(c=b,b=!1);var e,f,g;return b||(o.createHTMLDocument?(b=d.implementation.createHTMLDocument(""),e=b.createElement("base"),e.href=d.location.href,b.head.appendChild(e)):b=d),f=B.exec(a),g=!c&&[],f?[b.createElement(f[1])]:(f=oa([a],b,g),g&&g.length&&r(g).remove(),r.merge([],f.childNodes))},r.fn.load=function(a,b,c){var d,e,f,g=this,h=a.indexOf(" ");return h>-1&&(d=r.trim(a.slice(h)),a=a.slice(0,h)),r.isFunction(b)?(c=b,b=void 0):b&&"object"==typeof b&&(e="POST"),g.length>0&&r.ajax({url:a,type:e||"GET",dataType:"html",data:b}).done(function(a){f=arguments,g.ht
ml(d?r("<div>").append(r.parseHTML(a)).find(d):a)}).always(c&&function(a,b){g.each(function(){c.apply(this,f||[a.responseText,b,a])})}),this},r.each(["ajaxStart","ajaxStop","ajaxComplete","ajaxError","ajaxSuccess","ajaxSend"],function(a,b){r.fn[b]=function(a){return this.on(b,a)}}),r.expr.pseudos.animated=function(a){return r.grep(r.timers,function(b){return a===b.elem}).length};function Sb(a){return r.isWindow(a)?a:9===a.nodeType&&a.defaultView}r.offset={setOffset:function(a,b,c){var d,e,f,g,h,i,j,k=r.css(a,"position"),l=r(a),m={};"static"===k&&(a.style.position="relative"),h=l.offset(),f=r.css(a,"top"),i=r.css(a,"left"),j=("absolute"===k||"fixed"===k)&&(f+i).indexOf("auto")>-1,j?(d=l.position(),g=d.top,e=d.left):(g=parseFloat(f)||0,e=parseFloat(i)||0),r.isFunction(b)&&(b=b.call(a,c,r.extend({},h))),null!=b.top&&(m.top=b.top-h.top+g),null!=b.left&&(m.left=b.left-h.left+e),"using"in b?b.using.call(a,m):l.css(m)}},r.fn.extend({offset:function(a){if(arguments.length)return void 0===a?
this:this.each(function(b){r.offset.setOffset(this,a,b)});var b,c,d,e,f=this[0];if(f)return f.getClientRects().length?(d=f.getBoundingClientRect(),d.width||d.height?(e=f.ownerDocument,c=Sb(e),b=e.documentElement,{top:d.top+c.pageYOffset-b.clientTop,left:d.left+c.pageXOffset-b.clientLeft}):d):{top:0,left:0}},position:function(){if(this[0]){var a,b,c=this[0],d={top:0,left:0};return"fixed"===r.css(c,"position")?b=c.getBoundingClientRect():(a=this.offsetParent(),b=this.offset(),r.nodeName(a[0],"html")||(d=a.offset()),d={top:d.top+r.css(a[0],"borderTopWidth",!0),left:d.left+r.css(a[0],"borderLeftWidth",!0)}),{top:b.top-d.top-r.css(c,"marginTop",!0),left:b.left-d.left-r.css(c,"marginLeft",!0)}}},offsetParent:function(){return this.map(function(){var a=this.offsetParent;while(a&&"static"===r.css(a,"position"))a=a.offsetParent;return a||pa})}}),r.each({scrollLeft:"pageXOffset",scrollTop:"pageYOffset"},function(a,b){var c="pageYOffset"===b;r.fn[a]=function(d){return S(this,function(a,d,e){va
r f=Sb(a);return void 0===e?f?f[b]:a[d]:void(f?f.scrollTo(c?f.pageXOffset:e,c?e:f.pageYOffset):a[d]=e)},a,d,arguments.length)}}),r.each(["top","left"],function(a,b){r.cssHooks[b]=Na(o.pixelPosition,function(a,c){if(c)return c=Ma(a,b),Ka.test(c)?r(a).position()[b]+"px":c})}),r.each({Height:"height",Width:"width"},function(a,b){r.each({padding:"inner"+a,content:b,"":"outer"+a},function(c,d){r.fn[d]=function(e,f){var g=arguments.length&&(c||"boolean"!=typeof e),h=c||(e===!0||f===!0?"margin":"border");return S(this,function(b,c,e){var f;return r.isWindow(b)?0===d.indexOf("outer")?b["inner"+a]:b.document.documentElement["client"+a]:9===b.nodeType?(f=b.documentElement,Math.max(b.body["scroll"+a],f["scroll"+a],b.body["offset"+a],f["offset"+a],f["client"+a])):void 0===e?r.css(b,c,h):r.style(b,c,e,h)},b,g?e:void 0,g)}})}),r.fn.extend({bind:function(a,b,c){return this.on(a,null,b,c)},unbind:function(a,b){return this.off(a,null,b)},delegate:function(a,b,c,d){return this.on(b,a,c,d)},undelegate
:function(a,b,c){return 1===arguments.length?this.off(a,"**"):this.off(b,a||"**",c)}}),r.parseJSON=JSON.parse,"function"==typeof define&&define.amd&&define("jquery",[],function(){return r});var Tb=a.jQuery,Ub=a.$;return r.noConflict=function(b){return a.$===r&&(a.$=Ub),b&&a.jQuery===r&&(a.jQuery=Tb),r},b||(a.jQuery=a.$=r),r});
+/*! jQuery v1.11.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */
+!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.1",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,argumen
ts))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a=
=a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.r
<TRUNCATED>
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_static/minus.png
----------------------------------------------------------------------
diff --git a/docs/latest/_static/minus.png b/docs/latest/_static/minus.png
index d96755f..0f22b16 100644
Binary files a/docs/latest/_static/minus.png and b/docs/latest/_static/minus.png differ
[33/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/user.txt b/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
new file mode 100644
index 0000000..2ef5012
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/user.txt
@@ -0,0 +1,778 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-users:
+
+Users
+=====
+
+.. _to-api-v11-users-route:
+
+/api/1.1/users
+++++++++++++++
+
+**GET /api/1.1/users**
+
+ Retrieves all users.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ },
+ {
+ ... more users
+ },
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/users/:id**
+
+ Retrieves user by ID.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | User id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | hash | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``publicSshKey`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``registrationSent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``roleName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "addressLine1": "",
+ "addressLine2": "",
+ "city": "",
+ "company": "",
+ "country": "",
+ "email": "email1@email.com",
+ "fullName": "Tom Simpson",
+ "gid": "0",
+ "id": "53",
+ "lastUpdated": "2016-01-26 10:22:07",
+ "newUser": true,
+ "phoneNumber": "",
+ "postalCode": "",
+ "publicSshKey": "xxx",
+ "registrationSent": true,
+ "role": "6",
+ "rolename": "admin",
+ "stateOrProvince": "",
+ "uid": "0",
+ "username": "tsimpson"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.1/user/current**
+
+ Retrieves the profile for the authenticated user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``localUser`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "email": "email@email.com",
+ "city": "",
+ "id": "50",
+ "phoneNumber": "",
+ "company": "",
+ "country": "",
+ "fullName": "Tom Callahan",
+ "localUser": true,
+ "uid": "0",
+ "stateOrProvince": "",
+ "username": "tommyboy",
+ "newUser": false,
+ "addressLine2": "",
+ "role": "6",
+ "addressLine1": "",
+ "gid": "0",
+ "postalCode": ""
+ },
+ }
+
+|
+
+**POST /api/1.1/user/current/update**
+
+ Updates the date for the authenticated user.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phoneNumber`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``company`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``country`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``fullName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``localUser`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``uid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``stateOrProvince`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``newUser`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine2`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``role`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``addressLine1`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``gid`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``postalCode`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "user": {
+ "email": "",
+ "city": "",
+ "id": "",
+ "phoneNumber": "",
+ "company": "",
+ "country": "",
+ "fullName": "",
+ "localUser": true,
+ "uid": "0",
+ "stateOrProvince": "",
+ "username": "tommyboy",
+ "newUser": false,
+ "addressLine2": "",
+ "role": "6",
+ "addressLine1": "",
+ "gid": "0",
+ "postalCode": ""
+ }
+ }
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "UserProfile was successfully updated."
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/user/current/jobs.json**
+
+ Retrieves the user's list of jobs.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+========================================+
+ | ``keyword`` | no | PURGE |
+ +--------------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``keyword`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``objectName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``assetUrl`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``assetType`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``status`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``dsId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``dsXmlId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``username`` | boolean| |
+ +----------------------+--------+------------------------------------------------+
+ |``parameters`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``enteredTime`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``objectType`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``agent`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``startTime`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example**
+ ::
+
+ {
+ "response": [
+ {
+ "id": "1",
+ "keyword": "PURGE",
+ "objectName": null,
+ "assetUrl": "",
+ "assetType": "file",
+ "status": "PENDING",
+ "dsId": "9999",
+ "dsXmlId": "ds-xml-id",
+ "username": "peewee",
+ "parameters": "TTL:56h",
+ "enteredTime": "2015-01-21 18:00:16",
+ "objectType": null,
+ "agent": "",
+ "startTime": "2015-01-21 10:45:38"
+ }
+ ],
+ }
+
+
+|
+
+**POST/api/1.1/user/current/jobs**
+
+Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
+
+.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
+
+Authentication Required: Yes
+
+Role(s) Required: Yes
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``dsId`` | string | Unique Delivery Service ID |
+ +----------------------+--------+------------------------------------------------+
+ |``regex`` | string | Path Regex this should be a |
+ | | | `PCRE <http://www.pcre.org/>`_ compatible |
+ | | | regular expression for the path to match for |
+ | | | forcing the revalidation. Be careful to only |
+ | | | match on the content you need to remove - |
+ | | | revalidation is an expensive operation for |
+ | | | many origins, and a simple ``/.*`` can cause |
+ | | | an overload condition of the origin. |
+ +----------------------+--------+------------------------------------------------+
+ |``startTime`` | string | Start Time is the time when the revalidation |
+ | | | rule will be made active. Populate |
+ | | | with the current time to schedule ASAP. |
+ +----------------------+--------+------------------------------------------------+
+ |``ttl`` | int | Time To Live is how long the revalidation rule |
+ | | | will be active for in hours. It usually makes |
+ | | | sense to make this the same as the |
+ | | | ``Cache-Control`` header from the origin which |
+ | | | sets the object time to live in cache |
+ | | | (by ``max-age`` or ``Expires``). Entering a |
+ | | | longer TTL here will make the caches do |
+ | | | unnecessary work. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "dsId": "9999",
+ "regex": "/path/to/content.jpg",
+ "startTime": "2015-01-27 11:08:37",
+ "ttl": 54
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Successfully created purge job for: ."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/user/login**
+
+ Authentication of a user using username and password. Traffic Ops will send back a session cookie.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``u`` | string | username |
+ +----------------------+--------+------------------------------------------------+
+ |``p`` | string | password |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "u": "username",
+ "p": "password"
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Successfully logged in."
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.1/user/:id/deliveryservices/available.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``xmlId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "xmlId": "ns-img",
+ "id": "90"
+ },
+ {
+ "xmlId": "ns-img-secure",
+ "id": "280"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.1/user/login/token**
+
+ Authentication of a user using a token.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``t`` | string | token-value |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "t": "token-value"
+ }
+
+|
+
+ **Response Properties**
+
+ +-------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=============+========+=============+
+ | ``alerts`` | array | |
+ +-------------+--------+-------------+
+ | ``>level`` | string | |
+ +-------------+--------+-------------+
+ | ``>text`` | string | |
+ +-------------+--------+-------------+
+ | ``version`` | string | |
+ +-------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "error",
+ "text": "Unauthorized, please log in."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.1/user/logout**
+
+ User logout. Invalidates the session cookie.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``alerts`` | array | |
+ +----------------------+--------+------------------------------------------------+
+ |* ``level`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |* ``text`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example**
+
+ ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "You are logged out."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/user/reset_password**
+
+ Reset user password.
+
+ Authentication Required: No
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``email`` | string | The email address of the user to initiate |
+ | | | password reset. |
+ +----------------------+--------+------------------------------------------------+
+
+ **Request Example**
+ ::
+
+ {
+ "email": "email@email.com"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``alerts`` | array | A collection of alert messages. |
+ +----------------------+--------+------------------------------------------------+
+ |* ``level`` | string | Success, info, warning or error. |
+ +----------------------+--------+------------------------------------------------+
+ |* ``text`` | string | Alert message. |
+ +----------------------+--------+------------------------------------------------+
+ |``version`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Successfully sent password reset to email 'email@email.com'"
+ }
+ ],
+ }
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/asn.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/asn.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/asn.rst.txt
deleted file mode 100644
index d3ae765..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/asn.rst.txt
+++ /dev/null
@@ -1,192 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v12-asn:
-
-ASN
-===
-
-.. _to-api-v12-asns-route:
-
-/api/1.2/asns
-+++++++++++++
-
-**GET /api/1.2/asns**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+--------+-------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the ASN |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``cachegroup`` | string | Related cachegroup name |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``cachegroupId`` | string | Related cachegroup id |
- +------------------+--------+-------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "lastUpdated": "2012-09-17 21:41:22",
- "id": "27",
- "asn": "7015",
- "cachegroup": "us-ma-woburn",
- "cachegroupId": "27",
- },
- {
- "lastUpdated": "2012-09-17 21:41:22",
- "id": "28",
- "asn": "7016",
- "cachegroup": "us-pa-pittsburgh",
- "cachegroupId": "13"
- }
- ]
- }
-
-|
-
-**GET /api/1.2/asns/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | ASN id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +------------------+--------+-------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=========================================================================+
- | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``id`` | string | Local unique identifier for the ASN |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``cachegroup`` | string | Related cachegroup name |
- +------------------+--------+-------------------------------------------------------------------------+
- | ``cachegroupId`` | string | Related cachegroup id |
- +------------------+--------+-------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "lastUpdated": "2012-09-17 21:41:22",
- "id": "28",
- "asn": "7016",
- "cachegroup": "us-pa-pittsburgh",
- "cachegroupId": "13"
- }
- ]
- }
-
-|
-
-**PUT /api/1.2/asns/{:id}**
-
- Allows user to edit an ASN.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Type | Description |
- +===================+==========+================================================+
- | ``id`` | int | ASN id. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +-------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=================================================+
- | ``asn`` | string | ASN |
- +-------------------+--------+-------------------------------------------------+
- | ``cachegroupId`` | string | The cachegroup the ASN belongs to |
- +-------------------+--------+-------------------------------------------------+
-
-
- **Request Example** ::
-
- {
- "asn": "99",
- "cachegroupId": "177"
- }
-
- **Response Properties**
-
- +--------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+=================================================+
- | ``response`` | hash | The details of the update, if success. |
- +--------------------+--------+-------------------------------------------------+
- | ``>name`` | string | CDN name. |
- +--------------------+--------+-------------------------------------------------+
- | ``>id`` | int | CDN id. |
- +--------------------+--------+-------------------------------------------------+
- | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
- +--------------------+--------+-------------------------------------------------+
- | ``alerts`` | array | A collection of alert messages. |
- +--------------------+--------+-------------------------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +--------------------+--------+-------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +--------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response":{
- "lastUpdated": "2012-09-17 21:41:22",
- "id": "28",
- "asn": "99",
- "cachegroup": "us-pa-pittsburgh",
- "cachegroupId": "177"
- },
- "alerts":[
- {
- "level": "success",
- "text": "cdn was updated."
- }
- ]
- }
-
-|
-
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/asn.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/asn.txt b/docs/latest/_sources/development/traffic_ops_api/v12/asn.txt
new file mode 100644
index 0000000..d3ae765
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/asn.txt
@@ -0,0 +1,192 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v12-asn:
+
+ASN
+===
+
+.. _to-api-v12-asns-route:
+
+/api/1.2/asns
++++++++++++++
+
+**GET /api/1.2/asns**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the ASN |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | Related cachegroup id |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "27",
+ "asn": "7015",
+ "cachegroup": "us-ma-woburn",
+ "cachegroupId": "27",
+ },
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "7016",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "13"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/asns/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | ASN id. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================+
+ | ``lastUpdated`` | string | The Time / Date this server entry was last updated |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``id`` | string | Local unique identifier for the ASN |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``asn`` | string | Autonomous System Numbers per APNIC for identifying a service provider. |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroup`` | string | Related cachegroup name |
+ +------------------+--------+-------------------------------------------------------------------------+
+ | ``cachegroupId`` | string | Related cachegroup id |
+ +------------------+--------+-------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "7016",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "13"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/asns/{:id}**
+
+ Allows user to edit an ASN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | ASN id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================+========+=================================================+
+ | ``asn`` | string | ASN |
+ +-------------------+--------+-------------------------------------------------+
+ | ``cachegroupId`` | string | The cachegroup the ASN belongs to |
+ +-------------------+--------+-------------------------------------------------+
+
+
+ **Request Example** ::
+
+ {
+ "asn": "99",
+ "cachegroupId": "177"
+ }
+
+ **Response Properties**
+
+ +--------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+=================================================+
+ | ``response`` | hash | The details of the update, if success. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | CDN name. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>id`` | int | CDN id. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +--------------------+--------+-------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +--------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response":{
+ "lastUpdated": "2012-09-17 21:41:22",
+ "id": "28",
+ "asn": "99",
+ "cachegroup": "us-pa-pittsburgh",
+ "cachegroupId": "177"
+ },
+ "alerts":[
+ {
+ "level": "success",
+ "text": "cdn was updated."
+ }
+ ]
+ }
+
+|
+
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/cache_stats.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cache_stats.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cache_stats.rst.txt
deleted file mode 100644
index dffc9a4..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/cache_stats.rst.txt
+++ /dev/null
@@ -1,134 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v12-cache-stats:
-
-Cache Statistics
-===========================
-
-.. _to-api-v12-cache-stats-route:
-
-/api/1.2/cache_stats
-++++++++++++++++++++
-
-**GET /api/1.2/cache_stats.json**
-
- Retrieves statistics about the CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +==========================+==========+==============================================================================================================================================+
- | ``cdnName`` | yes | The CDN name to return cache stats for |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | ``metricType`` | yes | The metric type (valid metric types: 'ats.proxy.process.http.current_client_connections', 'bandwidth', 'maxKbps') |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | ``startDate`` | yes | The begin date (Formatted as ISO8601, for example: '2015-08-11T12:30:00-06:00') |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | ``endDate`` | yes | The end date (Formatted as ISO8601, for example: '2015-08-12T12:30:00-06:00') |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Properties**
-
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +============================+===============+=========================================================================================+
- |``summary`` | hash | Summary data |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>count`` | int | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>min`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>max`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>fifthPercentile`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>ninetyEighthPercentile`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>ninetyFifthPercentile`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>average`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``series`` | hash | Series data |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>count`` | int | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>columns`` | array | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>name`` | string | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>values`` | array | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>>time`` | string | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>>value`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "series": {
- "columns": [
- "time",
- ""
- ],
- "count": 29,
- "name": "bandwidth",
- "tags": {
- "cdn": "over-the-top"
- },
- "values": [
- [
- "2015-08-10T22:40:00Z",
- 229340299720
- ],
- [
- "2015-08-10T22:41:00Z",
- 224309221713.334
- ],
- [
- "2015-08-10T22:42:00Z",
- 229551834168.334
- ],
- [
- "2015-08-10T22:43:00Z",
- 225179658876.667
- ],
- [
- "2015-08-10T22:44:00Z",
- 230443968275
- ]
- ]
- },
- "summary": {
- "average": 970410.295,
- "count": 1376041798,
- "fifthPercentile": 202.03,
- "max": 3875441.02,
- "min": 0,
- "ninetyEighthPercentile": 2957940.93,
- "ninetyFifthPercentile": 2366728.63
- }
- }
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/cache_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cache_stats.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cache_stats.txt
new file mode 100644
index 0000000..dffc9a4
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/cache_stats.txt
@@ -0,0 +1,134 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v12-cache-stats:
+
+Cache Statistics
+===========================
+
+.. _to-api-v12-cache-stats-route:
+
+/api/1.2/cache_stats
+++++++++++++++++++++
+
+**GET /api/1.2/cache_stats.json**
+
+ Retrieves statistics about the CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+==============================================================================================================================================+
+ | ``cdnName`` | yes | The CDN name to return cache stats for |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``metricType`` | yes | The metric type (valid metric types: 'ats.proxy.process.http.current_client_connections', 'bandwidth', 'maxKbps') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``startDate`` | yes | The begin date (Formatted as ISO8601, for example: '2015-08-11T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``endDate`` | yes | The end date (Formatted as ISO8601, for example: '2015-08-12T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +============================+===============+=========================================================================================+
+ |``summary`` | hash | Summary data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>min`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>max`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>fifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyEighthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyFifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>average`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``series`` | hash | Series data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>columns`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>name`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>values`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>time`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>value`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "series": {
+ "columns": [
+ "time",
+ ""
+ ],
+ "count": 29,
+ "name": "bandwidth",
+ "tags": {
+ "cdn": "over-the-top"
+ },
+ "values": [
+ [
+ "2015-08-10T22:40:00Z",
+ 229340299720
+ ],
+ [
+ "2015-08-10T22:41:00Z",
+ 224309221713.334
+ ],
+ [
+ "2015-08-10T22:42:00Z",
+ 229551834168.334
+ ],
+ [
+ "2015-08-10T22:43:00Z",
+ 225179658876.667
+ ],
+ [
+ "2015-08-10T22:44:00Z",
+ 230443968275
+ ]
+ ]
+ },
+ "summary": {
+ "average": 970410.295,
+ "count": 1376041798,
+ "fifthPercentile": 202.03,
+ "max": 3875441.02,
+ "min": 0,
+ "ninetyEighthPercentile": 2957940.93,
+ "ninetyFifthPercentile": 2366728.63
+ }
+ }
+ }
+
+|
[32/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.rst.txt
deleted file mode 100644
index 2d9f08d..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.rst.txt
+++ /dev/null
@@ -1,696 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-cachegroup:
-
-Cache Group
-===========
-
-.. _to-api-v12-cachegroups-route:
-
-/api/1.2/cachegroups
-++++++++++++++++++++
-
-**GET /api/1.1/cachegroups**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +===================================+========+==========================================================================+
- | ``id`` | string | Local unique identifier for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``longitude`` | string | Longitude for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | Parent cachegroup ID. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupName`` | string | Parent cachegroup name. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``typeName`` | string | The name of the type of Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "21",
- "lastUpdated": "2012-09-25 20:27:28",
- "latitude": "0",
- "longitude": "0",
- "name": "dc-chicago",
- "parentCachegroupId": null,
- "parentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "secondaryParentCachegroupName": null,
- "shortName": "dcchi",
- "typeName": "MID_LOC",
- "typeId": "4"
- },
- {
- "id": "22",
- "lastUpdated": "2012-09-25 20:27:28",
- "latitude": "0",
- "longitude": "0",
- "name": "dc-chicago-1",
- "parentCachegroupId": null,
- "parentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "secondaryParentCachegroupName": null,
- "shortName": "dcchi",
- "typeName": "MID_LOC",
- "typeId": "4"
- }
- ],
- }
-
-|
-
-**GET /api/1.2/cachegroups/trimmed**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "dc-chicago"
- },
- {
- "name": "dc-cmc"
- }
- ],
- }
-
-|
-
-**GET /api/1.2/cachegroups/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +===================================+========+==========================================================================+
- | ``id`` | string | Local unique identifier for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``longitude`` | string | Longitude for the Cache Group |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | Parent cachegroup ID. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``parentCachegroupName`` | string | Parent cachegroup name. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
- | ``typeName`` | string | The name of the type of Cache Group entry |
- +-----------------------------------+--------+--------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "21",
- "lastUpdated": "2012-09-25 20:27:28",
- "latitude": "0",
- "longitude": "0",
- "name": "dc-chicago",
- "parentCachegroupId": null,
- "parentCachegroupName": null,
- "secondaryParentCachegroupId": null,
- "secondaryParentCachegroupName": null,
- "shortName": "dcchi",
- "typeName": "MID_LOC",
- "typeId": "4"
- }
- ],
- }
-
-|
-
-
-**GET /api/1.2/cachegroup/:parameter_id/parameter**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-------------+
- | Name | Required | Description |
- +==================+==========+=============+
- | ``parameter_id`` | yes | |
- +------------------+----------+-------------+
-
- **Response Properties**
-
- +-----------------+--------+-------------+
- | Parameter | Type | Description |
- +=================+========+=============+
- | ``cachegroups`` | array | |
- +-----------------+--------+-------------+
- | ``>name`` | string | |
- +-----------------+--------+-------------+
- | ``>id`` | string | |
- +-----------------+--------+-------------+
-
- **Response Example** ::
-
- {
- "response": {
- "cachegroups": [
- {
- "name": "dc-chicago",
- "id": "21"
- },
- {
- "name": "dc-cmc",
- "id": "22"
- }
- ]
- },
- }
-
-|
-
-**GET /api/1.2/cachegroupparameters**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +--------------------------+--------+-----------------------------------------+
- | Parameter | Type | Description |
- +==========================+========+=========================================+
- | ``cachegroupParameters`` | array | A collection of cache group parameters. |
- +--------------------------+--------+-----------------------------------------+
- | ``>parameter`` | string | |
- +--------------------------+--------+-----------------------------------------+
- | ``>lastUpdated`` | string | |
- +--------------------------+--------+-----------------------------------------+
- | ``>cachegroup`` | string | |
- +--------------------------+--------+-----------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "cachegroupParameters": [
- {
- "parameter": "379",
- "lastUpdated": "2013-08-05 18:49:37",
- "cachegroup": "us-ca-sanjose"
- },
- {
- "parameter": "380",
- "lastUpdated": "2013-08-05 18:49:37",
- "cachegroup": "us-ca-sanjose"
- },
- {
- "parameter": "379",
- "lastUpdated": "2013-08-05 18:49:37",
- "cachegroup": "us-ma-woburn"
- }
- ]
- },
- }
-
-|
-
-**GET /api/1.2/cachegroups/:parameter_id/parameter/available**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-------------+
- | Name | Required | Description |
- +==================+==========+=============+
- | ``parameter_id`` | yes | |
- +------------------+----------+-------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "dc-chicago",
- "id": "21"
- },
- {
- "name": "dc-cmc",
- "id": "22"
- }
- ],
- }
-
-|
-
-**POST /api/1.2/cachegroups**
-
- Create cache group.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Parameters**
-
- +---------------------------------+----------+-------------------------------------------------------------------+
- | Name | Required | Description |
- +=================================+==========+===================================================================+
- | ``name`` | yes | The name of the Cache Group entry |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``shortName`` | yes | Abbreviation of the Cache Group Name |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``latitude`` | no | Latitude for the Cache Group |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``longitude`` | no | Longitude for the Cache Group |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``parentCachegroup`` | no | Name of Parent Cache Group entry. |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``secondaryParentCachegroup`` | no | Name of Secondary Parent Cache Group entry. |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``typeName`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
- +---------------------------------+----------+-------------------------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name": "cache_group_edge",
- "shortName": "cg_edge",
- "latitude": 12,
- "longitude": 45,
- "parentCachegroup": "cache_group_mid",
- "typeName": "EDGE_LOC"
- }
-
- **Response Properties**
-
- +------------------------------------+--------+-------------------------------------------------------------------+
- | Parameter | Type | Description |
- +====================================+========+===================================================================+
- | ``id`` | string | The id of cache group |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``longitude`` | string | Longitude for the Cache Group |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``parentCachegroup`` | string | Name of Parent Cache Group entry. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | id of Parent Cache Group entry. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``secondaryParentCachegroup`` | string | Name of Secondary Parent Cache Group entry. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``secondaryParentCachegroupId`` | string | id of Secondary Parent Cache Group entry. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``typeName`` | string | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``alerts`` | array | A collection of alert messages. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +------------------------------------+--------+-------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Cachegroup successfully created: cache_group_edge"
- }
- ],
- "response": {
- 'longitude' : '45',
- 'lastUpdated' : '2016-01-25 13:55:30',
- 'shortName' : 'cg_edge',
- 'name' : 'cache_group_edge',
- 'parentCachegroup' : 'cache_group_mid',
- 'secondaryParentCachegroup' : null,
- 'latitude' : '12',
- 'typeName' : 'EDGE_LOC',
- 'id' : '104',
- 'parentCachegroupId' : '103',
- 'secondaryParentCachegroupId' : null
- }
- }
-
-|
-
-**PUT /api/1.2/cachegroups/{:id}**
-
- Update cache group.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +------+----------+------------------------------------+
- | Name | Required | Description |
- +======+==========+====================================+
- | id | yes | The id of the cache group to edit. |
- +------+----------+------------------------------------+
-
- **Request Parameters**
-
- +---------------------------------+----------+-------------------------------------------------------------------+
- | Name | Required | Description |
- +=================================+==========+===================================================================+
- | ``name`` | yes | The name of the Cache Group entry |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``shortName`` | yes | Abbreviation of the Cache Group Name |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``latitude`` | no | Latitude for the Cache Group |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``longitude`` | no | Longitude for the Cache Group |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``parentCachegroup`` | no | Name of Parent Cache Group entry. |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``secondaryParentCachegroup`` | no | Name of Secondary Parent Cache Group entry. |
- +---------------------------------+----------+-------------------------------------------------------------------+
- | ``typeName`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
- +---------------------------------+----------+-------------------------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name": "cache_group_edge",
- "shortName": "cg_edge",
- "latitude": 12,
- "longitude": 45,
- "parentCachegroup": "cache_group_mid",
- "typeName": "EDGE_LOC"
- }
-
- **Response Properties**
-
- +------------------------------------+--------+-------------------------------------------------------------------+
- | Parameter | Type | Description |
- +====================================+========+===================================================================+
- | ``id`` | string | The id of cache group |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``name`` | string | The name of the Cache Group entry |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``shortName`` | string | Abbreviation of the Cache Group Name |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``latitude`` | string | Latitude for the Cache Group |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``longitude`` | string | Longitude for the Cache Group |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``parentCachegroup`` | string | Name of Parent Cache Group entry. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``parentCachegroupId`` | string | id of Parent Cache Group entry. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``secondaryParentCachegroup`` | string | Name of Secondary Parent Cache Group entry. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``secondaryParentCachegroupId`` | string | id of Secondary Parent Cache Group entry. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``typeName`` | string | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time / Date this entry was last updated |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``alerts`` | array | A collection of alert messages. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +------------------------------------+--------+-------------------------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +------------------------------------+--------+-------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Cachegroup was updated: cache_group_edge"
- }
- ],
- "response": {
- 'longitude' : '45',
- 'lastUpdated' : '2016-01-25 13:55:30',
- 'shortName' : 'cg_edge',
- 'name' : 'cache_group_edge',
- 'parentCachegroup' : 'cache_group_mid',
- 'secondaryParentCachegroup' : null,
- 'latitude' : '12',
- 'typeName' : 'EDGE_LOC',
- 'id' : '104',
- 'parentCachegroupId' : '103',
- 'secondaryParentCachegroupId' : null
- }
- }
-
-|
-
-**DELETE /api/1.2/cachegroups/{:id}**
-
- Delete cache group. The request to delete a cache group, which has servers or child cache group, will be rejected.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +------+----------+--------------------------------------+
- | Name | Required | Description |
- +======+==========+======================================+
- | id | yes | The id of the cache group to delete. |
- +------+----------+--------------------------------------+
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Cachegroup was deleted: cache_group_edge"
- }
- ],
- }
-
-|
-
-**POST /api/1.2/cachegroups/{:id}/queue_update**
-
- Queue or dequeue updates for all servers assigned to a cache group limited to a specific CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-----------------+----------+----------------------+
- | Name | Required | Description |
- +=================+==========+======================+
- | id | yes | the cachegroup id. |
- +-----------------+----------+----------------------+
-
- **Request Properties**
-
- +--------------+---------+-----------------------------------------------+
- | Name | Type | Description |
- +==============+=========+===============================================+
- | action | string | queue or dequeue |
- +--------------+---------+-----------------------------------------------+
- | cdn | string | cdn name |
- +--------------+---------+-----------------------------------------------+
-
- **Response Properties**
-
- +-----------------+---------+----------------------------------------------------+
- | Name | Type | Description |
- +=================+=========+====================================================+
- | action | string | The action processed, queue or dequeue. |
- +-----------------+---------+----------------------------------------------------+
- | cachegroupId | integer | cachegroup id |
- +-----------------+---------+----------------------------------------------------+
- | cachegroupName | string | cachegroup name |
- +-----------------+---------+----------------------------------------------------+
- | cdn | string | cdn name |
- +-----------------+---------+----------------------------------------------------+
- | serverNames | array | servers name array in the cachegroup in cdn |
- +-----------------+---------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "cachegroupName": "us-il-chicago",
- "action": "queue",
- "serverNames": [
- "atsec-chi-00",
- "atsec-chi-01",
- "atsec-chi-02",
- "atsec-chi-03",
- ],
- "cachegroupId": "93",
- "cdn": "cdn_number_1",
- }
- }
-
-|
-
-**POST /api/1.2/cachegroups/{:id}/deliveryservices**
-
- Assign deliveryservices for servers in cachegroup
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +------------------+----------+------------------------------------------------------------------------------+
- | Name | Required | Description |
- +==================+==========+==============================================================================+
- | id | yes | The cachegroup id. |
- +------------------+----------+------------------------------------------------------------------------------+
-
- **Request Properties**
-
- +------------------+----------+------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+==========+==============================================================================+
- | deliveryServices | array | The Ids of the delivery services to assign to each server in the cachegroup. |
- +------------------+----------+------------------------------------------------------------------------------+
-
- **Request Example** ::
-
- {
- "deliveryServices": [ 234, 235 ]
- }
-
- **Response Properties**
-
- +--------------------+----------+--------------------------------------------------------+
- | Parameter | Type | Description |
- +====================+==========+========================================================+
- | response | hash | The details of the assignment, if success. |
- +--------------------+----------+--------------------------------------------------------+
- | >id | int | The cachegroup id. |
- +--------------------+----------+--------------------------------------------------------+
- | >serverNames | array | The server name array in the cachegroup. |
- +--------------------+----------+--------------------------------------------------------+
- | >deliveryServices | array | The deliveryservice id array. |
- +--------------------+----------+--------------------------------------------------------+
- | alerts | array | A collection of alert messages. |
- +--------------------+----------+--------------------------------------------------------+
- | >level | string | Success, info, warning or error. |
- +--------------------+----------+--------------------------------------------------------+
- | >text | string | Alert message. |
- +--------------------+----------+--------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "id": 3,
- "serverNames": [ "atlanta-edge-01", "atlanta-edge-07" ],
- "deliveryServices": [ 234, 235 ]
- }
- "alerts":
- [
- {
- "level": "success",
- "text": "Delivery services successfully assigned to all the servers of cache group 3."
- }
- ],
- }
-
-|
-
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
new file mode 100644
index 0000000..2d9f08d
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/cachegroup.txt
@@ -0,0 +1,696 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-cachegroup:
+
+Cache Group
+===========
+
+.. _to-api-v12-cachegroups-route:
+
+/api/1.2/cachegroups
+++++++++++++++++++++
+
+**GET /api/1.1/cachegroups**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ },
+ {
+ "id": "22",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago-1",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/cachegroups/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "dc-chicago"
+ },
+ {
+ "name": "dc-cmc"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/cachegroups/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +===================================+========+==========================================================================+
+ | ``id`` | string | Local unique identifier for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | Parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``parentCachegroupName`` | string | Parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | Secondary parent cachegroup ID. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``secondaryParentCachegroupName`` | string | Secondary parent cachegroup name. |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeId`` | string | Unique identifier for the 'Type' of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+ | ``typeName`` | string | The name of the type of Cache Group entry |
+ +-----------------------------------+--------+--------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "21",
+ "lastUpdated": "2012-09-25 20:27:28",
+ "latitude": "0",
+ "longitude": "0",
+ "name": "dc-chicago",
+ "parentCachegroupId": null,
+ "parentCachegroupName": null,
+ "secondaryParentCachegroupId": null,
+ "secondaryParentCachegroupName": null,
+ "shortName": "dcchi",
+ "typeName": "MID_LOC",
+ "typeId": "4"
+ }
+ ],
+ }
+
+|
+
+
+**GET /api/1.2/cachegroup/:parameter_id/parameter**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``parameter_id`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +-----------------+--------+-------------+
+ | Parameter | Type | Description |
+ +=================+========+=============+
+ | ``cachegroups`` | array | |
+ +-----------------+--------+-------------+
+ | ``>name`` | string | |
+ +-----------------+--------+-------------+
+ | ``>id`` | string | |
+ +-----------------+--------+-------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroups": [
+ {
+ "name": "dc-chicago",
+ "id": "21"
+ },
+ {
+ "name": "dc-cmc",
+ "id": "22"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.2/cachegroupparameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+-----------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+=========================================+
+ | ``cachegroupParameters`` | array | A collection of cache group parameters. |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>parameter`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>lastUpdated`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+ | ``>cachegroup`` | string | |
+ +--------------------------+--------+-----------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroupParameters": [
+ {
+ "parameter": "379",
+ "lastUpdated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ca-sanjose"
+ },
+ {
+ "parameter": "380",
+ "lastUpdated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ca-sanjose"
+ },
+ {
+ "parameter": "379",
+ "lastUpdated": "2013-08-05 18:49:37",
+ "cachegroup": "us-ma-woburn"
+ }
+ ]
+ },
+ }
+
+|
+
+**GET /api/1.2/cachegroups/:parameter_id/parameter/available**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-------------+
+ | Name | Required | Description |
+ +==================+==========+=============+
+ | ``parameter_id`` | yes | |
+ +------------------+----------+-------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "dc-chicago",
+ "id": "21"
+ },
+ {
+ "name": "dc-cmc",
+ "id": "22"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/cachegroups**
+
+ Create cache group.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``name`` | yes | The name of the Cache Group entry |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``shortName`` | yes | Abbreviation of the Cache Group Name |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``latitude`` | no | Latitude for the Cache Group |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``longitude`` | no | Longitude for the Cache Group |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``parentCachegroup`` | no | Name of Parent Cache Group entry. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroup`` | no | Name of Secondary Parent Cache Group entry. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``typeName`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "cache_group_edge",
+ "shortName": "cg_edge",
+ "latitude": 12,
+ "longitude": 45,
+ "parentCachegroup": "cache_group_mid",
+ "typeName": "EDGE_LOC"
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``id`` | string | The id of cache group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``parentCachegroup`` | string | Name of Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | id of Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroup`` | string | Name of Secondary Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | id of Secondary Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``typeName`` | string | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Cachegroup successfully created: cache_group_edge"
+ }
+ ],
+ "response": {
+ 'longitude' : '45',
+ 'lastUpdated' : '2016-01-25 13:55:30',
+ 'shortName' : 'cg_edge',
+ 'name' : 'cache_group_edge',
+ 'parentCachegroup' : 'cache_group_mid',
+ 'secondaryParentCachegroup' : null,
+ 'latitude' : '12',
+ 'typeName' : 'EDGE_LOC',
+ 'id' : '104',
+ 'parentCachegroupId' : '103',
+ 'secondaryParentCachegroupId' : null
+ }
+ }
+
+|
+
+**PUT /api/1.2/cachegroups/{:id}**
+
+ Update cache group.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------+----------+------------------------------------+
+ | Name | Required | Description |
+ +======+==========+====================================+
+ | id | yes | The id of the cache group to edit. |
+ +------+----------+------------------------------------+
+
+ **Request Parameters**
+
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | Name | Required | Description |
+ +=================================+==========+===================================================================+
+ | ``name`` | yes | The name of the Cache Group entry |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``shortName`` | yes | Abbreviation of the Cache Group Name |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``latitude`` | no | Latitude for the Cache Group |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``longitude`` | no | Longitude for the Cache Group |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``parentCachegroup`` | no | Name of Parent Cache Group entry. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroup`` | no | Name of Secondary Parent Cache Group entry. |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+ | ``typeName`` | yes | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+ +---------------------------------+----------+-------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "cache_group_edge",
+ "shortName": "cg_edge",
+ "latitude": 12,
+ "longitude": 45,
+ "parentCachegroup": "cache_group_mid",
+ "typeName": "EDGE_LOC"
+ }
+
+ **Response Properties**
+
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================================+========+===================================================================+
+ | ``id`` | string | The id of cache group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``name`` | string | The name of the Cache Group entry |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``shortName`` | string | Abbreviation of the Cache Group Name |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``latitude`` | string | Latitude for the Cache Group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``longitude`` | string | Longitude for the Cache Group |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``parentCachegroup`` | string | Name of Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``parentCachegroupId`` | string | id of Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroup`` | string | Name of Secondary Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``secondaryParentCachegroupId`` | string | id of Secondary Parent Cache Group entry. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``typeName`` | string | The type of Cache Group entry, "EDGE_LOC", "MID_LOC" or "ORG_LOC" |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time / Date this entry was last updated |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------------------------------+--------+-------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Cachegroup was updated: cache_group_edge"
+ }
+ ],
+ "response": {
+ 'longitude' : '45',
+ 'lastUpdated' : '2016-01-25 13:55:30',
+ 'shortName' : 'cg_edge',
+ 'name' : 'cache_group_edge',
+ 'parentCachegroup' : 'cache_group_mid',
+ 'secondaryParentCachegroup' : null,
+ 'latitude' : '12',
+ 'typeName' : 'EDGE_LOC',
+ 'id' : '104',
+ 'parentCachegroupId' : '103',
+ 'secondaryParentCachegroupId' : null
+ }
+ }
+
+|
+
+**DELETE /api/1.2/cachegroups/{:id}**
+
+ Delete cache group. The request to delete a cache group, which has servers or child cache group, will be rejected.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------+----------+--------------------------------------+
+ | Name | Required | Description |
+ +======+==========+======================================+
+ | id | yes | The id of the cache group to delete. |
+ +------+----------+--------------------------------------+
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Cachegroup was deleted: cache_group_edge"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/cachegroups/{:id}/queue_update**
+
+ Queue or dequeue updates for all servers assigned to a cache group limited to a specific CDN.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-----------------+----------+----------------------+
+ | Name | Required | Description |
+ +=================+==========+======================+
+ | id | yes | the cachegroup id. |
+ +-----------------+----------+----------------------+
+
+ **Request Properties**
+
+ +--------------+---------+-----------------------------------------------+
+ | Name | Type | Description |
+ +==============+=========+===============================================+
+ | action | string | queue or dequeue |
+ +--------------+---------+-----------------------------------------------+
+ | cdn | string | cdn name |
+ +--------------+---------+-----------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+---------+----------------------------------------------------+
+ | Name | Type | Description |
+ +=================+=========+====================================================+
+ | action | string | The action processed, queue or dequeue. |
+ +-----------------+---------+----------------------------------------------------+
+ | cachegroupId | integer | cachegroup id |
+ +-----------------+---------+----------------------------------------------------+
+ | cachegroupName | string | cachegroup name |
+ +-----------------+---------+----------------------------------------------------+
+ | cdn | string | cdn name |
+ +-----------------+---------+----------------------------------------------------+
+ | serverNames | array | servers name array in the cachegroup in cdn |
+ +-----------------+---------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "cachegroupName": "us-il-chicago",
+ "action": "queue",
+ "serverNames": [
+ "atsec-chi-00",
+ "atsec-chi-01",
+ "atsec-chi-02",
+ "atsec-chi-03",
+ ],
+ "cachegroupId": "93",
+ "cdn": "cdn_number_1",
+ }
+ }
+
+|
+
+**POST /api/1.2/cachegroups/{:id}/deliveryservices**
+
+ Assign deliveryservices for servers in cachegroup
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +------------------+----------+------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==================+==========+==============================================================================+
+ | id | yes | The cachegroup id. |
+ +------------------+----------+------------------------------------------------------------------------------+
+
+ **Request Properties**
+
+ +------------------+----------+------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+==========+==============================================================================+
+ | deliveryServices | array | The Ids of the delivery services to assign to each server in the cachegroup. |
+ +------------------+----------+------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "deliveryServices": [ 234, 235 ]
+ }
+
+ **Response Properties**
+
+ +--------------------+----------+--------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+==========+========================================================+
+ | response | hash | The details of the assignment, if success. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >id | int | The cachegroup id. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >serverNames | array | The server name array in the cachegroup. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >deliveryServices | array | The deliveryservice id array. |
+ +--------------------+----------+--------------------------------------------------------+
+ | alerts | array | A collection of alert messages. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >level | string | Success, info, warning or error. |
+ +--------------------+----------+--------------------------------------------------------+
+ | >text | string | Alert message. |
+ +--------------------+----------+--------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "id": 3,
+ "serverNames": [ "atlanta-edge-01", "atlanta-edge-07" ],
+ "deliveryServices": [ 234, 235 ]
+ }
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Delivery services successfully assigned to all the servers of cache group 3."
+ }
+ ],
+ }
+
+|
+
[48/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/admin/traffic_ops_using.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/admin/traffic_ops_using.rst.txt b/docs/latest/_sources/admin/traffic_ops_using.rst.txt
deleted file mode 100644
index 5b8525d..0000000
--- a/docs/latest/_sources/admin/traffic_ops_using.rst.txt
+++ /dev/null
@@ -1,1060 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. |graph| image:: ../../../traffic_ops/app/public/images/graph.png
-.. |info| image:: ../../../traffic_ops/app/public/images/info.png
-.. |checkmark| image:: ../../../traffic_ops/app/public/images/good.png
-.. |X| image:: ../../../traffic_ops/app/public/images/bad.png
-.. |clock| image:: ../../../traffic_ops/app/public/images/clock-black.png
-
-Using Traffic Ops
-%%%%%%%%%%%%%%%%%
-
-
-The Traffic Ops Menu
-====================
-
-.. image:: 12m.png
-
-The following tabs are available in the menu at the top of the Traffic Ops user interface.
-
-.. index::
- Health Tab
-
-* **Health**
-
- Information on the health of the system. Hover over this tab to get to the following options:
-
- +---------------+------------------------------------------------------------------------------------------------------------------------------------+
- | Option | Description |
- +===============+====================================================================================================================================+
- | Table View | A real time view into the main performance indicators of the CDNs managed by Traffic Control. |
- | | This view is sourced directly by the Traffic Monitor data and is updated every 10 seconds. |
- | | This is the default screen of Traffic Ops. |
- | | See :ref:`rl-health-table` for details. |
- +---------------+------------------------------------------------------------------------------------------------------------------------------------+
- | Graph View | A real graphical time view into the main performance indicators of the CDNs managed by Traffic Control. |
- | | This view is sourced by the Traffic Monitor data and is updated every 10 seconds. |
- | | On loading, this screen will show a history of 24 hours of data from Traffic Stats |
- | | See :ref:`rl-health-graph` for details. |
- +---------------+------------------------------------------------------------------------------------------------------------------------------------+
- | Server Checks | A table showing the results of the periodic check extension scripts that are run. See :ref:`rl-server-checks` |
- +---------------+------------------------------------------------------------------------------------------------------------------------------------+
- | Daily Summary | A graph displaying the daily peaks of bandwidth, overall bytes served per day, and overall bytes served since initial installation |
- | | per CDN. |
- +---------------+------------------------------------------------------------------------------------------------------------------------------------+
-
-* **Delivery Services**
-
- The main Delivery Service table. This is where you Create/Read/Update/Delete Delivery Services of all types. Hover over to get the following sub option:
-
- +-------------+--------------------------------------+
- | Option | Description |
- +=============+======================================+
- | Federations | Add/Edit/Delete Federation Mappings. |
- +-------------+--------------------------------------+
-
-* **Servers**
-
- The main Servers table. This is where you Create/Read/Update/Delete servers of all types. Click the main tab to get to the main table, and hover over to get these sub options:
-
- +-------------------+------------------------------------------------------------------------------------------+
- | Option | Description |
- +===================+==========================================================================================+
- | Upload Server CSV | Bulk add of servers from a csv file. See :ref:`rl-bulkserver` |
- +-------------------+------------------------------------------------------------------------------------------+
-
-* **Parameters**
-
- Parameters and Profiles can be edited here. Hover over the tab to get the following options:
-
- +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | Option | Description |
- +=====================+=====================================================================================================================================================================+
- | Global Profile | The table of global parameters. See :ref:`rl-param-prof`. This is where you Create/Read/Update/Delete parameters in the Global profile |
- +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | All Cache Groups | The table of all parameters *that are assgined to a cachegroup* - this may be slow to pull up, as there can be thousands of parameters. |
- +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | All Profiles | The table of all parameters *that are assgined to a profile* - this may be slow to pull up, as there can be thousands of parameters. |
- +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | Select Profile | Select the parameter list by profile first, then get a table of just the parameters for that profile. |
- +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | Orphaned Parameters | A table of parameters that are not associated to any profile of cache group. These parameters either should be deleted or associated with a profile of cache group. |
- +---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-* **Tools**
-
- Tools for working with Traffic Ops and it's servers. Hover over this tab to get the following options:
-
- +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | Option | Description |
- +====================+===================================================================================================================================+
- | Generate ISO | Generate a bootable image for any of the servers in the Servers table (or any server for that matter). See :ref:`rl-generate-iso` |
- +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | Queue Updates | Send Updates to the caches. See :ref:`rl-queue-updates` |
- +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | DB Dump | Backup the Database to a .sql file. |
- +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | Snapshot CRConfig | Send updates to the Traffic Monitor / Traffic Router servers. See :ref:`rl-queue-updates` |
- +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | Invalidate Content | Invalidate or purge content from all caches in the CDN. See :ref:`rl-purge` |
- +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
- | Manage DNSSEC keys | Manage DNSSEC Keys for a chosen CDN. |
- +--------------------+-----------------------------------------------------------------------------------------------------------------------------------+
-
-
-* **Misc**
-
- Miscellaneous editing options. Hover over this tab to get the following options:
-
- +--------------------+-------------------------------------------------------------------------------------------+
- | Option | Description |
- +====================+===========================================================================================+
- | Cache Groups | Create/Read/Update/Delete cache groups |
- +--------------------+-------------------------------------------------------------------------------------------+
- | Users | Create/Read/Update/Delete users |
- +--------------------+-------------------------------------------------------------------------------------------+
- | Profiles | Create/Read/Update/Delete profiles. See :ref:`rl-working-with-profiles` |
- +--------------------+-------------------------------------------------------------------------------------------+
- | Networks(ASNs) | Create/Read/Update/Delete Autonomous System Numbers See :ref:`rl-asn-czf` |
- +--------------------+-------------------------------------------------------------------------------------------+
- | Hardware | Get detailed hardware information (note: this should be moved to a Traffic Ops Extension) |
- +--------------------+-------------------------------------------------------------------------------------------+
- | Data Types | Create/Read/Update/Delete data types |
- +--------------------+-------------------------------------------------------------------------------------------+
- | Divisions | Create/Read/Update/Delete divisions |
- +--------------------+-------------------------------------------------------------------------------------------+
- | Regions | Create/Read/Update/Delete regions |
- +--------------------+-------------------------------------------------------------------------------------------+
- | Physical Locations | Create/Read/Update/Delete locations |
- +--------------------+-------------------------------------------------------------------------------------------+
-
-.. index::
- Change Log
-
-* **ChangeLog**
-
- The Changelog table displays the changes that are being made to the Traffic Ops database through the Traffic Ops user interface. This tab will show the number of changes since you last visited this tab in (brackets) since the last time you visited this tab. There are currently no sub menus for this tab.
-
-
-* **Help**
-
- Help for Traffic Ops and Traffic Control. Hover over this tab to get the following options:
-
- +---------------+---------------------------------------------------------------------+
- | Option | Description |
- +===============+=====================================================================+
- | About | Traffic Ops information, such as version, database information, etc |
- +---------------+---------------------------------------------------------------------+
- | Release Notes | Release notes for the most recent releases of Traffic Ops |
- +---------------+---------------------------------------------------------------------+
- | Logout | Logout from Traffic Ops |
- +---------------+---------------------------------------------------------------------+
-
-
-.. index::
- Edge Health
- Health
-
-Health
-======
-
-.. _rl-health-table:
-
-The Health Table
-++++++++++++++++
-The Health table is the default landing screen for Traffic Ops, it displays the status of the EDGE caches in a table form directly from Traffic Monitor (bypassing Traffic Stats), sorted by Mbps Out. The columns in this table are:
-
-
-* **Profile**: the Profile of this server or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.
-* **Host Name**: the host name of the server or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.
-* **Edge Cache Group**: the edge cache group short name or ALL, meaning this row shows data for multiple servers, and the row shows the sum of all values.
-* **Healthy**: indicates if this cache is healthy according to the Health Protocol. A row with ALL in any of the columns will always show a |checkmark|, this column is valid only for individual EDGE caches.
-* **Admin**: shows the administrative status of the server.
-* **Connections**: the number of connections this cache (or group of caches) has open (``ats.proxy.process.http.current_client_connections`` from ATS).
-* **Mbps Out**: the bandwidth being served out if this cache (or group of caches)
-
-Since the top line has ALL, ALL, ALL, it shows the total connections and bandwidth for all caches managed by this instance of Traffic Ops.
-
-.. _rl-health-graph:
-
-Graph View
-++++++++++
-The Graph View shows a live view of the last 24 hours of bits per seconds served and open connections at the edge in a graph. This data is sourced from Traffic Stats. If there are 2 CDNs configured, this view will show the statistis for both, and the graphs are stacked. On the left-hand side, the totals and immediate values as well as the percentage of total possible capacity are displayed. This view is update every 10 seconds.
-
-
-.. _rl-server-checks:
-
-Server Checks
-+++++++++++++
-The server checks page is inteded to give an overview of the Servers managed by Traffic Control as well as their status. This data comes from `Traffic Ops extensions <traffic_ops_extensions.html>`_.
-
-+------+-----------------------------------------------------------------------+
-| Name | Description |
-+======+=======================================================================+
-| ILO | Ping the iLO interface for EDGE or MID servers |
-+------+-----------------------------------------------------------------------+
-| 10G | Ping the IPv4 address of the EDGE or MID servers |
-+------+-----------------------------------------------------------------------+
-| 10G6 | Ping the IPv6 address of the EDGE or MID servers |
-+------+-----------------------------------------------------------------------+
-| MTU | Ping the EDGE or MID using the configured MTU from Traffic Ops |
-+------+-----------------------------------------------------------------------+
-| FQDN | DNS check that matches what the DNS servers responds with compared to |
-| | what Traffic Ops has. |
-+------+-----------------------------------------------------------------------+
-| DSCP | Checks the DSCP value of packets from the edge server to the Traffic |
-| | Ops server. |
-+------+-----------------------------------------------------------------------+
-| RTR | Content Router checks. Checks the health of the Content Routers. |
-| | Checks the health of the caches using the Content Routers. |
-+------+-----------------------------------------------------------------------+
-| CHR | Cache Hit Ratio in percent. |
-+------+-----------------------------------------------------------------------+
-| CDU | Total Cache Disk Usage in percent. |
-+------+-----------------------------------------------------------------------+
-| ORT | Operational Readiness Test. Uses the ORT script on the edge and mid |
-| | servers to determine if the configuration in Traffic Ops matches the |
-| | configuration on the edge or mid. The user that this script runs as |
-| | must have an ssh key on the edge servers. |
-+------+-----------------------------------------------------------------------+
-
-Daily Summary
-+++++++++++++
-Displays daily max gbps and bytes served for all CDNs. In order for the graphs to appear, the 'daily_bw_url' and 'daily_served_url' parameters need to be be created, assigned to the global profile, and have a value of a grafana graph. For more information on configuring grafana, see the `Traffic Stats <traffic_stats.html>`_ section.
-
-.. _rl-server:
-
-Server
-======
-This view shows a table of all the servers in Traffic Ops. The table columns show the most important details of the server. The **IPAddrr** column is clickable to launch an ``ssh://`` link to this server. The |graph| icon will link to a Traffic Stats graph of this server for caches, and the |info| will link to the server status pages for other server types.
-
-
-Server Types
-++++++++++++
-These are the types of servers that can be managed in Traffic Ops:
-
-+---------------+---------------------------------------------+
-| Name | Description |
-+===============+=============================================+
-| EDGE | Edge Cache |
-+---------------+---------------------------------------------+
-| MID | Mid Tier Cache |
-+---------------+---------------------------------------------+
-| ORG | Origin |
-+---------------+---------------------------------------------+
-| CCR | Comcast Content Router |
-+---------------+---------------------------------------------+
-| RASCAL | Rascal health polling & reporting |
-+---------------+---------------------------------------------+
-| TOOLS_SERVER | Ops hosts for managment |
-+---------------+---------------------------------------------+
-| RIAK | Riak keystore |
-+---------------+---------------------------------------------+
-| SPLUNK | SPLUNK indexer search head etc |
-+---------------+---------------------------------------------+
-| TRAFFIC_STATS | traffic_stats server |
-+---------------+---------------------------------------------+
-| INFLUXDB | influxDb server |
-+---------------+---------------------------------------------+
-
-
-.. index::
- Bulk Upload Server
-
-.. _rl-bulkserver:
-
-Bulk Upload Server
-++++++++++++++++++
-
-
-
-Delivery Service
-================
-The fields in the Delivery Service view are:
-
-.. Sorry for the width of this table, don't know how to make the bullet lists work otherwise. Just set your monitor to 2560*1600, and put on your glasses.
-
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Name | Description |
-+==================================================+=====================================================================================================================================================================================================================+
-| XML ID | A unique string that identifies this delivery service. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Content Routing Type | The type of content routing this delivery service will use. See :ref:`rl-ds-types`. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Protocol | The protocol to serve this delivery service to the clients with: |
-| | |
-| | - 0 http |
-| | - 1 https |
-| | - 2 both http and https |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DSCP Tag | The DSCP value to mark IP packets to the client with. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Signed URLs | Use Signed URLs? See :ref:`rl-signed-urls`. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Query String Handling | How to treat query strings: |
-| | |
-| | - 0 use in cache key and hand up to origin -this means each unique query string Is treated as a unique URL. |
-| | - 1 Do not use in cache key, but pass up to origin - this means a 2 URLs that are the same except for the query string will match, and cache HIT, while the origin still sees original query string in the request. |
-| | - 2 Drop at edge - this means a 2 URLs that are the same except for the query string will match, and cache HIT, while the origin will not see original query string in the request. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geo Limit? | Some services are intended to be limited by geography. The possible settings are are: |
-| | |
-| | - None - Do not limit by geography. |
-| | - CZF only - If the requesting IP is not in the Coverage Zone File, do not serve the request. |
-| | - CZF + US - If the requesting IP is not in the Coverage Zone File or not in the United States, do not serve the request. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geo Limit Redirect URL | (for HTTP routed delivery services only) This is the URL Traffic Router will redirect to when Geo Limit Failure. See :ref:`geolimit-failure-redirect-feature` |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Bypass FQDN | (for HTTP routed delivery services only) This is the FQDN Traffic Router will redirect to (with the same path) when the max Bps or Max Tps for this deliveryservice are exceeded. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Bypass Ipv4 | (For DNS routed delivery services only) This is the address to respond to A requests with when the the max Bps or Max Tps for this delivery service are exceeded. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Bypass IPv6 | (For DNS routed delivery services only) This is the address to respond to AAAA requests with when the the max Bps or Max Tps for this delivery service are exceeded. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| IPv6 Routing Enabled? | When set to yes, the Traffic Router will respond to AAAA DNS requests for the tr. and edge. names of this delivery service. Otherwise, only A records will be served. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Range Request Handling | (experimental) How to treat range requests: |
-| | |
-| | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
-| | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/background_fetch.en.html>`_ plugin. |
-| | - 2 Use the cache_range_requests plugin. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Delivery Service DNS TTL | The Time To Live on the DNS record for the Traffic Router A and AAAA records (``tr.<deliveryservice>.<cdn-domain>``) for a HTTP delivery service *or* for the A and |
-| | AAAA records of the edge name (``edge.<deliveryservice>.<cdn-domain>``). |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Origin Server Base URL | The Origin Server's base URL. This includes the protocol (http or https). Example: ``http://movies.origin.com`` |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Use Multi Site Origin Feature | Enable the Multi Site Origin feature for this delivery service. See :ref:`rl-multi-site-origin` |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Multi Site Origin Algorithm | - 1 Consistent Hash spreads requests across multiple parents simultaneously based on hash of content URL. |
-| | - 2 Strict Round Robin spreads requests across multiple parents simultaneously based on order of requests. |
-| | - 3 IP Based Round Robin spreads requests across multiple parents simultaneously based on order of requests, but ensures that requests from the same IP always go to the same parent if available. |
-| | - 4 Latched uses only a single parent at any given time and switches to a new parent only if the current parent fails. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| CCR profile | The Traffic Router profile for this delivery service. See :ref:`rl-ccr-profile`. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Maximum Bits per Second allowed globally | The maximum bits per second this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used |
-| | (depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Maximum Transactions per Second allowed globally | The maximum transactions per se this delivery service can serve across all EDGE caches before traffic will be diverted to the bypass destination. For a DNS delivery service, the Bypass Ipv4 or Ipv6 will be used |
-| | (depending on whether this was a A or AAAA request), and for HTTP delivery services the Bypass FQDN will be used. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geo Miss Default Latitude | Default Latitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this lat. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Geo Miss Default Longitude | Default Longitude for this delivery service. When client localization fails for bot Coverage Zone and Geo Lookup, this the client will be routed as if it was at this long. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Edge Header Rewrite Rules | Header Rewrite rules to apply for this delivery service at the EDGE tier. See :ref:`rl-header-rewrite`. [1]_ |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Mid Header Rewrite Rules | Header Rewrite rules to apply for this delivery service at the MID tier. See :ref:`rl-header-rewrite`. [1]_ |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Regex Remap Expression | Regex Remap rule to apply to this delivery service at the Edge tier. See `ATS documentation on regex_remap <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/regex_remap.en.html>`_. [1]_ |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Cache URL expression | Cache URL rule to apply to this delivery service. See `ATS documentation on cacheurl <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/cacheurl.en.html>`_. [1]_ |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Raw remap text | For HTTP and DNS deliveryservices, this will get added to the end of the remap line on the cache verbatim. For ANY_MAP deliveryservices this is the remap line. [1]_ |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Long Description | Long description for this delivery service. To be consumed from the APIs by downstream tools (Portal). |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Customer | Customer description for this delivery service. To be consumed from the APIs by downstream tools (Portal). |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Service | Service description for this delivery service. To be consumed from the APIs by downstream tools (Portal). |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Info URL | Info URL for this delivery service. To be consumed from the APIs by downstream tools (Portal). |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Check Path | A path (ex: /crossdomain.xml) to verify the connection to the origin server with. This can be used by Check Extension scripts to do periodic health checks against the delivery service. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Origin Shield (Pipe Delimited String) | Experimental. Origin Shield string. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Active | When this is set to no Traffic Router will not serve DNS or HTTP responses for this delivery service. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Last Updated | (Read Only) The last time this delivery service was updated. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Number of edges assigned | (Read Only - change by clicking the **Server Assignments** button at the bottom) The number of EDGE caches assigned to this delivery service. See :ref:`rl-assign-edges`. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Number of static DNS entries | (Read Only - change by clicking the **Static DNS** button at the bottom) The number of static DNS entries for this delivery service. See :ref:`rl-static-dns`. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Example delivery URL | (Read Only) An example of how the delivery URL may start. This could be multiple rows if multiple HOST_REGEXP entries have been entered. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Regular expressions for this delivery service | A subtable of the regular expressions to use when routing traffic for this delivery service. See :ref:`rl-ds-regexp`. |
-+--------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-.. [1] These fields are not validated by Traffic Ops to be correct syntactically, and can cause Traffic Server to not start if invalid. Please use with caution.
-
-
-.. index::
- Delivery Service Type
-
-.. _rl-ds-types:
-
-Delivery Service Types
-++++++++++++++++++++++
-One of the most important settings when creating the delivery service is the selection of the delivery service *type*. This type determines the routing method and the primary storage for the delivery service.
-
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Name | Description |
-+=================+==============================================================================================================================================================================================================================================================================================================================+
-| HTTP | HTTP Content Routing - The Traffic Router DNS auth server returns its own IP address on DNS queries, and the client gets redirected to a specific cache |
-| | in the nearest cache group using HTTP 302. Use this for long sessions like HLS/HDS/Smooth live streaming, where a longer setup time is not a. |
-| | problem. |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS | DNS Content Routing - The Traffic Router DNS auth server returns an edge cache IP address to the client right away. The client will find the cache quickly |
-| | but the Traffic Router can not route to a cache that already has this content in the cache group. Use this for smaller objects like web page images / objects. |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTTP_NO_CACHE | HTTP Content Routing, but the caches will not actually cache the content, they act as just proxies. The MID tier is bypassed. |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTTP_LIVE | HTTP Content routing, but where for "standard" HTTP content routing the objects are stored on disk, for this delivery service type the objects are stored |
-| | on the RAM disks. Use this for linear TV. The MID tier is bypassed for this type. |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| HTTP_LIVE_NATNL | HTTP Content routing, same as HTTP_LIVE, but the MID tier is NOT bypassed. |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS_LIVE_NATNL | DNS Content routing, ut where for "standard" DNS content routing the objects are stored on disk, for this delivery service type the objects are stored |
-| | on the RAM disks. Use this for linear TV. The MID tier is NOT bypassed for this type. |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| DNS_LIVE | DNS Content routing, same as DNS_LIVE_NATIONAL, but the MID tier is bypassed. |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| ANY_MAP | ANY_MAP is not known to Traffic Router. For this deliveryservice, the "Raw remap text" field in the input form will be used as the remap line on the cache. |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| STEERING | The Delivery Service will be used to route to other delivery services. The target delivery services Traffic Router and the routing weights for those delivery services will be defined by an admin or steering user. For more information see the `steering feature <traffic_router.html#steering-feature>`_ documentation |
-+-----------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-
-.. Note:: Once created, the Traffic Ops user interface does not allow you to change the delivery service type; the drop down is greyed out. There are many things that can go wrong when changing the type, and it is safer to delete the delivery service, and recreate it.
-
-Federations
-+++++++++++
- Federations allow for other (federated) CDNs (at a different ISP, MSO, etc) to add a list of resolvers and a CNAME to a delivery service Traffic Ops. When a request is made from one of federated CDN's clients, Traffic Router will return the CNAME configured in the federation mapping. This allows the federated CDN to serve the content without the content provider changing the URL, or having to manage multiple URLs.
-
- Before adding a federation in the Traffic Ops UI, a user with the federations role needs to be created. This user will be assigned to the federation and will be able to add resolvers to the federation via the Traffic Ops `Federation API <../development/traffic_ops_api/v12/federation.html>`_.
-
-.. index::
- Header Rewrite
-
-.. _rl-header-rewrite:
-
-Header Rewrite Options and DSCP
-+++++++++++++++++++++++++++++++
-Most header manipulation and per-delivery service configuration overrides are done using the `ATS Header Rewrite Plugin <https://docs.trafficserver.apache.org/en/latest/admin-guide/plugins/header_rewrite.en.html>`_. Traffic Control allows you to enter header rewrite rules to be applied at the edge and at the mid level. The syntax used in Traffic Ops is the same as the one described in the ATS documentation, except for some special strings that will get replaced:
-
-+-------------------+--------------------------+
-| Traffic Ops Entry | Gets Replaced with |
-+===================+==========================+
-| __RETURN__ | A newline |
-+-------------------+--------------------------+
-| __CACHE_IPV4__ | The cache's IPv4 address |
-+-------------------+--------------------------+
-
-The deliveryservice screen also allows you to set the DSCP value of traffic sent to the client. This setting also results in a header_rewrite rule to be generated and applied to at the edge.
-
-.. Note:: The DSCP setting in the UI is *only* for setting traffic towards the client, and gets applied *after* the initial TCP handshake is complete, and the HTTP request is received (before that the cache can't determine what deliveryservice this request is for, and what DSCP to apply), so the DSCP feature can not be used for security settings - the TCP SYN-ACK is not going to be DSCP marked.
-
-
-.. index::
- Token Based Authentication
- Signed URLs
-
-.. _rl-signed-urls:
-
-Token Based Authentication
-++++++++++++++++++++++++++
-Token based authentication or *signed URLs* is implemented using the Traffic Server ``url_sig`` plugin. To sign a URL at the signing portal take the full URL, without any query string, and add on a query string with the following parameters:
-
-Client IP address
- The client IP address that this signature is valid for.
-
- ``C=<client IP address>``
-
-Expiration
- The Expiration time (seconds since epoch) of this signature.
-
- ``E=<expiration time in secs since unix epoch>``
-
-Algorithm
- The Algorithm used to create the signature. Only 1 (HMAC_SHA1)
- and 2 (HMAC_MD5) are supported at this time
-
- ``A=<algorithm number>``
-
-Key index
- Index of the key used. This is the index of the key in the
- configuration file on the cache. The set of keys is a shared
- secret between the signing portal and the edge caches. There
- is one set of keys per reverse proxy domain (fqdn).
-
- ``K=<key index used>``
-Parts
- Parts to use for the signature, always excluding the scheme
- (http://). parts0 = fqdn, parts1..x is the directory parts
- of the path, if there are more parts to the path than letters
- in the parts param, the last one is repeated for those.
- Examples:
-
- 1: use fqdn and all of URl path
- 0110: use part1 and part 2 of path only
- 01: use everything except the fqdn
-
- ``P=<parts string (0's and 1's>``
-
-Signature
- The signature over the parts + the query string up to and
- including "S=".
-
- ``S=<signature>``
-
-.. seealso:: The url_sig `README <https://github.com/apache/trafficserver/blob/master/plugins/experimental/url_sig/README>`_.
-
-Generate URL Sig Keys
-^^^^^^^^^^^^^^^^^^^^^
-To generate a set of random signed url keys for this delivery service and store them in Traffic Vault, click the **Generate URL Sig Keys** button at the bottom of the delivery service details screen.
-
-
-.. rl-parent-selection:
-
-Parent Selection
-++++++++++++++++
-
-Parameters in the Edge (child) profile that influence this feature:
-
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| Name | Filename | Default | Description |
-+===============================================+================+===============+=======================================================+
-| CONFIG proxy.config. | records.config | INT 1 | enable parent selection. This is a required setting. |
-| http.parent_proxy_routing_enable | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 1 | required for parent selection. |
-| url_remap.remap_required | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 0 | See |
-| http.no_dns_just_forward_to_parent | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 1 | |
-| http.uncacheable_requests_bypass_parent | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 1 | |
-| http.parent_proxy_routing_enable | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 300 | |
-| http.parent_proxy.retry_time | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 10 | |
-| http.parent_proxy.fail_threshold | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 4 | |
-| http.parent_proxy.total_connect_attempts | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 2 | |
-| http.parent_proxy.per_parent_connect_attempts | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 30 | |
-| http.parent_proxy.connect_attempts_timeout | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 0 | |
-| http.forward.proxy_auth_to_parent | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 0 | |
-| http.parent_proxy_routing_enable | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | STRING | |
-| http.parent_proxy.file | | parent.config | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| CONFIG proxy.config. | records.config | INT 3 | |
-| http.parent_proxy.connect_attempts_timeout | | | |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-| algorithm | parent.config | urlhash | The algorithm to use. |
-+-----------------------------------------------+----------------+---------------+-------------------------------------------------------+
-
-
-Parameters in the Mid (parent) profile that influence this feature:
-
-+----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Name | Filename | Default | Description |
-+================+===============+=========+===================================================================================================================================================================================+
-| domain_name | CRConfig.json | - | Only parents with the same value as the edge are going to be used as parents (to keep separation between CDNs) |
-+----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| weight | parent.config | 1.0 | The weight of this parent, translates to the number of replicas in the consistent hash ring. This parameter only has effect with algorithm at the client set to "consistent_hash" |
-+----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| port | parent.config | 80 | The port this parent is listening on as a forward proxy. |
-+----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| use_ip_address | parent.config | 0 | 1 means use IP(v4) address of this parent in the parent.config, 0 means use the host_name.domain_name concatenation. |
-+----------------+---------------+---------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-
-.. _rl-multi-site-origin:
-
-Multi Site Origin
-+++++++++++++++++
-.. Note:: The Multi Site Origin feature is based upon a feature n ATS that has yet to be submitted to Traffic Server upstream, until it is, set this to 0, or use the ATS rpm supplied on the trafficcontrol.apache.org website.
-
-Normally, the mid servers are not aware of any redundancy at the origin layer. With Multi Site Origin enabled this changes - Traffic Server (and Traffic Ops) are now made aware of the fact there are multiple origins, and can be configured to do more advanced failover and loadbalancing actions.
-
-With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is With This feature enabled, origin servers (or origin server VIP names for a site) are going to be entered as servers in to the Traiffic Ops UI. Server type is ""
-
-
-Parameters in the Origin profile that influence this feature:
-
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| Name | Filename | Default | Description |
-+==========================================================================+================+============+====================================================================================================+
-| CONFIG proxy.config. http.parent_proxy_routing_enable | records.config | INT 1 | enable parent selection. This is a required setting. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. url_remap.remap_required | records.config | INT 1 | required for parent selection. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_proxy.per_parent_connect_attempts | records.config | INT 5 | maximum of 5 connection attempts per parent (parent.config list) within a transaction. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_proxy.total_connect_attempts | records.config | INT 10 | maximum of 10 total connection attempts within a transaction. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_origin.simple_retry_enabled | records.config | INT 1 | enables simple retry. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_origin.simple_retry_response_codes | records.config | STRING 404 | the response code that invokes simple retry. May be a comman separated list of response codes. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_origin.dead_server_retry_response_codes | records.config | STRING 503 | the response code that invokes dead server retry. May be a comma separated list of response codes |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. http.parent_origin.dead_server_retry_enabled | records.config | INT 1 | enables dead server retry. |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-| CONFIG proxy.config. diags.debug.enabled | records.config | INT 1 | enable debugging for testing only |
-+--------------------------------------------------------------------------+----------------+------------+----------------------------------------------------------------------------------------------------+
-
-see :ref:`rl-multi-site-origin-qht` for a *quick how to* on this feature.
-
-.. _rl-ccr-profile:
-
-CCR Profile or Traffic Router Profile
-+++++++++++++++++++++++++++++++++++++
-
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| Name | Config_file | Description |
-+=========================================+========================+===========================================================================================================================================================================================================+
-| location | dns.zone | Location to store the DNS zone files in the local file system of Traffic Router. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| location | http-log4j.properties | Location to find the log4j.properties file for Traffic Router. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| location | dns-log4j.properties | Location to find the dns-log4j.properties file for Traffic Router. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| location | geolocation.properties | Location to find the log4j.properties file for Traffic Router. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| CDN_name | rascal-config.txt | The human readable name of the CDN for this profile. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| CoverageZoneJsonURL | CRConfig.xml | The location (URL) to retrieve the coverage zone map file in JSON format from. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| geolocation.polling.url | CRConfig.json | The location (URL) to retrieve the geo database file from. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| geolocation.polling.interval | CRConfig.json | How often to refresh the coverage geo location database in ms |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| coveragezone.polling.interval | CRConfig.json | How often to refresh the coverage zone map in ms |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| coveragezone.polling.url | CRConfig.json | The location (URL) to retrieve the coverage zone map file in XML format from. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| domain_name | CRConfig.json | The top level domain of this Traffic Router instance. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.expire | CRConfig.json | The value for the expire field the Traffic Router DNS Server will respond with on Start of Authority (SOA) records. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.minimum | CRConfig.json | The value for the minimum field the Traffic Router DNS Server will respond with on SOA records. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.admin | CRConfig.json | The DNS Start of Authority admin. Should be a valid support email address for support if DNS is not working correctly. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.retry | CRConfig.json | The value for the retry field the Traffic Router DNS Server will respond with on SOA records. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.soa.refresh | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on A records. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.ttls.NS | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on NS records. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.ttls.SOA | CRConfig.json | The TTL the Traffic Router DNS Server will respond with on SOA records. |
-+-----------------------------------------+------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| tld.ttls.AAAA | CRConfig.json | The Time To Live (TTL) the Traffic Router DNS Server will respond with on AAAA records.
<TRUNCATED>
[31/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/cdn.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/cdn.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/cdn.rst.txt
deleted file mode 100644
index 1819c69..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/cdn.rst.txt
+++ /dev/null
@@ -1,1334 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-cdn:
-
-CDN
-===
-
-.. _to-api-v12-cdn-route:
-
-/api/1.2/cdns
-+++++++++++++
-
-**GET /api/1.2/cdns**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=================================================+
- | ``id`` | string | CDN id. |
- +-------------------+--------+-------------------------------------------------+
- | ``name`` | string | CDN name. |
- +-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | bool | DNSSEC enabled. |
- +-------------------+--------+-------------------------------------------------+
- | ``lastUpdated`` | string | |
- +-------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "1"
- "name": "over-the-top",
- "dnssecEnabled": false,
- "lastUpdated": "2014-10-02 08:22:43"
- },
- {
- "id": "2"
- "name": "cdn2",
- "dnssecEnabled": true,
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-**GET /api/1.2/cdns/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | CDN id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +-------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=================================================+
- | ``id`` | string | CDN id. |
- +-------------------+--------+-------------------------------------------------+
- | ``name`` | string | CDN name. |
- +-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | bool | DNSSEC enabled. |
- +-------------------+--------+-------------------------------------------------+
- | ``lastUpdated`` | string | |
- +-------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "2"
- "name": "cdn2",
- "dnssecEnabled": false,
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-**GET /api/1.2/cdns/name/:name**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``name`` | yes | CDN name. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +-------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=================================================+
- | ``id`` | string | CDN id. |
- +-------------------+--------+-------------------------------------------------+
- | ``name`` | string | CDN name. |
- +-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | bool | DNSSEC enabled. |
- +-------------------+--------+-------------------------------------------------+
- | ``lastUpdated`` | string | |
- +-------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "2"
- "name": "cdn2",
- "dnssecEnabled": false,
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-**POST /api/1.2/cdns**
-
- Allows user to create a CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Parameters**
-
- +-------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=================================================+
- | ``name`` | string | CDN name. |
- +-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | int | Whether dnssec is enabled. |
- | | | - 0: disabled |
- | | | - 1: enabled |
- +-------------------+--------+-------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name": "cdn_test",
- "dnssecEnabled": 0
- }
-
- **Response Properties**
-
- +--------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+=================================================+
- | ``response`` | hash | The details of the creation, if success. |
- +--------------------+--------+-------------------------------------------------+
- | ``>name`` | string | CDN name. |
- +--------------------+--------+-------------------------------------------------+
- | ``>id`` | int | CDN id. |
- +--------------------+--------+-------------------------------------------------+
- | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
- +--------------------+--------+-------------------------------------------------+
- | ``alerts`` | array | A collection of alert messages. |
- +--------------------+--------+-------------------------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +--------------------+--------+-------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +--------------------+--------+-------------------------------------------------+
-
-
- **Response Example** ::
-
- {
- "response":{
- "name": "cdn_test",
- "id": 3
- "dnssecEnabled": 0
- },
- "alerts":[
- {
- "level": "success",
- "text": "cdn was created."
- }
- ]
- }
-
-|
-
-**PUT /api/1.2/cdns/{:id}**
-
- Allows user to edit a CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Type | Description |
- +===================+==========+================================================+
- | ``id`` | int | CDN id. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +-------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +===================+========+=================================================+
- | ``name`` | string | CDN name. |
- +-------------------+--------+-------------------------------------------------+
- | ``dnssecEnabled`` | int | Whether dnssec is enabled. |
- | | | - 0: disabled |
- | | | - 1: enabled |
- +-------------------+--------+-------------------------------------------------+
-
-
- **Request Example** ::
-
- {
- "name": "cdn_test2",
- "dnssecEnabled": 0
- }
-
- **Response Properties**
-
- +--------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+=================================================+
- | ``response`` | hash | The details of the update, if success. |
- +--------------------+--------+-------------------------------------------------+
- | ``>name`` | string | CDN name. |
- +--------------------+--------+-------------------------------------------------+
- | ``>id`` | int | CDN id. |
- +--------------------+--------+-------------------------------------------------+
- | ``>dnssecEnabled`` | string | Whether dnssec is enabled. |
- +--------------------+--------+-------------------------------------------------+
- | ``alerts`` | array | A collection of alert messages. |
- +--------------------+--------+-------------------------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +--------------------+--------+-------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +--------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response":{
- "name": "cdn_test2",
- "id": 3
- "dnssecEnabled": 0
- },
- "alerts":[
- {
- "level": "success",
- "text": "cdn was updated."
- }
- ]
- }
-
-|
-
-**DELETE /api/1.2/cdns/{:id}**
-
- Allows user to delete a CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-----------------+----------+------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+================================================+
- | ``id`` | yes | CDN id. |
- +-----------------+----------+------------------------------------------------+
-
- **Response Properties**
-
- +-----------------+----------+------------------------------------------------+
- | Parameter | Type | Description |
- +=================+==========+================================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-----------------+----------+------------------------------------------------+
- | ``>level`` | string | success, info, warning or error. |
- +-----------------+----------+------------------------------------------------+
- | ``>text`` | string | Alert message. |
- +-----------------+----------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "cdn was deleted."
- }
- ],
- }
-
-|
-
-Health
-++++++
-
-.. _to-api-v12-cdn-health-route:
-
-**GET /api/1.2/cdns/health**
-
- Retrieves the health of all locations (cache groups) for all CDNs.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``totalOnline`` | int | Total number of online caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
- +------------------+--------+-------------------------------------------------+
- | ``cachegroups`` | array | A collection of cache groups. |
- +------------------+--------+-------------------------------------------------+
- | ``>online`` | int | The number of online caches for the cache group |
- +------------------+--------+-------------------------------------------------+
- | ``>offline`` | int | The number of offline caches for the cache |
- | | | group. |
- +------------------+--------+-------------------------------------------------+
- | ``>name`` | string | Cache group name. |
- +------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "totalOnline": 148,
- "totalOffline": 0,
- "cachegroups": [
- {
- "online": 8,
- "offline": 0,
- "name": "us-co-denver"
- },
- {
- "online": 7,
- "offline": 0,
- "name": "us-de-newcastle"
- }
- ]
- },
- }
-
-|
-
-**GET /api/1.2/cdns/:name/health**
-
- Retrieves the health of all locations (cache groups) for a given CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- |``name`` | yes | |
- +-----------------+----------+---------------------------------------------------+
-
- **Response Properties**
-
- +------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +==================+========+=================================================+
- | ``totalOnline`` | int | Total number of online caches across the |
- | | | specified CDN. |
- +------------------+--------+-------------------------------------------------+
- | ``totalOffline`` | int | Total number of offline caches across the |
- | | | specified CDN. |
- +------------------+--------+-------------------------------------------------+
- | ``cachegroups`` | array | A collection of cache groups. |
- +------------------+--------+-------------------------------------------------+
- | ``>online`` | int | The number of online caches for the cache group |
- +------------------+--------+-------------------------------------------------+
- | ``>offline`` | int | The number of offline caches for the cache |
- | | | group. |
- +------------------+--------+-------------------------------------------------+
- | ``>name`` | string | Cache group name. |
- +------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "totalOnline": 148,
- "totalOffline": 0,
- "cachegroups": [
- {
- "online": 8,
- "offline": 0,
- "name": "us-co-denver"
- },
- {
- "online": 7,
- "offline": 0,
- "name": "us-de-newcastle"
- }
- ]
- },
- }
-
-|
-
-**GET /api/1.2/cdns/usage/overview**
-
- Retrieves the high-level CDN usage metrics.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``currentGbps`` | number | |
- +----------------------+--------+------------------------------------------------+
- |``tps`` | int | |
- +----------------------+--------+------------------------------------------------+
- |``maxGbps`` | int | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "currentGbps": 149.368167,
- "tps": 36805,
- "maxGbps": 3961
- }
- }
-
-|
-
-**GET /api/1.2/cdns/capacity**
-
- Retrieves the aggregate capacity percentages of all locations (cache groups) for a given CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``availablePercent`` | number | |
- +----------------------+--------+------------------------------------------------+
- |``unavailablePercent``| number | |
- +----------------------+--------+------------------------------------------------+
- |``utilizedPercent`` | number | |
- +----------------------+--------+------------------------------------------------+
- |``maintenancePercent``| number | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "availablePercent": 89.0939840205533,
- "unavailablePercent": 0,
- "utilizedPercent": 10.9060020300395,
- "maintenancePercent": 0.0000139494071146245
- }
- }
-
-|
-
-.. _to-api-v12-cdn-routing:
-
-Routing
-+++++++
-
-**GET /api/1.2/cdns/routing**
-
- Retrieves the aggregate routing percentages of all locations (cache groups) for a given CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------+--------+-----------------------------------------+
- | Parameter | Type | Description |
- +=================+========+=========================================+
- | ``staticRoute`` | number | Used pre-configured DNS entries. |
- +-----------------+--------+-----------------------------------------+
- | ``miss`` | number | No location available for client IP. |
- +-----------------+--------+-----------------------------------------+
- | ``geo`` | number | Used 3rd party geo-IP mapping. |
- +-----------------+--------+-----------------------------------------+
- | ``err`` | number | Error localizing client IP. |
- +-----------------+--------+-----------------------------------------+
- | ``cz`` | number | Used Coverage Zone geo-IP mapping. |
- +-----------------+--------+-----------------------------------------+
- | ``dsr`` | number | Overflow traffic sent to secondary CDN. |
- +-----------------+--------+-----------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "staticRoute": 0,
- "miss": 0,
- "geo": 37.8855391018869,
- "err": 0,
- "cz": 62.1144608981131,
- "dsr": 0
- }
- }
-
-|
-
-.. _to-api-v12-cdn-metrics:
-
-Metrics
-+++++++
-
-**GET /api/1.2/cdns/metric_types/:metric/start_date/:start/end_date/:end**
-
- Retrieves edge metrics of one or all locations (cache groups).
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------+
- | Name | Required | Description |
- +=================+==========+===========================+
- | ``metric_type`` | yes | ooff, origin_tps |
- +-----------------+----------+---------------------------+
- | ``start`` | yes | UNIX time, yesterday, now |
- +-----------------+----------+---------------------------+
- | ``end`` | yes | UNIX time, yesterday, now |
- +-----------------+----------+---------------------------+
-
- **Response Properties**
-
- +---------------------+--------+-------------+
- | Parameter | Type | Description |
- +=====================+========+=============+
- | ``stats`` | hash | |
- +---------------------+--------+-------------+
- | ``>count`` | string | |
- +---------------------+--------+-------------+
- | ``>98thPercentile`` | string | |
- +---------------------+--------+-------------+
- | ``>min`` | string | |
- +---------------------+--------+-------------+
- | ``>max`` | string | |
- +---------------------+--------+-------------+
- | ``>5thPercentile`` | string | |
- +---------------------+--------+-------------+
- | ``>95thPercentile`` | string | |
- +---------------------+--------+-------------+
- | ``>mean`` | string | |
- +---------------------+--------+-------------+
- | ``>sum`` | string | |
- +---------------------+--------+-------------+
- | ``data`` | array | |
- +---------------------+--------+-------------+
- | ``>time`` | int | |
- +---------------------+--------+-------------+
- | ``>value`` | number | |
- +---------------------+--------+-------------+
- | ``label`` | string | |
- +---------------------+--------+-------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "stats": {
- "count": 1,
- "98thPercentile": 1668.03,
- "min": 1668.03,
- "max": 1668.03,
- "5thPercentile": 1668.03,
- "95thPercentile": 1668.03,
- "mean": 1668.03,
- "sum": 1668.03
- },
- "data": [
- [
- 1425135900000,
- 1668.03
- ],
- [
- 1425136200000,
- null
- ]
- ],
- "label": "Origin TPS"
- }
- ],
- }
-
-|
-
-.. _to-api-v12-cdn-domains:
-
-Domains
-+++++++
-
-**GET /api/1.2/cdns/domains**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``profileId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``parameterId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``profileName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``profileDescription``| string | |
- +----------------------+--------+------------------------------------------------+
- |``domainName`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "profileId": "5",
- "parameterId": "404",
- "profileName": "CR_FOO",
- "profileDescription": "Content Router for foo.domain.net",
- "domainName": "foo.domain.net"
- },
- {
- "profileId": "8",
- "parameterId": "405",
- "profileName": "CR_BAR",
- "profileDescription": "Content Router for bar.domain.net",
- "domainName": "bar.domain.net"
- }
- ],
- }
-
-|
-
-.. _to-api-v12-cdn-topology:
-
-Topology
-++++++++
-
-**GET /api/1.2/cdns/:cdn_name/configs**
-
- Retrieves CDN config information.
-
- Authentication Required: Yes
-
- **Request Route Parameters**
-
- +--------------+----------+-----------------------+
- | Name | Required | Description |
- +==============+==========+=======================+
- | ``cdn_name`` | yes | Your cdn name or, all |
- +--------------+----------+-----------------------+
-
- **Response Properties**
-
- +-----------------------+--------+-----------------------------------------------+
- | Parameter | Type | Description |
- +=======================+========+===============================================+
- |``id`` | string | |
- +-----------------------+--------+-----------------------------------------------+
- |``value`` | string | |
- +-----------------------+--------+-----------------------------------------------+
- |``name`` | string | |
- +-----------------------+--------+-----------------------------------------------+
- |``config_file`` | string | |
- +-----------------------+--------+-----------------------------------------------+
-
- **Response Example** ::
-
- TBD
-
-|
-
-**GET /api/1.2/cdns/:name/configs/monitoring**
-
- Retrieves CDN monitoring information.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------+----------+-------------+
- | Name | Required | Description |
- +==========+==========+=============+
- | ``name`` | yes | CDN name |
- +----------+----------+-------------+
-
- **Response Properties**
-
- +-------------------------------------------------+--------+--------------------+
- | Parameter | Type | Description |
- +=================================================+========+====================+
- | ``trafficServers`` | array | A collection of |
- | | | Traffic Servers. |
- +-------------------------------------------------+--------+--------------------+
- | ``>profile`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>ip`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>status`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>cacheGroup`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>ip6`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>port`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>hostName`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>interfaceName`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>type`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>hashId`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``cacheGroups`` | array | A collection of |
- | | | cache groups. |
- +-------------------------------------------------+--------+--------------------+
- | ``>coordinates`` | hash | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>longitude`` | number | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>latitude`` | number | |
- +-------------------------------------------------+--------+--------------------+
- | ``>name`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``config`` | hash | |
- +-------------------------------------------------+--------+--------------------+
- | ``>hack.ttl`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>tm.healthParams.polling.url`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>tm.dataServer.polling.url`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>health.timepad`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>tm.polling.interval`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>health.threadPool`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>health.polling.interval`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>health.event-count`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>tm.crConfig.polling.url`` | number | |
- +-------------------------------------------------+--------+--------------------+
- | ``>CDN_name`` | number | |
- +-------------------------------------------------+--------+--------------------+
- | ``trafficMonitors`` | array | A collection of |
- | | | Traffic Monitors. |
- +-------------------------------------------------+--------+--------------------+
- | ``>profile`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>location`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>ip`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>status`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>ip6`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>port`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>hostName`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``deliveryServices`` | array | A collection of |
- | | | delivery services. |
- +-------------------------------------------------+--------+--------------------+
- | ``>xmlId`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>totalTpsThreshold`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>status`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>totalKbpsThreshold`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``profiles`` | array | A collection of |
- | | | profiles. |
- +-------------------------------------------------+--------+--------------------+
- | ``>parameters`` | hash | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.connection.timeout`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.polling.url`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.threshold.queryTime`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>history.count`` | int | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.threshold.availableBandwidthInKbps`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>>health.threshold.loadavg`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>name`` | string | |
- +-------------------------------------------------+--------+--------------------+
- | ``>type`` | string | |
- +-------------------------------------------------+--------+--------------------+
-
- **Response Example**
- ::
-
- TBD
-
-|
-
-**GET /api/1.2/cdns/:name/configs/routing**
-
- Retrieves CDN routing information.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------+----------+-------------+
- | Name | Required | Description |
- +==========+==========+=============+
- | ``name`` | yes | |
- +----------+----------+-------------+
-
- **Response Properties**
-
- +-------------------------------------+---------+-----------------------------------+
- | Parameter | Type | Description |
- +=====================================+=========+===================================+
- | ``trafficServers`` | array | A collection of Traffic Servers. |
- +-------------------------------------+---------+-----------------------------------+
- | ``>profile`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>status`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>cacheGroup`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip6`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>port`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>deliveryServices`` | array | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>xmlId`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>remaps`` | array | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>hostName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>interfaceName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>type`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>hashId`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``stats`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>trafficOpsPath`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>cdnName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>trafficOpsVersion`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>trafficOpsUser`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>date`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>trafficOpsHost`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``cacheGroups`` | array | A collection of cache groups. |
- +-------------------------------------+---------+-----------------------------------+
- | ``>coordinates`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>longitude`` | number | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>latitude`` | number | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>name`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``config`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.admin`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tcoveragezone.polling.interval`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geolocation.polling.interval`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.expire`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>coveragezone.polling.url`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.minimum`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geolocation.polling.url`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>domain_name`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.ttls.AAAA`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.refresh`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.ttls.NS`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.ttls.SOA`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geolocation6.polling.interval`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.ttls.A`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>tld.soa.retry`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geolocation6.polling.url`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``trafficMonitors`` | array | A collection of Traffic Monitors. |
- +-------------------------------------+---------+-----------------------------------+
- | ``>profile`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>location`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>status`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip6`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>port`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>hostName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``deliveryServices`` | array | A collection of delivery |
- | | | services. |
- +-------------------------------------+---------+-----------------------------------+
- | ``>xmlId`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ttl`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>geoEnabled`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>coverageZoneOnly`` | boolean | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>matchSets`` | array | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>protocol`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>matchList`` | array | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>>regex`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>>matchType`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>bypassDestination`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>maxDnsIpsForLocation`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>ttl`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>type`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ttls`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>A`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>SOA`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>NS`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>AAAA`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>missCoordinates`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>longitude`` | number | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>latitude`` | number | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>soa`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>admin`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>retry`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>minimum`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>refresh`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>>expire`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``trafficRouters`` | hash | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>profile`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>location`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>status`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>ip6`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>port`` | int | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>hostName`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>fqdn`` | string | |
- +-------------------------------------+---------+-----------------------------------+
- | ``>apiPort`` | int | |
- +-------------------------------------+---------+-----------------------------------+
-
-**Response Example**
-::
-
- TBD
-
-|
-
-
-.. _to-api-v12-cdn-dnsseckeys:
-
-DNSSEC Keys
-+++++++++++
-
-**GET /api/1.2/cdns/name/:name/dnsseckeys**
-
- Gets a list of dnsseckeys for a CDN and all associated Delivery Services.
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Route Parameters**
-
- +----------+----------+-------------+
- | Name | Required | Description |
- +==========+==========+=============+
- | ``name`` | yes | |
- +----------+----------+-------------+
-
- **Response Properties**
-
- +-------------------------------+--------+---------------------------------------------------------------+
- | Parameter | Type | Description |
- +===============================+========+===============================================================+
- | ``cdn name/ds xml_id`` | string | identifier for ds or cdn |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``>zsk/ksk`` | array | collection of zsk/ksk data |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``>>ttl`` | string | time-to-live for dnssec requests |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``>>inceptionDate`` | string | epoch timestamp for when the keys were created |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``>>expirationDate`` | string | epoch timestamp representing the expiration of the keys |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``>>private`` | string | encoded private key |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``>>public`` | string | encoded public key |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``>>name`` | string | domain name |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``version`` | string | API version |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``ksk>>dsRecord>>algorithm`` | string | The algorithm of the referenced DNSKEY-recor. |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``ksk>>dsRecord>>digestType`` | string | Cryptographic hash algorithm used to create the Digest value. |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``ksk>>dsRecord>>digest`` | string | A cryptographic hash value of the referenced DNSKEY-record. |
- +-------------------------------+--------+---------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "cdn1": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "foo.kabletown.com."
- },
- "ksk": {
- "name": "foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750",
- "ttl": "60",
- dsRecord: {
- "algorithm": "5",
- "digestType": "2",
- "digest": "abc123def456"
- }
- }
- },
- "ds-01": {
- "zsk": {
- "ttl": "60",
- "inceptionDate": "1426196750",
- "private": "zsk private key",
- "public": "zsk public key",
- "expirationDate": "1428788750",
- "name": "ds-01.foo.kabletown.com."
- },
- "ksk": {
- "name": "ds-01.foo.kabletown.com.",
- "expirationDate": "1457732750",
- "public": "ksk public key",
- "private": "ksk private key",
- "inceptionDate": "1426196750"
- }
- },
- ... repeated for each ds in the cdn
- },
- }
-
-
-|
-
-**GET /api/1.2/cdns/name/:name/dnsseckeys/delete**
-
- Delete dnssec keys for a cdn and all associated delivery services.
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Route Parameters**
-
- +----------+----------+----------------------------------------------------------+
- | Name | Required | Description |
- +==========+==========+==========================================================+
- | ``name`` | yes | name of the CDN for which you want to delete dnssec keys |
- +----------+----------+----------------------------------------------------------+
-
- **Response Properties**
-
- +--------------+--------+------------------+
- | Parameter | Type | Description |
- +==============+========+==================+
- | ``response`` | string | success response |
- +--------------+--------+------------------+
-
- **Response Example**
- ::
-
- {
- "response": "Successfully deleted dnssec keys for <cdn>"
- }
-
-|
-
-**POST /api/1.2/deliveryservices/dnsseckeys/generate**
-
- Generates ZSK and KSK keypairs for a CDN and all associated Delivery Services.
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Properties**
-
- +-----------------------+---------+------------------------------------------------+
- | Parameter | Type | Description |
- +=======================+=========+================================================+
- | ``key`` | string | name of the cdn |
- +-----------------------+---------+------------------------------------------------+
- | ``name`` | string | domain name of the cdn |
- +-----------------------+---------+------------------------------------------------+
- | ``ttl`` | string | time to live |
- +-----------------------+---------+------------------------------------------------+
- | ``kskExpirationDays`` | string | Expiration (in days) for the key signing keys |
- +-----------------------+---------+------------------------------------------------+
- | ``zskExpirationDays`` | string | Expiration (in days) for the zone signing keys |
- +-----------------------+---------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "key": "cdn1",
- "name" "ott.kabletown.com",
- "ttl": "60",
- "kskExpirationDays": "365",
- "zskExpirationDays": "90"
- }
-
- **Response Properties**
-
- +--------------+--------+-----------------+
- | Parameter | Type | Description |
- +==============+========+=================+
- | ``response`` | string | response string |
- +--------------+--------+-----------------+
- | ``version`` | string | API version |
- +--------------+--------+-----------------+
-
- **Response Example** ::
-
-
- {
- "response": "Successfully created dnssec keys for cdn1"
- }
-
-.. _to-api-v12-cdn-sslkeys:
-
-SSL Keys
-+++++++++++
-
-**GET /api/1.2/cdns/name/:name/sslkeys**
-
- Returns ssl certificates for all Delivery Services that are a part of the CDN.
-
- Authentication Required: Yes
-
- Role(s) Required: Admin
-
- **Request Route Parameters**
-
- +----------+----------+-------------+
- | Name | Required | Description |
- +==========+==========+=============+
- | ``name`` | yes | |
- +----------+----------+-------------+
-
- **Response Properties**
-
- +-------------------------------+--------+---------------------------------------------------------------+
- | Parameter | Type | Description |
- +===============================+========+===============================================================+
- | ``deliveryservice`` | string | identifier for deliveryservice xml_id |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``certificate`` | array | collection of certificate |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``>>key`` | string | base64 encoded private key for ssl certificate |
- +-------------------------------+--------+---------------------------------------------------------------+
- | ``>>crt`` | string | base64 encoded ssl certificate |
- +-------------------------------+--------+---------------------------------------------------------------+
-
-
- **Response Example** ::
-
- {
- "response": [
- {
- "deliveryservice": "ds1",
- "certificate": {
- "crt": "base64encodedcrt1",
- "key": "base64encodedkey1"
- }
- },
- {
- "deliveryservice": "ds2",
- "certificate": {
- "crt": "base64encodedcrt2",
- "key": "base64encodedkey2"
- }
- }
- ]
- }
-|
-
[34/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.txt b/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.txt
new file mode 100644
index 0000000..5ed2654
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.txt
@@ -0,0 +1,210 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-ext:
+
+TO Extensions
+=============
+
+.. _to-api-v11-ext-route:
+
+/api/1.1/to_extensions
+++++++++++++++++++++++
+
+**GET /api/1.1/to_extensions.json**
+
+Retrieves the list of extensions.
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+**Response Properties**
+
++--------------------------+--------+--------------------------------------------+
+| Parameter | Type | Description |
++==========================+========+============================================+
+|``script_file`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``version`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``name`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``description`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``info_url`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``additional_config_json``| string | |
++--------------------------+--------+--------------------------------------------+
+|``isactive`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``id`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``type`` | string | |
++--------------------------+--------+--------------------------------------------+
+|``servercheck_short_name``| string | |
++--------------------------+--------+--------------------------------------------+
+
+**Response Example** ::
+
+ {
+ "response": [
+ {
+ script_file: "ping",
+ version: "1.0.0",
+ name: "ILO_PING",
+ description: null,
+ info_url: "http://foo.com/bar.html",
+ additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
+ isactive: "1",
+ id: "1",
+ type: "CHECK_EXTENSION_BOOL",
+ servercheck_short_name: "ILO"
+ },
+ {
+ script_file: "ping",
+ version: "1.0.0",
+ name: "10G_PING",
+ description: null,
+ info_url: "http://foo.com/bar.html",
+ additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
+ isactive: "1",
+ id: "2",
+ type: "CHECK_EXTENSION_BOOL",
+ servercheck_short_name: "10G"
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/to_extensions**
+
+ Creates a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Parameters**
+
+ +--------------------------+--------+--------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+============================================+
+ |``name`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``version`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``info_url`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``script_file`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``isactive`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``additional_config_json``| string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``description`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``servercheck_short_name``| string | |
+ +--------------------------+--------+--------------------------------------------+
+ |``type`` | string | |
+ +--------------------------+--------+--------------------------------------------+
+
+ **Request Example** ::
+
+
+ {
+ "name": "ILO_PING",
+ "version": "1.0.0",
+ "info_url": "http://foo.com/bar.html",
+ "script_file": "ping",
+ "isactive": "1",
+ "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}",
+ "description": null,
+ "servercheck_short_name": "ILO"
+ "type": "CHECK_EXTENSION_BOOL",
+ }
+
+|
+
+ **Response Properties**
+
+ +------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Check Extension loaded."
+ }
+ ],
+ }
+
+
+|
+
+**POST /api/1.1/to_extensions/:id/delete**
+
+ Deletes a Traffic Ops extension.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +--------+----------+-----------------+
+ | Name | Required | Description |
+ +========+==========+=================+
+ | ``id`` | yes | TO extension id |
+ +--------+----------+-----------------+
+
+ **Response Properties**
+
+ +------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Extension deleted."
+ }
+ ],
+ }
+
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/type.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/type.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/type.rst.txt
deleted file mode 100644
index 6c7806b..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/type.rst.txt
+++ /dev/null
@@ -1,151 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-type:
-
-Types
-=====
-
-.. _to-api-v11-types-route:
-
-/api/1.1/types
-++++++++++++++
-
-**GET /api/1.1/types**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +----------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +================+==========+====================================================+
- | ``useInTable`` | no | Filter types by the table in which they apply |
- +----------------+----------+----------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``description`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "22",
- "name": "AAAA_RECORD",
- "description": "Static DNS AAAA entry",
- "useInTable": "staticdnsentry",
- "lastUpdated": "2013-10-23 15:28:31"
- }
- ]
- }
-
-
-|
-
-**GET /api/1.1/types/trimmed**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "AAAA_RECORD"
- },
- {
- "name": "ACTIVE_DIRECTORY"
- },
- {
- "name": "A_RECORD"
- },
- {
- "name": "CCR"
- }
- ],
- }
-
-**GET /api/1.1/types/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +================+==========+====================================================+
- | ``id`` | yes | Type ID. |
- +----------------+----------+----------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``description`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``useInTable`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "22",
- "name": "AAAA_RECORD",
- "description": "Static DNS AAAA entry",
- "useInTable": "staticdnsentry",
- "lastUpdated": "2013-10-23 15:28:31"
- }
- ]
- }
-
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/type.txt b/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
new file mode 100644
index 0000000..6c7806b
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v11/type.txt
@@ -0,0 +1,151 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v11-type:
+
+Types
+=====
+
+.. _to-api-v11-types-route:
+
+/api/1.1/types
+++++++++++++++
+
+**GET /api/1.1/types**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``useInTable`` | no | Filter types by the table in which they apply |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
+
+**GET /api/1.1/types/trimmed**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "AAAA_RECORD"
+ },
+ {
+ "name": "ACTIVE_DIRECTORY"
+ },
+ {
+ "name": "A_RECORD"
+ },
+ {
+ "name": "CCR"
+ }
+ ],
+ }
+
+**GET /api/1.1/types/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+----------------------------------------------------+
+ | Name | Required | Description |
+ +================+==========+====================================================+
+ | ``id`` | yes | Type ID. |
+ +----------------+----------+----------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``description`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``useInTable`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "22",
+ "name": "AAAA_RECORD",
+ "description": "Static DNS AAAA entry",
+ "useInTable": "staticdnsentry",
+ "lastUpdated": "2013-10-23 15:28:31"
+ }
+ ]
+ }
+
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v11/user.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/user.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/user.rst.txt
deleted file mode 100644
index 2ef5012..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v11/user.rst.txt
+++ /dev/null
@@ -1,778 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v11-users:
-
-Users
-=====
-
-.. _to-api-v11-users-route:
-
-/api/1.1/users
-++++++++++++++
-
-**GET /api/1.1/users**
-
- Retrieves all users.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | hash | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``publicSshKey`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``registrationSent`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``roleName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "addressLine1": "",
- "addressLine2": "",
- "city": "",
- "company": "",
- "country": "",
- "email": "email1@email.com",
- "fullName": "Tom Simpson",
- "gid": "0",
- "id": "53",
- "lastUpdated": "2016-01-26 10:22:07",
- "newUser": true,
- "phoneNumber": "",
- "postalCode": "",
- "publicSshKey": "xxx",
- "registrationSent": true,
- "role": "6",
- "rolename": "admin",
- "stateOrProvince": "",
- "uid": "0",
- "username": "tsimpson"
- },
- {
- ... more users
- },
- ]
- }
-
-|
-
-
-**GET /api/1.1/users/:id**
-
- Retrieves user by ID.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | User id. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | hash | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``publicSshKey`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``registrationSent`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``roleName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "addressLine1": "",
- "addressLine2": "",
- "city": "",
- "company": "",
- "country": "",
- "email": "email1@email.com",
- "fullName": "Tom Simpson",
- "gid": "0",
- "id": "53",
- "lastUpdated": "2016-01-26 10:22:07",
- "newUser": true,
- "phoneNumber": "",
- "postalCode": "",
- "publicSshKey": "xxx",
- "registrationSent": true,
- "role": "6",
- "rolename": "admin",
- "stateOrProvince": "",
- "uid": "0",
- "username": "tsimpson"
- }
- ]
- }
-
-|
-
-
-**GET /api/1.1/user/current**
-
- Retrieves the profile for the authenticated user.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``localUser`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "email": "email@email.com",
- "city": "",
- "id": "50",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "Tom Callahan",
- "localUser": true,
- "uid": "0",
- "stateOrProvince": "",
- "username": "tommyboy",
- "newUser": false,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "gid": "0",
- "postalCode": ""
- },
- }
-
-|
-
-**POST /api/1.1/user/current/update**
-
- Updates the date for the authenticated user.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phoneNumber`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``company`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``country`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``fullName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``localUser`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``uid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``stateOrProvince`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``newUser`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``addressLine2`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``role`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``addressLine1`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``gid`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``postalCode`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "user": {
- "email": "",
- "city": "",
- "id": "",
- "phoneNumber": "",
- "company": "",
- "country": "",
- "fullName": "",
- "localUser": true,
- "uid": "0",
- "stateOrProvince": "",
- "username": "tommyboy",
- "newUser": false,
- "addressLine2": "",
- "role": "6",
- "addressLine1": "",
- "gid": "0",
- "postalCode": ""
- }
- }
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "UserProfile was successfully updated."
- }
- ],
- }
-
-|
-
-**GET /api/1.1/user/current/jobs.json**
-
- Retrieves the user's list of jobs.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +--------------+----------+----------------------------------------+
- | Name | Required | Description |
- +==============+==========+========================================+
- | ``keyword`` | no | PURGE |
- +--------------+----------+----------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``keyword`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``objectName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``assetUrl`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``assetType`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``status`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``dsId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``dsXmlId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``username`` | boolean| |
- +----------------------+--------+------------------------------------------------+
- |``parameters`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``enteredTime`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``objectType`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``agent`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``startTime`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``version`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example**
- ::
-
- {
- "response": [
- {
- "id": "1",
- "keyword": "PURGE",
- "objectName": null,
- "assetUrl": "",
- "assetType": "file",
- "status": "PENDING",
- "dsId": "9999",
- "dsXmlId": "ds-xml-id",
- "username": "peewee",
- "parameters": "TTL:56h",
- "enteredTime": "2015-01-21 18:00:16",
- "objectType": null,
- "agent": "",
- "startTime": "2015-01-21 10:45:38"
- }
- ],
- }
-
-
-|
-
-**POST/api/1.1/user/current/jobs**
-
-Invalidating content on the CDN is sometimes necessary when the origin was mis-configured and something is cached in the CDN that needs to be removed. Given the size of a typical Traffic Control CDN and the amount of content that can be cached in it, removing the content from all the caches may take a long time. To speed up content invalidation, Traffic Ops will not try to remove the content from the caches, but it makes the content inaccessible using the *regex_revalidate* ATS plugin. This forces a *revalidation* of the content, rather than a new get.
-
-.. Note:: This method forces a HTTP *revalidation* of the content, and not a new *GET* - the origin needs to support revalidation according to the HTTP/1.1 specification, and send a ``200 OK`` or ``304 Not Modified`` as applicable.
-
-Authentication Required: Yes
-
-Role(s) Required: Yes
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``dsId`` | string | Unique Delivery Service ID |
- +----------------------+--------+------------------------------------------------+
- |``regex`` | string | Path Regex this should be a |
- | | | `PCRE <http://www.pcre.org/>`_ compatible |
- | | | regular expression for the path to match for |
- | | | forcing the revalidation. Be careful to only |
- | | | match on the content you need to remove - |
- | | | revalidation is an expensive operation for |
- | | | many origins, and a simple ``/.*`` can cause |
- | | | an overload condition of the origin. |
- +----------------------+--------+------------------------------------------------+
- |``startTime`` | string | Start Time is the time when the revalidation |
- | | | rule will be made active. Populate |
- | | | with the current time to schedule ASAP. |
- +----------------------+--------+------------------------------------------------+
- |``ttl`` | int | Time To Live is how long the revalidation rule |
- | | | will be active for in hours. It usually makes |
- | | | sense to make this the same as the |
- | | | ``Cache-Control`` header from the origin which |
- | | | sets the object time to live in cache |
- | | | (by ``max-age`` or ``Expires``). Entering a |
- | | | longer TTL here will make the caches do |
- | | | unnecessary work. |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "dsId": "9999",
- "regex": "/path/to/content.jpg",
- "startTime": "2015-01-27 11:08:37",
- "ttl": 54
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts":
- [
- {
- "level": "success",
- "text": "Successfully created purge job for: ."
- }
- ],
- }
-
-
-|
-
-**POST /api/1.1/user/login**
-
- Authentication of a user using username and password. Traffic Ops will send back a session cookie.
-
- Authentication Required: No
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``u`` | string | username |
- +----------------------+--------+------------------------------------------------+
- |``p`` | string | password |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "u": "username",
- "p": "password"
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Successfully logged in."
- }
- ],
- }
-
-|
-
-**GET /api/1.1/user/:id/deliveryservices/available.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- |id | yes | |
- +-----------------+----------+---------------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``xmlId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "xmlId": "ns-img",
- "id": "90"
- },
- {
- "xmlId": "ns-img-secure",
- "id": "280"
- }
- ],
- }
-
-|
-
-**POST /api/1.1/user/login/token**
-
- Authentication of a user using a token.
-
- Authentication Required: No
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``t`` | string | token-value |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "t": "token-value"
- }
-
-|
-
- **Response Properties**
-
- +-------------+--------+-------------+
- | Parameter | Type | Description |
- +=============+========+=============+
- | ``alerts`` | array | |
- +-------------+--------+-------------+
- | ``>level`` | string | |
- +-------------+--------+-------------+
- | ``>text`` | string | |
- +-------------+--------+-------------+
- | ``version`` | string | |
- +-------------+--------+-------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "error",
- "text": "Unauthorized, please log in."
- }
- ],
- }
-
-|
-
-**POST /api/1.1/user/logout**
-
- User logout. Invalidates the session cookie.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``alerts`` | array | |
- +----------------------+--------+------------------------------------------------+
- |* ``level`` | string | |
- +----------------------+--------+------------------------------------------------+
- |* ``text`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``version`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example**
-
- ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "You are logged out."
- }
- ],
- }
-
-
-|
-
-**POST /api/1.1/user/reset_password**
-
- Reset user password.
-
- Authentication Required: No
-
- Role(s) Required: None
-
- **Request Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``email`` | string | The email address of the user to initiate |
- | | | password reset. |
- +----------------------+--------+------------------------------------------------+
-
- **Request Example**
- ::
-
- {
- "email": "email@email.com"
- }
-
-|
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``alerts`` | array | A collection of alert messages. |
- +----------------------+--------+------------------------------------------------+
- |* ``level`` | string | Success, info, warning or error. |
- +----------------------+--------+------------------------------------------------+
- |* ``text`` | string | Alert message. |
- +----------------------+--------+------------------------------------------------+
- |``version`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
-
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Successfully sent password reset to email 'email@email.com'"
- }
- ],
- }
-
-
[28/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
new file mode 100644
index 0000000..379ea37
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice.txt
@@ -0,0 +1,1756 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v12-ds:
+
+Delivery Service
+================
+
+.. _to-api-v12-ds-route:
+
+/api/1.2/deliveryservices
++++++++++++++++++++++++++
+
+**GET /api/1.2/deliveryservices**
+
+ Retrieves all delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ { .. },
+ { .. }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/deliveryservices/:id**
+
+ Retrieves a specific delivery service. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+======================================================================================================================================+
+ | ``active`` | bool | true if active, false if inactive. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cacheurl`` | string | Cache URL rule to apply to this delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ccrDnsTtl`` | string | The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnId`` | string | Id of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``cdnName`` | string | Name of the CDN to which the delivery service belongs to. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``checkPath`` | string | The path portion of the URL to check this deliveryservice for health. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``displayName`` | string | The display name of the delivery service. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp`` | string | The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassIp6`` | string | The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dnsBypassTtl`` | string | The TTL of the DNS bypass response. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``dscp`` | string | The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``edgeHeaderRewrite`` | string | The EDGE header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``exampleURLs`` | array | Entry points into the CDN for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitRedirectUrl`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimit`` | string | - 0: None - no limitations |
+ | | | - 1: Only route on CZF file hit |
+ | | | - 2: Only route on CZF hit or when from USA |
+ | | | |
+ | | | Note that this does not prevent access to content or makes content secure; it just prevents |
+ | | | routing to the content by Traffic Router. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoLimitCountries`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``geoProvider`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxMbps`` | string | The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
+ | | | dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``globalMaxTps`` | string | The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
+ | | | traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
+ | | | HTTP deliveryservices |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``httpBypassFqdn`` | string | The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
+ | | | globalMaxMbps traffic on this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``id`` | string | The deliveryservice id (database row number). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``infoUrl`` | string | Use this to add a URL that points to more information about that deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``initialDispersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``ipv6RoutingEnabled`` | bool | false: send IPv4 address of Traffic Router to client on HTTP type del. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``lastUpdated`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``logsEnabled`` | bool | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc`` | string | Description field 1. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc1`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``longDesc2`` | string | Description field 2. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``matchList`` | array | Array of matchList hashes. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>type`` | string | The type of MatchList (one of :ref:to-api-v11-types use_in_table='regex'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>setNumber`` | string | The set Number of the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``>>pattern`` | string | The regexp for the matchList. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``maxDnsAnswers`` | string | The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
+ | | | available). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``midHeaderRewrite`` | string | The MID header rewrite actions to perform. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLat`` | string | The latitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``missLong`` | string | The longitude to use when the client cannot be found in the CZF or the Geo lookup. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOrigin`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``multiSiteOriginAlgor`` | bool | Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See :ref:`rl-multi-site-origin` |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``orgServerFqdn`` | string | The origin server base URL (FQDN when used in this instance, includes the |
+ | | | protocol (http:// or https://) for use in retrieving content from the origin server. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``originShield`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileDescription`` | string | The description of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileId`` | string | The id of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``profileName`` | string | The name of the Traffic Router Profile with which this deliveryservice is associated. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``protocol`` | string | - 0: serve with http:// at EDGE |
+ | | | - 1: serve with https:// at EDGE |
+ | | | - 2: serve with both http:// and https:// at EDGE |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``qstringIgnore`` | string | - 0: no special query string handling; it is for use in the cache-key and pass up to origin. |
+ | | | - 1: ignore query string in cache-key, but pass it up to parent and or origin. |
+ | | | - 2: drop query string at edge, and do not use it in the cache-key. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``rangeRequestHandling`` | string | How to treat range requests: |
+ | | | |
+ | | | - 0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT) |
+ | | | - 1 Use the `background_fetch <https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html>`_ plugin. |
+ | | | - 2 Use the cache_range_requests plugin. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regexRemap`` | string | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalGeoBlocking`` | bool | Regex Remap rule to apply to this delivery service at the Edge tier. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``remapText`` | string | Additional raw remap line text. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``signed`` | bool | - false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice. |
+ | | | - true: token based auth is enabled for this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``sslKeyVersion`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trRequestHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``trResponseHeaders`` | string | |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``type`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``typeId`` | string | The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table='deliveryservice'). |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+ | ``xmlId`` | string | Unique string that describes this deliveryservice. |
+ +--------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "active": true,
+ "cacheurl": null,
+ "ccrDnsTtl": "3600",
+ "cdnId": "2",
+ "cdnName": "over-the-top",
+ "checkPath": "",
+ "displayName": "My Cool Delivery Service",
+ "dnsBypassCname": "",
+ "dnsBypassIp": "",
+ "dnsBypassIp6": "",
+ "dnsBypassTtl": "30",
+ "dscp": "40",
+ "edgeHeaderRewrite": null,
+ "exampleURLs": [
+ "http://edge.foo-ds.foo.bar.net"
+ ],
+ "geoLimit": "0",
+ "geoLimitCountries": null,
+ "geoLimitRedirectURL": null,
+ "geoProvider": "0",
+ "globalMaxMbps": null,
+ "globalMaxTps": "0",
+ "httpBypassFqdn": "",
+ "id": "442",
+ "infoUrl": "",
+ "initialDispersion": "1",
+ "ipv6RoutingEnabled": true,
+ "lastUpdated": "2016-01-26 08:49:35",
+ "logsEnabled": false,
+ "longDesc": "",
+ "longDesc1": "",
+ "longDesc2": "",
+ "matchList": [
+ {
+ "pattern": ".*\\.foo-ds\\..*",
+ "setNumber": "0",
+ "type": "HOST_REGEXP"
+ }
+ ],
+ "maxDnsAnswers": "0",
+ "midHeaderRewrite": null,
+ "missLat": "41.881944",
+ "missLong": "-87.627778",
+ "multiSiteOrigin": false,
+ "multiSiteOriginAlgorithm": null,
+ "orgServerFqdn": "http://baz.boo.net",
+ "originShield": null,
+ "profileDescription": "Content Router for over-the-top",
+ "profileId": "5",
+ "profileName": "ROUTER_TOP",
+ "protocol": "0",
+ "qstringIgnore": "1",
+ "rangeRequestHandling": "0",
+ "regexRemap": null,
+ "regionalGeoBlocking": false,
+ "remapText": null,
+ "signed": false,
+ "sslKeyVersion": "0",
+ "trRequestHeaders": null,
+ "trResponseHeaders": "Access-Control-Allow-Origin: *",
+ "type": "HTTP",
+ "typeId": "8",
+ "xmlId": "foo-ds"
+ }
+ ]
+ }
+
+|
+
+
+.. _to-api-v12-ds-health:
+
+Health
+++++++
+
+**GET /api/1.2/deliveryservices/:id/state**
+
+ Retrieves the failover state for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+---------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+=================================================+
+ | ``failover`` | hash | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>locations`` | array | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>destination`` | hash | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>>location`` | string | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>>type`` | string | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>configured`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+ | ``>enabled`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+ | ``enabled`` | boolean | |
+ +------------------+---------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "failover": {
+ "locations": [ ],
+ "destination": {
+ "location": null,
+ "type": "DNS",
+ },
+ "configured": false,
+ "enabled": false
+ },
+ "enabled": true
+ }
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/:id/health**
+
+ Retrieves the health of all locations (cache groups) for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=================================================+
+ | ``totalOnline`` | int | Total number of online caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``totalOffline`` | int | Total number of offline caches across all CDNs. |
+ +------------------+--------+-------------------------------------------------+
+ | ``cachegroups`` | array | A collection of cache groups. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>online`` | int | The number of online caches for the cache group |
+ +------------------+--------+-------------------------------------------------+
+ | ``>offline`` | int | The number of offline caches for the cache |
+ | | | group. |
+ +------------------+--------+-------------------------------------------------+
+ | ``>name`` | string | Cache group name. |
+ +------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "totalOnline": 148,
+ "totalOffline": 0,
+ "cachegroups": [
+ {
+ "online": 8,
+ "offline": 0,
+ "name": "us-co-denver"
+ },
+ {
+ "online": 7,
+ "offline": 0,
+ "name": "us-de-newcastle"
+ }
+ ]
+ }
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/:id/capacity**
+
+ Retrieves the capacity percentages of a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +========================+========+===================================================+
+ | ``availablePercent`` | number | The percentage of server capacity assigned to |
+ | | | the delivery service that is available. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``unavailablePercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service that is unavailable. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``utilizedPercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service being used. |
+ +------------------------+--------+---------------------------------------------------+
+ | ``maintenancePercent`` | number | The percentage of server capacity assigned to the |
+ | | | delivery service that is down for maintenance. |
+ +------------------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "availablePercent": 89.0939840205533,
+ "unavailablePercent": 0,
+ "utilizedPercent": 10.9060020300395,
+ "maintenancePercent": 0.0000139494071146245
+ },
+ }
+
+
+|
+
+**GET /api/1.2/deliveryservices/:id/routing**
+
+ Retrieves the routing method percentages of a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================================+
+ |id | yes | delivery service id. |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Response Properties**
+
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==========================+========+=============================================================================================================================+
+ | ``staticRoute`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied with pre-configured DNS entries. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``miss`` | number | The percentage of Traffic Router responses for this deliveryservice that were a miss (no location available for client IP). |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``geo`` | number | The percentage of Traffic Router responses for this deliveryservice satisfied using 3rd party geo-IP mapping. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``err`` | number | The percentage of Traffic Router requests for this deliveryservice resulting in an error. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``cz`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by a CZF (coverage zone file) hit. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``dsr`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the |
+ | | | client to the overflow CDN. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``fed`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to a federated CDN. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalAlternate`` | number | The percentage of Traffic Router requests for this deliveryservice satisfied by sending the client to the alternate |
+ | | | regional geoblocking URL. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+ | ``regionalDenied`` | number | The percent of Traffic Router requests for this deliveryservice denied due to geolocation policy. |
+ +--------------------------+--------+-----------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "staticRoute": 0,
+ "miss": 0,
+ "geo": 37.8855391018869,
+ "err": 0,
+ "cz": 62.1144608981131,
+ "dsr": 0,
+ "fed": 0,
+ "regionalAlternate": 0,
+ "regionalDenied": 0
+ },
+ }
+
+
+.. _to-api-v12-ds-server:
+
+Server
+++++++
+
+**GET /api/1.2/deliveryserviceserver**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``page`` | no | The page number for use in pagination. |
+ +-----------+----------+----------------------------------------+
+ | ``limit`` | no | For use in limiting the result set. |
+ +-----------+----------+----------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``lastUpdated`` | array | |
+ +----------------------+--------+------------------------------------------------+
+ |``server`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``deliveryService`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "page": 2,
+ "orderby": "deliveryservice",
+ "response": [
+ {
+ "lastUpdated": "2014-09-26 17:53:43",
+ "server": "20",
+ "deliveryService": "1"
+ },
+ {
+ "lastUpdated": "2014-09-26 17:53:44",
+ "server": "21",
+ "deliveryService": "1"
+ },
+ ],
+ "limit": 2
+ }
+
+
+
+.. _to-api-v12-ds-sslkeys:
+
+SSL Keys
++++++++++
+
+**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys**
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "certificate": {
+ "crt": "crt",
+ "key": "key",
+ "csr": "csr"
+ },
+ "businessUnit": "CDN_Eng",
+ "city": "Denver",
+ "organization": "KableTown",
+ "hostname": "foober.com",
+ "country": "US",
+ "state": "Colorado",
+ "version": "1"
+ }
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/hostname/:hostname/sslkeys**
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Route Parameters**
+
+ +--------------+----------+---------------------------------------------------+
+ | Name | Required | Description |
+ +==============+==========+===================================================+
+ | ``hostname`` | yes | pristine hostname of the desired delivery service |
+ +--------------+----------+---------------------------------------------------+
+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+========+=========================================================================================================================================+
+ | ``crt`` | string | base64 encoded crt file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``csr`` | string | base64 encoded csr file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``key`` | string | base64 encoded private key file for delivery service |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``businessUnit`` | string | The business unit entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``city`` | string | The city entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``organization`` | string | The organization entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``hostname`` | string | The hostname entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``country`` | string | The country entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``state`` | string | The state entered by the user when generating certs. Field is optional and if not provided by the user will not be in response |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+ | ``version`` | string | The version of the certificate record in Riak |
+ +------------------+--------+-----------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "certificate": {
+ "crt": "crt",
+ "key": "key",
+ "csr": "csr"
+ },
+ "businessUnit": "CDN_Eng",
+ "city": "Denver",
+ "organization": "KableTown",
+ "hostname": "foober.com",
+ "country": "US",
+ "state": "Colorado",
+ "version": "1"
+ }
+ }
+
+|
+
+**GET /api/1.2/deliveryservices/xmlId/:xmlid/sslkeys/delete**
+
+ Authentication Required: Yes
+
+ Role Required: Admin
+
+ **Request Route Parameters**
+
+ +-----------+----------+----------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+========================================+
+ | ``xmlId`` | yes | xml_id of the desired delivery service |
+ +-----------+----------+----------------------------------------+
+
+ **Request Query Parameters**
+
+ +-------------+----------+--------------------------------+
+ | Name | Required | Description |
+ +=============+==========+================================+
+ | ``version`` | no | The version number to retrieve |
+ +-------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +--------------+--------+------------------+
+ | Parameter | Type | Description |
+ +==============+========+==================+
+ | ``response`` | string | success response |
+ +--------------+--------+------------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully deleted ssl keys for <xml_id>"
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/sslkeys/generate**
+
+ Generates SSL crt, csr, and private key for a delivery service
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Properties**
+
+ +--------------+---------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +==============+=========+=================================================+
+ | ``key`` | string | xml_id of the delivery service |
+ +--------------+---------+-------------------------------------------------+
+ | ``version`` | string | version of the keys being generated |
+ +--------------+---------+-------------------------------------------------+
+ | ``hostname`` | string | the *pristine hostname* of the delivery service |
+ +--------------+---------+-------------------------------------------------+
+ | ``country`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``state`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``city`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``org`` | string | |
+ +--------------+---------+-------------------------------------------------+
+ | ``unit`` | boolean | |
+ +--------------+---------+-------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "ds-01",
+ "businessUnit": "CDN Engineering",
+ "version": "3",
+ "hostname": "tr.ds-01.ott.kabletown.com",
+ "certificate": {
+ "key": "some_key",
+ "csr": "some_csr",
+ "crt": "some_crt"
+ },
+ "country": "US",
+ "organization": "Kabletown",
+ "city": "Denver",
+ "state": "Colorado"
+ }
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully created ssl keys for ds-01"
+ }
+
+|
+
+**POST /api/1.2/deliveryservices/sslkeys/add**
+
+ Allows user to add SSL crt, csr, and private key for a delivery service.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Admin
+
+ **Request Properties**
+
+ +-------------+--------+-------------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+=====================================+
+ | ``key`` | string | xml_id of the delivery service |
+ +-------------+--------+-------------------------------------+
+ | ``version`` | string | version of the keys being generated |
+ +-------------+--------+-------------------------------------+
+ | ``csr`` | string | |
+ +-------------+--------+-------------------------------------+
+ | ``crt`` | string | |
+ +-------------+--------+-------------------------------------+
+ | ``key`` | string | |
+ +-------------+--------+-------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "key": "ds-01",
+ "version": "1",
+ "certificate": {
+ "key": "some_key",
+ "csr": "some_csr",
+ "crt": "some_crt"
+ }
+ }
+
+|
+
+ **Response Properties**
+
+ +--------------+--------+-----------------+
+ | Parameter | Type | Description |
+ +==============+========+=================+
+ | ``response`` | string | response string |
+ +--------------+--------+-----------------+
+ | ``version`` | string | API version |
+ +--------------+--------+-----------------+
+
+ **Response Example** ::
+
+ {
+ "response": "Successfully added ssl keys for ds-01"
+ }
+
+**POST /api/1.2/deliveryservices/request**
+
+ Allows a user to send delivery service request details to a specified email address.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Properties**
+
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | Parameter | Type | Required | Description |
+ +========================================+========+==========+=============================================================================================+
+ | ``emailTo`` | string | yes | The email to which the delivery service request will be sent. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``details`` | hash | yes | Parameters for the delivery service request. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>customer`` | string | yes | Name of the customer to associated with the delivery service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>deliveryProtocol`` | string | yes | Eg. http or http/https |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>routingType`` | string | yes | Eg. DNS or HTTP Redirect |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>serviceDesc`` | string | yes | A description of the delivery service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>peakBPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>peakTPSEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>maxLibrarySizeEstimate`` | string | yes | Used to manage cache efficiency and plan for capacity. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>originURL`` | string | yes | The URL path to the origin server. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasOriginDynamicRemap`` | bool | yes | This is a feature which allows services to use multiple origin URLs for the same service. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>originTestFile`` | string | yes | A URL path to a test file available on the origin server. |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>hasOriginACLWhitelist`` | bool | yes | Is access to your origin restricted using an access control list (ACL or whitelist) of Ips? |
+ +----------------------------------------+--------+----------+---------------------------------------------------------------------------------------------+
+ | ``>originHeaders`` | string | no | Header values that must be passed to requests to your origin. |
+ +----------------------------------------+--------+----------+--------------------------------------------------------
<TRUNCATED>
[26/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
new file mode 100644
index 0000000..307d4c7
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.txt
@@ -0,0 +1,516 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-parameter:
+
+Parameter
+=========
+
+.. _to-api-v12-parameters-route:
+
+/api/1.2/parameters
++++++++++++++++++++
+
+**GET /api/1.2/parameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/parameters/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: if secure of the parameter fetched is 1, require admin role, or any valid role can access.
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter index |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": 0,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "id": "27",
+ "config_file": "FooConfig.xml",
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/profiles/:id/parameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``id`` | yes | Profile id |
+ +------------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**GET /api/1.2/profiles/name/:name/parameters**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +------------------+----------+-----------------------+
+ | Name | Required | Description |
+ +==================+==========+=======================+
+ | ``name`` | yes | Profile name |
+ +------------------+----------+-----------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``last_updated`` | string | The Time / Date this server entry was last updated |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "foo.bar.net",
+ "name": "domain_name",
+ "config_file": "FooConfig.xml"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": false,
+ "value": "0,1,2,3,4,5,6",
+ "name": "Drive_Letters",
+ "config_file": "storage.config"
+ },
+ {
+ "last_updated": "2012-09-17 21:41:22",
+ "secure": true,
+ "value": "STRING __HOSTNAME__",
+ "name": "CONFIG proxy.config.proxy_name",
+ "config_file": "records.config"
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/parameters**
+ Create parameters.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+ The request route parameters accept 2 formats, both single paramter and parameters array formats are acceptable.
+
+ single parameter format:
+
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+=========+======================================================================================+
+ | ``name`` | yes | string | parameter name |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ parameters array format:
+
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +=================+==========+=========+======================================================================================+
+ | | yes | array | parameters array |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | yes | string | parameter name |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | yes | string | parameter config_file |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | yes | string | parameter value |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+=========+======================================================================================+
+ | | array | parameters array |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>id`` | integer | The parameter id |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>name`` | string | parameter name |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>configFile`` | string | parameter config_file |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>value`` | string | parameter value |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+ | ``>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +-----------------+---------+--------------------------------------------------------------------------------------+
+
+
+ **Request Example** ::
+
+ 1. single parameter format exampe:
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":0,
+ }
+
+ 2. array format example:
+ [
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":0,
+ },
+ {
+ "name":"param2",
+ "configFile":"configFile2"
+ "value":"value2",
+ "secure":1,
+ }
+ ]
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "value":"value1",
+ "secure":0,
+ "name":"param1",
+ "id":"1139",
+ "configFile":"configFile1"
+ },
+ {
+ "value":"value2",
+ "secure":1,
+ "name":"param2",
+ "id":"1140",
+ "configFile":"configFile2"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/parameters/{:id}**
+ Edit parameter.
+
+ Authentication Required: Yes
+
+ Role(s) Required: if the parameter's secure equals 1, only admin role can edit the parameter, or admin or oper role can access the API.
+
+ **Request Parameters**
+
+ +-----------+---------+------------------+
+ | Parameter | Type | Description |
+ +===========+=========+==================+
+ | ``id`` | integer | The parameter id |
+ +-----------+---------+------------------+
+
+ **Request Route Parameters**
+
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+=========+======================================================================================+
+ | ``name`` | no | string | parameter name |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``configFile`` | no | string | parameter config_file |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``value`` | no | string | parameter value |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+ | ``secure`` | no | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +----------------+----------+---------+--------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter id |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ "secure":"0",
+ }
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "value":"value1",
+ "secure":"0",
+ "name":"param1",
+ "id":"1134",
+ "configFile":"configFile1"
+ }
+ }
+
+|
+
+**DELETE /api/1.2/parameters/{:id}**
+ delete parameter. If the parameter have profile associated, can not be deleted.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper role
+
+ **Request Parameters**
+
+ +-----------+---------+------------------+
+ | Parameter | Type | Description |
+ +===========+=========+==================+
+ | ``id`` | integer | The parameter id |
+ +-----------+---------+------------------+
+
+ **No Request Route Parameters**
+
+ **Response Properties**
+
+ +-------------+--------+----------------------------------+
+ | Parameter | Type | Description |
+ +=============+========+==================================+
+ | ``alerts`` | array | A collection of alert messages. |
+ +-------------+--------+----------------------------------+
+ | ``>level`` | string | Success, info, warning or error. |
+ +-------------+--------+----------------------------------+
+ | ``>text`` | string | Alert message. |
+ +-------------+--------+----------------------------------+
+ | ``version`` | string | |
+ +-------------+--------+----------------------------------+
+
+ **Response Example** ::
+
+ Response Example:
+
+ {
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Parameter was successfully deleted."
+ }
+ ],
+ }
+
+|
+
+**POST /api/1.2/parameters/validate**
+ Validate if the parameter exists.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +----------------+----------+--------------------------------+
+ | Name | Required | Type | Description |
+ +================+==========+================================+
+ | ``name`` | yes | string | parameter name |
+ +----------------+----------+--------------------------------+
+ | ``configFile`` | yes | string | parameter config_file |
+ +----------------+----------+--------------------------------+
+ | ``value`` | yes | string | parameter value |
+ +----------------+----------+--------------------------------+
+
+ **Response Properties**
+
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +==================+=========+================================================================================+
+ | ``id`` | integer | The parameter id |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``value`` | string | The parameter value, only visible to admin if secure is true |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``name`` | string | The parameter name |
+ +------------------+---------+--------------------------------------------------------------------------------+
+ | ``config_file`` | string | The parameter config_file |
+ +------------------+---------+--------------------------------------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name":"param1",
+ "configFile":"configFile1"
+ "value":"value1",
+ }
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "value":"value1",
+ "secure":"0",
+ "name":"param1",
+ "id":"1134",
+ "configFile":"configFile1"
+ }
+ }
+
+|
+
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.rst.txt
deleted file mode 100644
index b9e6cb6..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.rst.txt
+++ /dev/null
@@ -1,448 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-phys-loc:
-
-Physical Location
-=================
-
-.. _to-api-v12-phys-loc-route:
-
-/api/1.2/phys_locations
-+++++++++++++++++++++++
-
-**GET /api/1.2/phys_locations**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``address`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``comments`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``regionId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``shortName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``state`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "region": "Mile High",
- "region": "4",
- "poc": "Jane Doe",
- "lastUpdated": "2014-10-02 08:22:43",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "id": "2",
- "address": "123 East 3rd St",
- "shortName": "Albuquerque"
- },
- {
- "region": "Mile High",
- "region": "4",
- "poc": "Jane Doe",
- "lastUpdated": "2014-10-02 08:22:43",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "id": "2",
- "address": "123 East 3rd St",
- "shortName": "Albuquerque"
- }
- ]
- }
-
-|
-
-**GET /api/1.2/phys_locations/trimmed.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+---------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+=========+================================================+
- |``name`` | string | |
- +----------------------+---------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "Albuquerque"
- },
- {
- "name": "Ashburn"
- }
- ]
- }
-
-|
-
-
-**GET /api/1.2/phys_locations/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------+----------+---------------------------------------------+
- | Name | Required | Description |
- +===========+==========+=============================================+
- | ``id`` | yes | Physical location ID. |
- +-----------+----------+---------------------------------------------+
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``address`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``comments`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``regionId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``shortName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``state`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "region": "Mile High",
- "region": "4",
- "poc": "Jane Doe",
- "lastUpdated": "2014-10-02 08:22:43",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "id": "2",
- "address": "123 East 3rd St",
- "shortName": "Albuquerque"
- }
- ]
- }
-
-|
-
-**PUT /api/1.2/phys_locations/:id**
- Update a physical location
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Type | Description |
- +===================+==========+================================================+
- | ``id`` | int | Physical location id. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +-------------------+----------+------------------------------------------------+
- | Parameter | Required | Description |
- +===================+==========+================================================+
- | ``address`` | yes | Physical location address. |
- +-------------------+----------+------------------------------------------------+
- | ``city`` | yes | Physical location city. |
- +-------------------+----------+------------------------------------------------+
- | ``comments`` | no | Physical location comments. |
- +-------------------+----------+------------------------------------------------+
- | ``email`` | no | Physical location email. |
- +-------------------+----------+------------------------------------------------+
- | ``name`` | yes | Physical location name. |
- +-------------------+----------+------------------------------------------------+
- | ``phone`` | no | Physical location phone. |
- +-------------------+----------+------------------------------------------------+
- | ``poc`` | no | Physical location point of contact. |
- +-------------------+----------+------------------------------------------------+
- | ``regionId`` | no | Physical location region ID. |
- +-------------------+----------+------------------------------------------------+
- | ``shortName`` | yes | Physical location short name. |
- +-------------------+----------+------------------------------------------------+
- | ``state`` | yes | Physical location state. |
- +-------------------+----------+------------------------------------------------+
- | ``zip`` | yes | Physical location zip. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Example** ::
-
- {
- "regionId": "1",
- "poc": "Jane Doesssss",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "address": "123 East 9rd St",
- "shortName": "Albuquerque"
- }
-
-|
-
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``address`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``city`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``comments`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``email`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``phone`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``poc`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``region`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``regionId`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``shortName`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``state`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``zip`` | string | |
- +----------------------+--------+------------------------------------------------+
-
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Physical location update was successful."
- }
- ],
- "response": [
- {
- "region": "Mile High",
- "region": "4",
- "poc": "Jane Doe",
- "lastUpdated": "2014-10-02 08:22:43",
- "name": "Albuquerque",
- "comments": "Albuquerque",
- "phone": "(123) 555-1111",
- "state": "NM",
- "email": "jane.doe@email.com",
- "city": "Albuquerque",
- "zip": "87107",
- "id": "2",
- "address": "123 East 3rd St",
- "shortName": "Albuquerque"
- }
- ]
- }
-
-|
-
-
-**POST /api/1.2/regions/:region_name/phys_locations**
- Create physical location.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- region_name: the name of the region to create physical location into.
-
- **Request Route Parameters**
-
- +-----------------+----------+-----------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================+
- | ``region_name`` | yes | The name of the physical location |
- +-----------------+----------+-----------------------------------+
-
- **Request Properties**
-
- +-----------------+----------+---------------------------------------------------+
- | Parameter | Required | Description |
- +=================+==========+===================================================+
- | ``name`` | yes | The name of the location |
- +-----------------+----------+---------------------------------------------------+
- | ``shortName`` | yes | The short name of the location |
- +-----------------+----------+---------------------------------------------------+
- | ``address`` | yes | |
- +-----------------+----------+---------------------------------------------------+
- | ``city`` | yes | |
- +-----------------+----------+---------------------------------------------------+
- | ``state`` | yes | |
- +-----------------+----------+---------------------------------------------------+
- | ``zip`` | yes | |
- +-----------------+----------+---------------------------------------------------+
- | ``phone`` | no | |
- +-----------------+----------+---------------------------------------------------+
- | ``poc`` | no | Point of contact |
- +-----------------+----------+---------------------------------------------------+
- | ``email`` | no | |
- +-----------------+----------+---------------------------------------------------+
- | ``comments`` | no | |
- +-----------------+----------+---------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name" : "my physical location1",
- "shortName" : "myphylocation1",
- "address" : "",
- "city" : "Shanghai",
- "state": "SH",
- "zip": "200000",
- "comments": "this is physical location1"
- }
-
-|
-
- **Response Properties**
-
- +-----------------+--------+---------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+===================================================+
- | ``id`` | string | The id of the physical location created. |
- +-----------------+--------+---------------------------------------------------+
- | ``name`` | string | The name of the location |
- +-----------------+--------+---------------------------------------------------+
- | ``shortName`` | string | The short name of the location |
- +-----------------+--------+---------------------------------------------------+
- | ``regionName`` | string | The region name the physical location belongs to. |
- +-----------------+--------+---------------------------------------------------+
- | ``regionId`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``address`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``city`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``state`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``zip`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``phone`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``poc`` | string | Point of contact |
- +-----------------+--------+---------------------------------------------------+
- | ``email`` | string | |
- +-----------------+--------+---------------------------------------------------+
- | ``comments`` | string | |
- +-----------------+--------+---------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- 'shortName': 'myphylocati',
- 'regionName': 'myregion1',
- 'name': 'my physical location1',
- 'poc': '',
- 'phone': '',
- 'comments': 'this is physical location1',
- 'state': 'SH',
- 'email': '',
- 'zip': '20000',
- 'region_id': '20',
- 'city': 'Shanghai',
- 'address': '',
- 'id': '200'
- }
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
new file mode 100644
index 0000000..b9e6cb6
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/phys_location.txt
@@ -0,0 +1,448 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-phys-loc:
+
+Physical Location
+=================
+
+.. _to-api-v12-phys-loc-route:
+
+/api/1.2/phys_locations
++++++++++++++++++++++++
+
+**GET /api/1.2/phys_locations**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ },
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**GET /api/1.2/phys_locations/trimmed.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+---------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+=========+================================================+
+ |``name`` | string | |
+ +----------------------+---------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "name": "Albuquerque"
+ },
+ {
+ "name": "Ashburn"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/phys_locations/:id**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Route Parameters**
+
+ +-----------+----------+---------------------------------------------+
+ | Name | Required | Description |
+ +===========+==========+=============================================+
+ | ``id`` | yes | Physical location ID. |
+ +-----------+----------+---------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+**PUT /api/1.2/phys_locations/:id**
+ Update a physical location
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Physical location id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-------------------+----------+------------------------------------------------+
+ | Parameter | Required | Description |
+ +===================+==========+================================================+
+ | ``address`` | yes | Physical location address. |
+ +-------------------+----------+------------------------------------------------+
+ | ``city`` | yes | Physical location city. |
+ +-------------------+----------+------------------------------------------------+
+ | ``comments`` | no | Physical location comments. |
+ +-------------------+----------+------------------------------------------------+
+ | ``email`` | no | Physical location email. |
+ +-------------------+----------+------------------------------------------------+
+ | ``name`` | yes | Physical location name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``phone`` | no | Physical location phone. |
+ +-------------------+----------+------------------------------------------------+
+ | ``poc`` | no | Physical location point of contact. |
+ +-------------------+----------+------------------------------------------------+
+ | ``regionId`` | no | Physical location region ID. |
+ +-------------------+----------+------------------------------------------------+
+ | ``shortName`` | yes | Physical location short name. |
+ +-------------------+----------+------------------------------------------------+
+ | ``state`` | yes | Physical location state. |
+ +-------------------+----------+------------------------------------------------+
+ | ``zip`` | yes | Physical location zip. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "regionId": "1",
+ "poc": "Jane Doesssss",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "address": "123 East 9rd St",
+ "shortName": "Albuquerque"
+ }
+
+|
+
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``address`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``city`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``comments`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``email`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``phone`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``poc`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``region`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``regionId`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``shortName`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``state`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``zip`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Physical location update was successful."
+ }
+ ],
+ "response": [
+ {
+ "region": "Mile High",
+ "region": "4",
+ "poc": "Jane Doe",
+ "lastUpdated": "2014-10-02 08:22:43",
+ "name": "Albuquerque",
+ "comments": "Albuquerque",
+ "phone": "(123) 555-1111",
+ "state": "NM",
+ "email": "jane.doe@email.com",
+ "city": "Albuquerque",
+ "zip": "87107",
+ "id": "2",
+ "address": "123 East 3rd St",
+ "shortName": "Albuquerque"
+ }
+ ]
+ }
+
+|
+
+
+**POST /api/1.2/regions/:region_name/phys_locations**
+ Create physical location.
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ region_name: the name of the region to create physical location into.
+
+ **Request Route Parameters**
+
+ +-----------------+----------+-----------------------------------+
+ | Name | Required | Description |
+ +=================+==========+===================================+
+ | ``region_name`` | yes | The name of the physical location |
+ +-----------------+----------+-----------------------------------+
+
+ **Request Properties**
+
+ +-----------------+----------+---------------------------------------------------+
+ | Parameter | Required | Description |
+ +=================+==========+===================================================+
+ | ``name`` | yes | The name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``shortName`` | yes | The short name of the location |
+ +-----------------+----------+---------------------------------------------------+
+ | ``address`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``city`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``state`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``zip`` | yes | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``phone`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``poc`` | no | Point of contact |
+ +-----------------+----------+---------------------------------------------------+
+ | ``email`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+ | ``comments`` | no | |
+ +-----------------+----------+---------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "name" : "my physical location1",
+ "shortName" : "myphylocation1",
+ "address" : "",
+ "city" : "Shanghai",
+ "state": "SH",
+ "zip": "200000",
+ "comments": "this is physical location1"
+ }
+
+|
+
+ **Response Properties**
+
+ +-----------------+--------+---------------------------------------------------+
+ | Parameter | Type | Description |
+ +=================+========+===================================================+
+ | ``id`` | string | The id of the physical location created. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``name`` | string | The name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``shortName`` | string | The short name of the location |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionName`` | string | The region name the physical location belongs to. |
+ +-----------------+--------+---------------------------------------------------+
+ | ``regionId`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``address`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``city`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``state`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``zip`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``phone`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``poc`` | string | Point of contact |
+ +-----------------+--------+---------------------------------------------------+
+ | ``email`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+ | ``comments`` | string | |
+ +-----------------+--------+---------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'shortName': 'myphylocati',
+ 'regionName': 'myregion1',
+ 'name': 'my physical location1',
+ 'poc': '',
+ 'phone': '',
+ 'comments': 'this is physical location1',
+ 'state': 'SH',
+ 'email': '',
+ 'zip': '20000',
+ 'region_id': '20',
+ 'city': 'Shanghai',
+ 'address': '',
+ 'id': '200'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/profile.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/profile.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/profile.rst.txt
deleted file mode 100644
index bec8f9f..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/profile.rst.txt
+++ /dev/null
@@ -1,357 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-profile:
-
-
-Profiles
-========
-
-.. _to-api-v12-profiles-route:
-
-/api/1.2/profiles
-+++++++++++++++++
-
-**GET /api/1.2/profiles**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +---------------+----------+----------------------------------------------------+
- | Name | Required | Description |
- +===============+==========+====================================================+
- | ``param`` | no | Used to filter profiles by parameter. |
- +---------------+----------+----------------------------------------------------+
-
- **Response Properties**
-
- +-----------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+====================================================+
- | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
- +-----------------+--------+----------------------------------------------------+
- | ``name`` | string | The name for the profile |
- +-----------------+--------+----------------------------------------------------+
- | ``id`` | string | Primary key |
- +-----------------+--------+----------------------------------------------------+
- | ``description`` | string | The description for the profile |
- +-----------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "lastUpdated": "2012-10-08 19:34:45",
- "name": "CCR_TOP",
- "id": "8",
- "description": "Content Router for top.foobar.net"
- }
- ]
- }
-
-|
-
-**GET /api/1.2/profiles/trimmed**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +-----------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+====================================================+
- | ``name`` | string | The name for the profile |
- +-----------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "name": "CCR_TOP"
- }
- ]
- }
-
-|
-
-**GET /api/1.2/profiles/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +-----------------+------------+------------------------------------------------+
- | Parameter | Required | Description |
- +=================+============+================================================+
- | ``id`` | yes | The ID of the profile. |
- +-----------------+------------+------------------------------------------------+
-
- **Response Properties**
-
- +-----------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=================+========+====================================================+
- | ``lastUpdated`` | array | The Time / Date this server entry was last updated |
- +-----------------+--------+----------------------------------------------------+
- | ``name`` | string | The name for the profile |
- +-----------------+--------+----------------------------------------------------+
- | ``id`` | string | Primary key |
- +-----------------+--------+----------------------------------------------------+
- | ``description`` | string | The description for the profile |
- +-----------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "lastUpdated": "2012-10-08 19:34:45",
- "name": "CCR_TOP",
- "id": "8",
- "description": "Content Router for top.foobar.net"
- }
- ]
- }
-
-|
-
-
-**POST /api/1.2/profiles**
- Create a new empty profile.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Properties**
-
- +-----------------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=======================+========+====================================================+
- | ``name`` | string | The name of the new profile |
- +-----------------------+--------+----------------------------------------------------+
- | ``description`` | string | new profile description |
- +-----------------------+--------+----------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name": "CCR_COPY",
- "description": "CCR_COPY description",
- }
-
-|
-
- **Response Properties**
-
- +-----------------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=======================+========+====================================================+
- | ``id`` | string | Id of the new profile |
- +-----------------------+--------+----------------------------------------------------+
- | ``name`` | string | The name of the new profile |
- +-----------------------+--------+----------------------------------------------------+
- | ``description`` | string | new profile description |
- +-----------------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "66",
- "name": "CCR_COPY",
- "description": "CCR_COPY description",
- }
- ]
- }
-
-|
-
-**POST /api/1.2/profiles/name/:profile_name/copy/:profile_copy_from**
- Copy profile to a new profile. The new profile name must not exist.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-----------------------+----------+-------------------------------+
- | Name | Required | Description |
- +=======================+==========+===============================+
- | ``profile_name`` | yes | The name of profile to copy |
- +-----------------------+----------+-------------------------------+
- | ``profile_copy_from`` | yes | The name of profile copy from |
- +-----------------------+----------+-------------------------------+
-
-
- **Response Properties**
-
- +-----------------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=======================+========+====================================================+
- | ``id`` | string | Id of the new profile |
- +-----------------------+--------+----------------------------------------------------+
- | ``name`` | string | The name of the new profile |
- +-----------------------+--------+----------------------------------------------------+
- | ``profileCopyFrom`` | string | The name of profile to copy |
- +-----------------------+--------+----------------------------------------------------+
- | ``idCopyFrom`` | string | The id of profile to copy |
- +-----------------------+--------+----------------------------------------------------+
- | ``description`` | string | new profile's description (copied) |
- +-----------------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "66",
- "name": "CCR_COPY",
- "profileCopyFrom": "CCR1",
- "description": "CCR_COPY description",
- "idCopyFrom": "3"
- }
- ]
- }
-
-|
-
-**PUT /api/1.2/profiles/{:id}**
-
- Allows user to edit a profile.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-----------------+----------+---------------------------------------------------+
- | Name | Required | Description |
- +=================+==========+===================================================+
- | ``id`` | yes | profile id. |
- +-----------------+----------+---------------------------------------------------+
-
- **Request Properties**
-
- +-----------------+----------+---------------------------------------------------+
- | Parameter | Required | Description |
- +=================+==========+===================================================+
- | ``name`` | yes | The new name for the profile. |
- +-----------------+----------+---------------------------------------------------+
- | ``description`` | yes | The new description for the profile. |
- +-----------------+----------+---------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name": "CCR_UPDATE",
- "description": "CCR_UPDATE description"
- }
-
- **Response Properties**
-
- +------------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +==================+========+==================================+
- | ``response`` | | The updated profile info. |
- +------------------+--------+----------------------------------+
- | ``>id`` | string | Profile id. |
- +------------------+--------+----------------------------------+
- | ``>name`` | string | Profile name. |
- +------------------+--------+----------------------------------+
- | ``>description`` | string | Profile description. |
- +------------------+--------+----------------------------------+
- | ``alerts`` | array | A collection of alert messages. |
- +------------------+--------+----------------------------------+
- | ``>level`` | string | success, info, warning or error. |
- +------------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +------------------+--------+----------------------------------+
- | ``version`` | string | |
- +------------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "response":{
- "id": "219",
- "name": "CCR_UPDATE",
- "description": "CCR_UPDATE description"
- }
- "alerts":[
- {
- "level": "success",
- "text": "Profile was updated: 219"
- }
- ]
- }
-
-|
-
-**DELETE /api/1.2/profiles/{:id}**
-
- Allows user to delete a profile.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-----------------+----------+----------------------------+
- | Name | Required | Description |
- +=================+==========+============================+
- | ``id`` | yes | profile id. |
- +-----------------+----------+----------------------------+
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Profile was deleted."
- }
- ]
- }
-
-|
-
[06/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/system.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/system.html b/docs/latest/development/traffic_ops_api/v11/system.html
index b73116c..33b8f49 100644
--- a/docs/latest/development/traffic_ops_api/v11/system.html
+++ b/docs/latest/development/traffic_ops_api/v11/system.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>System — Traffic Control 1.8.1 documentation </title>
+ <title>System — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="TO Extensions" href="to_extension.html"/>
<link rel="prev" title="Status" href="status.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>System</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/system.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/system.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -219,7 +216,7 @@ These are all the parameters in the <code class="docutils literal"><span class="
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>tm.toolname</span></code></td>
<td>string</td>
<td>The name of the Traffic Ops tool. Usually “Traffic Ops”. Used in the About screen and in the comments headers of the files generated
-(<code class="docutils literal"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span>  <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td>
+(<code class="docutils literal"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span> <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tm.instance_name</span></code></td>
<td>string</td>
@@ -235,7 +232,7 @@ set this parameter on a production system.</td>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tm.url</span></code></td>
<td>string</td>
<td>The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated
-(<code class="docutils literal"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span>  <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td>
+(<code class="docutils literal"><span class="pre">#</span> <span class="pre">DO</span> <span class="pre">NOT</span> <span class="pre">EDIT</span> <span class="pre">-</span> <span class="pre">Generated</span> <span class="pre">for</span> <span class="pre">atsec-lax-04</span> <span class="pre">by</span> <span class="pre">Traffic</span> <span class="pre">Ops</span> <span class="pre">(https://traffops.kabletown.net/)</span> <span class="pre">on</span> <span class="pre">Fri</span> <span class="pre">Mar</span> <span class="pre">6</span> <span class="pre">05:15:15</span> <span class="pre">UTC</span> <span class="pre">2015</span></code>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>traffic_mon_fwd_proxy</span></code></td>
<td>string</td>
@@ -255,16 +252,16 @@ set this parameter on a production system.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"parameters"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"tm.toolname"</span><span class="p">:</span> <span class="s2">"Traffic Ops"</span><span class="p">,</span>
- <span class="s2">"tm.infourl"</span><span class="p">:</span> <span class="s2">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
- <span class="s2">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s2">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s2">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
- <span class="s2">"tm.logourl"</span><span class="p">:</span> <span class="s2">"\/images\/tc_logo.png"</span><span class="p">,</span>
- <span class="s2">"tm.url"</span><span class="p">:</span> <span class="s2">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
- <span class="s2">"tm.instance_name"</span><span class="p">:</span> <span class="s2">"Kabletown CDN"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"parameters"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"tm.toolname"</span><span class="p">:</span> <span class="s">"Traffic Ops"</span><span class="p">,</span>
+ <span class="s">"tm.infourl"</span><span class="p">:</span> <span class="s">"http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info"</span><span class="p">,</span>
+ <span class="s">"traffic_mon_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s">"traffic_rtr_fwd_proxy"</span><span class="p">:</span> <span class="s">"http:\/\/proxy.kabletown.net:81"</span><span class="p">,</span>
+ <span class="s">"tm.logourl"</span><span class="p">:</span> <span class="s">"\/images\/tc_logo.png"</span><span class="p">,</span>
+ <span class="s">"tm.url"</span><span class="p">:</span> <span class="s">"https:\/\/tm.kabletown.net\/"</span><span class="p">,</span>
+ <span class="s">"tm.instance_name"</span><span class="p">:</span> <span class="s">"Kabletown CDN"</span>
<span class="p">}</span>
<span class="p">},</span>
<span class="p">}</span>
@@ -312,7 +309,7 @@ set this parameter on a production system.</td>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/to_extension.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/to_extension.html b/docs/latest/development/traffic_ops_api/v11/to_extension.html
index 5a9fe96..756c076 100644
--- a/docs/latest/development/traffic_ops_api/v11/to_extension.html
+++ b/docs/latest/development/traffic_ops_api/v11/to_extension.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>TO Extensions — Traffic Control 1.8.1 documentation </title>
+ <title>TO Extensions — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Types" href="type.html"/>
<link rel="prev" title="System" href="system.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>TO Extensions</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/to_extension.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/to_extension.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -254,34 +251,34 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
- <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
- <span class="n">name</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
- <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
- <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ilo_ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">9</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&
quot;</span><span class="p">,</span>
- <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="nb">id</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
- <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"ILO"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="n">script_file</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
- <span class="n">version</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
- <span class="n">name</span><span class="p">:</span> <span class="s2">"10G_PING"</span><span class="p">,</span>
- <span class="n">description</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="n">info_url</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
- <span class="n">additional_config_json</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}, "</span><span class="n">select</span><span class="s2">": "</span><span class="n">ip_address</span><span class="s2">", "</span><span class="n">cron</span><span class="s2">": "</span><span class="mi">18</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span> <span class="o">*</span><span class="s2">" }&quo
t;</span><span class="p">,</span>
- <span class="n">isactive</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="nb">id</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="nb">type</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
- <span class="n">servercheck_short_name</span><span class="p">:</span> <span class="s2">"10G"</span>
- <span class="p">}</span>
- <span class="p">],</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ script_file: "ping",
+ version: "1.0.0",
+ name: "ILO_PING",
+ description: null,
+ info_url: "http://foo.com/bar.html",
+ additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }",
+ isactive: "1",
+ id: "1",
+ type: "CHECK_EXTENSION_BOOL",
+ servercheck_short_name: "ILO"
+ },
+ {
+ script_file: "ping",
+ version: "1.0.0",
+ name: "10G_PING",
+ description: null,
+ info_url: "http://foo.com/bar.html",
+ additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }",
+ isactive: "1",
+ id: "2",
+ type: "CHECK_EXTENSION_BOOL",
+ servercheck_short_name: "10G"
+ }
+ ],
+}
</pre></div>
</div>
<div class="line-block">
@@ -345,17 +342,17 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ILO_PING"</span><span class="p">,</span>
- <span class="s2">"version"</span><span class="p">:</span> <span class="s2">"1.0.0"</span><span class="p">,</span>
- <span class="s2">"info_url"</span><span class="p">:</span> <span class="s2">"http://foo.com/bar.html"</span><span class="p">,</span>
- <span class="s2">"script_file"</span><span class="p">:</span> <span class="s2">"ping"</span><span class="p">,</span>
- <span class="s2">"isactive"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"additional_config_json"</span><span class="p">:</span> <span class="s2">"{ "</span><span class="n">path</span><span class="s2">": "</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mf">1.1</span><span class="o">/</span><span class="n">servers</span><span class="o">.</span><span class="n">json</span><span class="s2">", "</span><span class="n">match</span><span class="s2">": { "</span><span class="nb">type</span><span class="s2">": "</span><span class="n">EDGE</span><span class="s2">"}"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">"ILO"</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CHECK_EXTENSION_BOOL"</span><span class="p">,</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "name": "ILO_PING",
+ "version": "1.0.0",
+ "info_url": "http://foo.com/bar.html",
+ "script_file": "ping",
+ "isactive": "1",
+ "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}",
+ "description": null,
+ "servercheck_short_name": "ILO"
+ "type": "CHECK_EXTENSION_BOOL",
+}
</pre></div>
</div>
</div></blockquote>
@@ -392,11 +389,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Check Extension loaded."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Check Extension loaded."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -460,11 +457,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Extension deleted."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Extension deleted."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -515,7 +512,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/type.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/type.html b/docs/latest/development/traffic_ops_api/v11/type.html
index 1e08ec6..7b9c69f 100644
--- a/docs/latest/development/traffic_ops_api/v11/type.html
+++ b/docs/latest/development/traffic_ops_api/v11/type.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Types — Traffic Control 1.8.1 documentation </title>
+ <title>Types — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Users" href="user.html"/>
<link rel="prev" title="TO Extensions" href="to_extension.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Types</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/type.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/type.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -254,14 +251,14 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
- <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -296,19 +293,19 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ACTIVE_DIRECTORY"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"ACTIVE_DIRECTORY"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"A_RECORD"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"A_RECORD"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR"</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"CCR"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -376,14 +373,14 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"22"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"AAAA_RECORD"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Static DNS AAAA entry"</span><span class="p">,</span>
- <span class="s2">"useInTable"</span><span class="p">:</span> <span class="s2">"staticdnsentry"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-10-23 15:28:31"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"22"</span><span class="p">,</span>
+ <span class="s">"name"</span><span class="p">:</span> <span class="s">"AAAA_RECORD"</span><span class="p">,</span>
+ <span class="s">"description"</span><span class="p">:</span> <span class="s">"Static DNS AAAA entry"</span><span class="p">,</span>
+ <span class="s">"useInTable"</span><span class="p">:</span> <span class="s">"staticdnsentry"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2013-10-23 15:28:31"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -434,7 +431,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/user.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/user.html b/docs/latest/development/traffic_ops_api/v11/user.html
index 242fcfb..3a3440f 100644
--- a/docs/latest/development/traffic_ops_api/v11/user.html
+++ b/docs/latest/development/traffic_ops_api/v11/user.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Users — Traffic Control 1.8.1 documentation </title>
+ <title>Users — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="ASN" href="../v12/asn.html"/>
<link rel="prev" title="Types" href="type.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Users</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/user.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/user.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -295,29 +292,29 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
- <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
- <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
- <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
- <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
- <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"email1@email.com"</span><span class="p">,</span>
+ <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"53"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"publicSshKey"</span><span class="p">:</span> <span class="s">"xxx"</span><span class="p">,</span>
+ <span class="s">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"admin"</span><span class="p">,</span>
+ <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"username"</span><span class="p">:</span> <span class="s">"tsimpson"</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="o">...</span> <span class="n">more</span> <span class="n">users</span>
@@ -452,29 +449,29 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email1@email.com"</span><span class="p">,</span>
- <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Simpson"</span><span class="p">,</span>
- <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"53"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 10:22:07"</span><span class="p">,</span>
- <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"publicSshKey"</span><span class="p">:</span> <span class="s2">"xxx"</span><span class="p">,</span>
- <span class="s2">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"rolename"</span><span class="p">:</span> <span class="s2">"admin"</span><span class="p">,</span>
- <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tsimpson"</span>
+ <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"email1@email.com"</span><span class="p">,</span>
+ <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Simpson"</span><span class="p">,</span>
+ <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"53"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2016-01-26 10:22:07"</span><span class="p">,</span>
+ <span class="s">"newUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"publicSshKey"</span><span class="p">:</span> <span class="s">"xxx"</span><span class="p">,</span>
+ <span class="s">"registrationSent"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"rolename"</span><span class="p">:</span> <span class="s">"admin"</span><span class="p">,</span>
+ <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"username"</span><span class="p">:</span> <span class="s">"tsimpson"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -574,25 +571,25 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"50"</span><span class="p">,</span>
- <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">"Tom Callahan"</span><span class="p">,</span>
- <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
- <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"50"</span><span class="p">,</span>
+ <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"fullName"</span><span class="p">:</span> <span class="s">"Tom Callahan"</span><span class="p">,</span>
+ <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
+ <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span>
<span class="p">},</span>
<span class="p">}</span>
</pre></div>
@@ -691,25 +688,25 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"user"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"city"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"phoneNumber"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"company"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"country"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"fullName"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
- <span class="s2">"uid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"stateOrProvince"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"tommyboy"</span><span class="p">,</span>
- <span class="s2">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
- <span class="s2">"addressLine2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"role"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"addressLine1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"gid"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span>
- <span class="s2">"postalCode"</span><span class="p">:</span> <span class="s2">""</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"user"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"city"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"phoneNumber"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"company"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"country"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"fullName"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"localUser"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span>
+ <span class="s">"uid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"stateOrProvince"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"username"</span><span class="p">:</span> <span class="s">"tommyboy"</span><span class="p">,</span>
+ <span class="s">"newUser"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span>
+ <span class="s">"addressLine2"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"role"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"addressLine1"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"gid"</span><span class="p">:</span> <span class="s">"0"</span><span class="p">,</span>
+ <span class="s">"postalCode"</span><span class="p">:</span> <span class="s">""</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
@@ -747,11 +744,11 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"UserProfile was successfully updated."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"UserProfile was successfully updated."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -863,23 +860,23 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"keyword"</span><span class="p">:</span> <span class="s2">"PURGE"</span><span class="p">,</span>
- <span class="s2">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"assetUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"assetType"</span><span class="p">:</span> <span class="s2">"file"</span><span class="p">,</span>
- <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"PENDING"</span><span class="p">,</span>
- <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
- <span class="s2">"dsXmlId"</span><span class="p">:</span> <span class="s2">"ds-xml-id"</span><span class="p">,</span>
- <span class="s2">"username"</span><span class="p">:</span> <span class="s2">"peewee"</span><span class="p">,</span>
- <span class="s2">"parameters"</span><span class="p">:</span> <span class="s2">"TTL:56h"</span><span class="p">,</span>
- <span class="s2">"enteredTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 18:00:16"</span><span class="p">,</span>
- <span class="s2">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"agent"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-21 10:45:38"</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"keyword"</span><span class="p">:</span> <span class="s">"PURGE"</span><span class="p">,</span>
+ <span class="s">"objectName"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"assetUrl"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"assetType"</span><span class="p">:</span> <span class="s">"file"</span><span class="p">,</span>
+ <span class="s">"status"</span><span class="p">:</span> <span class="s">"PENDING"</span><span class="p">,</span>
+ <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
+ <span class="s">"dsXmlId"</span><span class="p">:</span> <span class="s">"ds-xml-id"</span><span class="p">,</span>
+ <span class="s">"username"</span><span class="p">:</span> <span class="s">"peewee"</span><span class="p">,</span>
+ <span class="s">"parameters"</span><span class="p">:</span> <span class="s">"TTL:56h"</span><span class="p">,</span>
+ <span class="s">"enteredTime"</span><span class="p">:</span> <span class="s">"2015-01-21 18:00:16"</span><span class="p">,</span>
+ <span class="s">"objectType"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"agent"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-21 10:45:38"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -947,11 +944,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"dsId"</span><span class="p">:</span> <span class="s2">"9999"</span><span class="p">,</span>
- <span class="s2">"regex"</span><span class="p">:</span> <span class="s2">"/path/to/content.jpg"</span><span class="p">,</span>
- <span class="s2">"startTime"</span><span class="p">:</span> <span class="s2">"2015-01-27 11:08:37"</span><span class="p">,</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"dsId"</span><span class="p">:</span> <span class="s">"9999"</span><span class="p">,</span>
+ <span class="s">"regex"</span><span class="p">:</span> <span class="s">"/path/to/content.jpg"</span><span class="p">,</span>
+ <span class="s">"startTime"</span><span class="p">:</span> <span class="s">"2015-01-27 11:08:37"</span><span class="p">,</span>
+ <span class="s">"ttl"</span><span class="p">:</span> <span class="mi">54</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -993,12 +990,12 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span>
<span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully created purge job for: ."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully created purge job for: ."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1038,9 +1035,9 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"u"</span><span class="p">:</span> <span class="s2">"username"</span><span class="p">,</span>
- <span class="s2">"p"</span><span class="p">:</span> <span class="s2">"password"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"u"</span><span class="p">:</span> <span class="s">"username"</span><span class="p">,</span>
+ <span class="s">"p"</span><span class="p">:</span> <span class="s">"password"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1082,11 +1079,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully logged in."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully logged in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1145,15 +1142,15 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"90"</span>
+ <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"90"</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"ns-img-secure"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"280"</span>
+ <span class="s">"xmlId"</span><span class="p">:</span> <span class="s">"ns-img-secure"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"280"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1189,8 +1186,8 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"t"</span><span class="p">:</span> <span class="s2">"token-value"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"t"</span><span class="p">:</span> <span class="s">"token-value"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1232,11 +1229,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"error"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Unauthorized, please log in."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"error"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Unauthorized, please log in."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1290,11 +1287,11 @@ unnecessary work.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"You are logged out."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"You are logged out."</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1331,8 +1328,8 @@ password reset.</td>
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"email"</span><span class="p">:</span> <span class="s2">"email@email.com"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"email"</span><span class="p">:</span> <span class="s">"email@email.com"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1380,11 +1377,11 @@ password reset.</td>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"alerts"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Successfully sent password reset to email 'email@email.com'"</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"Successfully sent password reset to email 'email@email.com'"</span>
<span class="p">}</span>
<span class="p">],</span>
<span class="p">}</span>
@@ -1432,7 +1429,7 @@ password reset.</td>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v12/asn.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v12/asn.html b/docs/latest/development/traffic_ops_api/v12/asn.html
index bc8be7d..473757d 100644
--- a/docs/latest/development/traffic_ops_api/v12/asn.html
+++ b/docs/latest/development/traffic_ops_api/v12/asn.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>ASN — Traffic Control 1.8.1 documentation </title>
+ <title>ASN — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Cache Group" href="cachegroup.html"/>
<link rel="prev" title="Users" href="../v11/user.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>ASN</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v12/asn.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v12/asn.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -234,21 +231,21 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
- <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7015"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-ma-woburn"</span><span class="p">,</span>
- <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"27"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
+ <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7015"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-ma-woburn"</span><span class="p">,</span>
+ <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"27"</span><span class="p">,</span>
<span class="p">},</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
- <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
- <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span>
+ <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7016"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"13"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -319,14 +316,14 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
- <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"7016"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
- <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"13"</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span>
+ <span class="s">"asn"</span><span class="p">:</span> <span class="s">"7016"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"13"</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -386,9 +383,9 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
- <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"asn"</span><span class="p">:</span> <span class="s">"99"</span><span class="p">,</span>
+ <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"177"</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -437,18 +434,18 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:{</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2012-09-17 21:41:22"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"28"</span><span class="p">,</span>
- <span class="s2">"asn"</span><span class="p">:</span> <span class="s2">"99"</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-pa-pittsburgh"</span><span class="p">,</span>
- <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"177"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:{</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2012-09-17 21:41:22"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"28"</span><span class="p">,</span>
+ <span class="s">"asn"</span><span class="p">:</span> <span class="s">"99"</span><span class="p">,</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-pa-pittsburgh"</span><span class="p">,</span>
+ <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"177"</span>
<span class="p">},</span>
- <span class="s2">"alerts"</span><span class="p">:[</span>
+ <span class="s">"alerts"</span><span class="p">:[</span>
<span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"cdn was updated."</span>
+ <span class="s">"level"</span><span class="p">:</span> <span class="s">"success"</span><span class="p">,</span>
+ <span class="s">"text"</span><span class="p">:</span> <span class="s">"cdn was updated."</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -499,7 +496,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[07/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/server.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/server.html b/docs/latest/development/traffic_ops_api/v11/server.html
index cc8fa38..ae878f9 100644
--- a/docs/latest/development/traffic_ops_api/v11/server.html
+++ b/docs/latest/development/traffic_ops_api/v11/server.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Server — Traffic Control 1.8.1 documentation </title>
+ <title>Server — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Static DNS Entries" href="static_dns.html"/>
<link rel="prev" title="Roles" href="role.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Server</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/server.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/server.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -242,7 +239,7 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><em>Cache Group</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
<td>string</td>
@@ -346,23 +343,23 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
<td>string</td>
-<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
<td>string</td>
-<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
<td>string</td>
-<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
@@ -378,11 +375,11 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><em>Status</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
<td>string</td>
-<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><em>Status</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
@@ -390,11 +387,11 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
-<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
<td>bool</td>
@@ -403,49 +400,49 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
- <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
- <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
- <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
- <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
- <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
- <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
- <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
- <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
- <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
- <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
- <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
- <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
- <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
- <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
- <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
- <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
- <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
- <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"cdnId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"CDN-1"</span><span class="p">,</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
+ <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
+ <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
+ <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
+ <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"offlineReason"</span><span class="p">:</span> <span class="s">"N/A"</span><span class="p">,</span>
+ <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s">"physLocationId"</span><span class="p">:</span> <span class="s">"9"</span><span class="p">,</span>
+ <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s">"profileDesc"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"12"</span><span class="p">,</span>
+ <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
+ <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
+ <span class="s">"statusId"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
+ <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"updPending"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">},</span>
<span class="p">{</span>
<span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span>
@@ -499,7 +496,7 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><em>Cache Group</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td>
<td>string</td>
@@ -603,23 +600,23 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td>
<td>string</td>
-<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+<td>The physical location id (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td>
<td>string</td>
-<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+<td>The assigned profile description (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td>
<td>string</td>
-<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+<td>The assigned profile Id (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
@@ -635,11 +632,11 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><em>Status</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td>
<td>string</td>
-<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+<td>The Status id (See <a class="reference internal" href="status.html#to-api-v11-status"><em>Status</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
@@ -647,11 +644,11 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td>
<td>string</td>
-<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+<td>The id of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td>
<td>bool</td>
@@ -660,49 +657,49 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span>
<span class="p">{</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
- <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span>
- <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
- <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
- <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
- <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
- <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
- <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
- <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
- <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
- <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
- <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
- <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span>
- <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span>
- <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span>
- <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
- <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span>
- <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
- <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
- <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span>
- <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
- <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
- <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s">"cachegroupId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"cdnId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"cdnName"</span><span class="p">:</span> <span class="s">"CDN-1"</span><span class="p">,</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span>
+ <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
+ <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
+ <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
+ <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
+ <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-03-08 15:57:32"</span><span class="p">,</span>
+ <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"offlineReason"</span><span class="p">:</span> <span class="s">"N/A"</span><span class="p">,</span>
+ <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s">"physLocationId"</span><span class="p">:</span> <span class="s">"9"</span><span class="p">,</span>
+ <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s">"profileDesc"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span>
+ <span class="s">"profileId"</span><span class="p">:</span> <span class="s">"12"</span><span class="p">,</span>
+ <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
+ <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
+ <span class="s">"statusId"</span><span class="p">:</span> <span class="s">"6"</span><span class="p">,</span>
+ <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
+ <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
+ <span class="s">"typeId"</span><span class="p">:</span> <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"updPending"</span><span class="p">:</span> <span class="n">false</span>
<span class="p">}</span>
<span class="p">]</span>
<span class="p">}</span>
@@ -737,34 +734,34 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+<td>The name of the type of the server count (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
</tr>
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CCR"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">55</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"MID"</span><span class="p">,</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">18</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"INFLUXDB"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"RASCAL"</span>
- <span class="p">}</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre>{
+ "response": [
+ {
+ "count": 4,
+ "type": "CCR"
+ },
+ {
+ "count": 55,
+ "type": "EDGE"
+ },
+ {
+ "type": "MID",
+ "count": 18
+ },
+ {
+ "count": 0,
+ "type": "INFLUXDB"
+ },
+ {
+ "count": 4,
+ "type": "RASCAL"
+ }
+}
</pre></div>
</div>
</div></blockquote>
@@ -812,11 +809,11 @@
<tbody valign="top">
<tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td>
<td>string</td>
-<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td>
+<td>The cache group name (see <a class="reference internal" href="cachegroup.html#to-api-v11-cachegroup"><em>Cache Group</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryservices</span></code></td>
<td>array</td>
-<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v11-ds"><span class="std std-ref">Delivery Service</span></a>).</td>
+<td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v11-ds"><em>Delivery Service</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td>
<td>string</td>
@@ -824,7 +821,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">hardwareInfo</span></code></td>
<td>hash</td>
-<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v11-hwinfo"><span class="std std-ref">Hardware Info</span></a>).</td>
+<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-v11-hwinfo"><em>Hardware Info</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td>
<td>string</td>
@@ -900,11 +897,11 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td>
<td>string</td>
-<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td>
+<td>The physical location name (see <a class="reference internal" href="phys_location.html#to-api-v11-phys-loc"><em>Physical Location</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td>
<td>string</td>
-<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td>
+<td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td>
<td>string</td>
@@ -920,7 +917,7 @@
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td>
<td>string</td>
-<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td>
+<td>The Status string (See <a class="reference internal" href="status.html#to-api-v11-status"><em>Status</em></a>).</td>
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td>
<td>string</td>
@@ -932,7 +929,7 @@
</tr>
<tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td>
<td>string</td>
-<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td>
+<td>The name of the type of this server (see <a class="reference internal" href="type.html#to-api-v11-type"><em>Types</em></a>).</td>
</tr>
<tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td>
<td>string</td>
@@ -945,93 +942,93 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span>
- <span class="s2">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
- <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"4"</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span>
+ <span class="s">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span>
+ <span class="s">"1"</span><span class="p">,</span>
+ <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"3"</span><span class="p">,</span>
+ <span class="s">"4"</span>
<span class="p">],</span>
- <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span>
- <span class="s2">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
- <span class="s2">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s2">"YS08"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Model"</span><span class="p">:</span> <span class="s2">"PowerEdge R720xd"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s2">"4217A5"</span><span class="p">,</span>
- <span class="s2">"Lifecycle Controller"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Manufacturer"</span><span class="p">:</span> <span class="s2">"Dell Inc."</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"SysMemTotalSize"</span><span class="p">:</span> <span class="s2">"196608"</span><span class="p">,</span>
- <span class="s2">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s2">"24"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s2">"13.5.7"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s2">"1.00"</span><span class="p">,</span>
- <span class="s2">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s2">"7.0.0.29"</span><span class="p">,</span>
- <span class="s2">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s2">"1.57.57"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"ServiceTag"</span><span class="p">:</span> <span class="s2">"D6XPDV1"</span><span class="p">,</span>
- <span class="s2">"PowerState"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s2">"D903"</span><span class="p">,</span>
- <span class="s2">"BIOS"</span><span class="p">:</span> <span class="s2">"1.3.6"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"System CPLD"</span><span class="p">:</span> <span class="s2">"1.0.3"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span>
- <span class="s2">"PERC H710P Mini"</span><span class="p">:</span> <span class="s2">"21.0.2-0001"</span><span class="p">,</span>
- <span class="s2">"PowerCap"</span><span class="p">:</span> <span class="s2">"689"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span>
- <span class="s2">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s2">"1.07"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s2">"7.2.20"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span>
- <span class="s2">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s2">"D1S2"</span>
+ <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span>
+ <span class="s">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s">"YS08"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Model"</span><span class="p">:</span> <span class="s">"PowerEdge R720xd"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s">"4217A5"</span><span class="p">,</span>
+ <span class="s">"Lifecycle Controller"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Manufacturer"</span><span class="p">:</span> <span class="s">"Dell Inc."</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"SysMemTotalSize"</span><span class="p">:</span> <span class="s">"196608"</span><span class="p">,</span>
+ <span class="s">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s">"24"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s">"13.5.7"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s">"1.00"</span><span class="p">,</span>
+ <span class="s">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s">"7.0.0.29"</span><span class="p">,</span>
+ <span class="s">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s">"1.57.57"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"ServiceTag"</span><span class="p">:</span> <span class="s">"D6XPDV1"</span><span class="p">,</span>
+ <span class="s">"PowerState"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s">"D903"</span><span class="p">,</span>
+ <span class="s">"BIOS"</span><span class="p">:</span> <span class="s">"1.3.6"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"System CPLD"</span><span class="p">:</span> <span class="s">"1.0.3"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span>
+ <span class="s">"PERC H710P Mini"</span><span class="p">:</span> <span class="s">"21.0.2-0001"</span><span class="p">,</span>
+ <span class="s">"PowerCap"</span><span class="p">:</span> <span class="s">"689"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span>
+ <span class="s">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s">"1.07"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s">"7.2.20"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span>
+ <span class="s">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s">"D1S2"</span>
<span class="p">},</span>
- <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span>
- <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span>
- <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span>
- <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
- <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span>
- <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span>
- <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span>
- <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
- <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
- <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span>
- <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span>
- <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span>
- <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span>
- <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
- <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span>
- <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span>
- <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
- <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span>
- <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span>
- <span class="s2">"xmppId"</span><span class="p">:</span> <span class="s2">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
- <span class="s2">"xmppPasswd"</span><span class="p">:</span> <span class="s2">"X"</span>
+ <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span>
+ <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span>
+ <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span>
+ <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span>
+ <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span>
+ <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span>
+ <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span>
+ <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span>
+ <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span>
+ <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span>
+ <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span>
+ <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span>
+ <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span>
+ <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span>
+ <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span>
+ <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span>
+ <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span>
+ <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span>
+ <span class="s">"httpsPort"</span><span class="p">:</span> <span class="s">"443"</span><span class="p">,</span>
+ <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span>
+ <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span>
+ <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"X"</span>
<span class="p">}</span>
<span class="p">}</span>
@@ -1079,11 +1076,11 @@
</tbody>
</table>
<p><strong>Request Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"host_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span>
- <span class="s2">"value"</span><span class="p">:</span> <span class="s2">""</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+ <span class="s">"id"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"host_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"servercheck_short_name"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span>
+ <span class="s">"value"</span><span class="p">:</span> <span class="s">""</span>
<span class="p">}</span>
</pre></div>
</div>
@@ -1125,17 +1122,17 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span>
+<div class="highlight-python"><div class="highlight"><pre>Response Example:
-<span class="p">{</span>
- <span class="s2">"alerts"</span><span class="p">:</span>
- <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span>
- <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server Check was successfully updated."</span>
- <span class="p">}</span>
- <span class="p">],</span>
-<span class="p">}</span>
+{
+ "alerts":
+ [
+ {
+ "level": "success",
+ "text": "Server Check was successfully updated."
+ }
+ ],
+}
</pre></div>
</div>
</div></blockquote>
@@ -1180,7 +1177,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/static_dns.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/static_dns.html b/docs/latest/development/traffic_ops_api/v11/static_dns.html
index 8f2c993..0cabd74 100644
--- a/docs/latest/development/traffic_ops_api/v11/static_dns.html
+++ b/docs/latest/development/traffic_ops_api/v11/static_dns.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Static DNS Entries — Traffic Control 1.8.1 documentation </title>
+ <title>Static DNS Entries — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="Status" href="status.html"/>
<link rel="prev" title="Server" href="server.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Static DNS Entries</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/static_dns.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/static_dns.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -238,18 +235,18 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"deliveryservice"</span><span class="p">:</span> <span class="s2">"foo-ds"</span><span class="p">,</span>
- <span class="s2">"ttl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span>
- <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CNAME_RECORD"</span><span class="p">,</span>
- <span class="s2">"address"</span><span class="p">:</span> <span class="s2">"bar.foo.baz.tv."</span><span class="p">,</span>
- <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-co-denver"</span><span class="p">,</span>
- <span class="s2">"host"</span><span class="p">:</span> <span class="s2">"mm"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre> {
+ "response": [
+ {
+ "deliveryservice": "foo-ds",
+ "ttl": "30",
+ "type": "CNAME_RECORD",
+ "address": "bar.foo.baz.tv.",
+ "cachegroup": "us-co-denver",
+ "host": "mm"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -294,7 +291,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/development/traffic_ops_api/v11/status.html
----------------------------------------------------------------------
diff --git a/docs/latest/development/traffic_ops_api/v11/status.html b/docs/latest/development/traffic_ops_api/v11/status.html
index 6bb0203..04e5c7f 100644
--- a/docs/latest/development/traffic_ops_api/v11/status.html
+++ b/docs/latest/development/traffic_ops_api/v11/status.html
@@ -7,7 +7,7 @@
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
- <title>Status — Traffic Control 1.8.1 documentation </title>
+ <title>Status — Traffic Control 1.8.0 documentation </title>
@@ -33,10 +33,7 @@
- <link rel="index" title="Index"
- href="../../../genindex.html"/>
- <link rel="search" title="Search" href="../../../search.html"/>
- <link rel="top" title="Traffic Control 1.8.1 documentation" href="../../../index.html"/>
+ <link rel="top" title="Traffic Control 1.8.0 documentation" href="../../../index.html"/>
<link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/>
<link rel="next" title="System" href="system.html"/>
<link rel="prev" title="Static DNS Entries" href="static_dns.html"/>
@@ -162,7 +159,7 @@
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
- <li><a href="../../../index.html">Traffic Control 1.8.1</a> »</li>
+ <li><a href="../../../index.html">Traffic Control 1.8.0</a> »</li>
<li><a href="../../index.html">Developer’s Guide</a> »</li>
@@ -171,7 +168,7 @@
<li>Status</li>
<li class="wy-breadcrumbs-aside">
- <a href="../../../_sources/development/traffic_ops_api/v11/status.rst.txt" rel="nofollow"> View page source</a>
+ <a href="../../../_sources/development/traffic_ops_api/v11/status.txt" rel="nofollow"> View page source</a>
</li>
</ul>
@@ -231,40 +228,40 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"CCR_IGNORE"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"OFFLINE"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
- <span class="p">},</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"REPORTED"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre> {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "5",
+ "name": "CCR_IGNORE",
+ "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "1",
+ "name": "OFFLINE",
+ "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "2",
+ "name": "ONLINE",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges",
+ "lastUpdated": "2013-02-13 16:34:29"
+ },
+ {
+ "id": "3",
+ "name": "REPORTED",
+ "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -326,16 +323,16 @@
</tbody>
</table>
<p><strong>Response Example</strong></p>
-<div class="highlight-default"><div class="highlight"><pre><span></span> <span class="p">{</span>
- <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span>
- <span class="p">{</span>
- <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"4"</span><span class="p">,</span>
- <span class="s2">"name"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span>
- <span class="s2">"description"</span><span class="p">:</span> <span class="s2">"Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches"</span><span class="p">,</span>
- <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2013-02-13 16:34:29"</span>
- <span class="p">}</span>
- <span class="p">]</span>
-<span class="p">}</span>
+<div class="highlight-python"><div class="highlight"><pre> {
+ "response": [
+ {
+ "id": "4",
+ "name": "ADMIN_DOWN",
+ "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches",
+ "lastUpdated": "2013-02-13 16:34:29"
+ }
+ ]
+}
</pre></div>
</div>
</div></blockquote>
@@ -380,7 +377,7 @@
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'../../../',
- VERSION:'1.8.1',
+ VERSION:'1.8.0',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
[27/51] [partial] incubator-trafficcontrol-website git commit: 1.8.0
is latest release
Posted by da...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.rst.txt
deleted file mode 100644
index 8d9dadb..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.rst.txt
+++ /dev/null
@@ -1,155 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v12-ds-stats:
-
-Delivery Service Statistics
-===========================
-
-.. _to-api-v12-ds-stats-route:
-
-/api/1.2/deliveryservice_stats
-++++++++++++++++++++++++++++++
-
-**GET /api/1.2/deliveryservice_stats.json**
-
- Retrieves statistics on the delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Query Parameters**
-
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | Name | Required | Description |
- +==========================+==========+==============================================================================================================================================+
- | ``deliveryServiceName`` | yes | The delivery service with the desired stats |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | ``metricType`` | yes | The metric type (valid metric types: 'kbps', 'out_bytes', 'status_4xx', 'status_5xx', tps_total', 'tps_2xx','tps_3xx', 'tps_4xx', 'tps_5xx') |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | ``startDate`` | yes | The begin date (Formatted as ISO8601, for example: '2015-08-11T12:30:00-06:00') |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
- | ``endDate`` | yes | The end date (Formatted as ISO8601, for example: '2015-08-12T12:30:00-06:00') |
- +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
-
- **Response Properties**
-
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +============================+===============+=========================================================================================+
- |``source`` | string | The source of the data |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``summary`` | hash | Summary data |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>totalBytes`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>count`` | int | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>min`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>max`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>fifthPercentile`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>ninetyEighthPercentile`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>ninetyFifthPercentile`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>average`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>totalTransactions`` | int | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``series`` | hash | Series data |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>count`` | int | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>columns`` | array | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>name`` | string | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>values`` | array | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>>time`` | string | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
- |``>>value`` | float | |
- +----------------------------+---------------+-----------------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- "source": "TrafficStats",
- "summary": {
- "average": 1081172.785,
- "count": 28,
- "fifthPercentile": 888827.26,
- "max": 1326680.31,
- "min": 888827.26,
- "ninetyEighthPercentile": 1324785.47,
- "ninetyFifthPercentile": 1324785.47,
- "totalBytes": 37841047.475,
- "totalTransactions": 1020202030101
- },
- "series": {
- "columns": [
- "time",
- ""
- ],
- "count": 60,
- "name": "kbps",
- "tags": {
- "cachegroup": "total"
- },
- "values": [
- [
- "2015-08-11T11:36:00Z",
- 888827.26
- ],
- [
- "2015-08-11T11:37:00Z",
- 980336.563333333
- ],
- [
- "2015-08-11T11:38:00Z",
- 952111.975
- ],
- [
- "2015-08-11T11:39:00Z",
- null
- ],
- [
- "2015-08-11T11:43:00Z",
- null
- ],
- [
- "2015-08-11T11:44:00Z",
- 934682.943333333
- ],
- [
- "2015-08-11T11:45:00Z",
- 1251121.28
- ],
- [
- "2015-08-11T11:46:00Z",
- 1111012.99
- ]
- ]
- }
- }
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
new file mode 100644
index 0000000..8d9dadb
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/deliveryservice_stats.txt
@@ -0,0 +1,155 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v12-ds-stats:
+
+Delivery Service Statistics
+===========================
+
+.. _to-api-v12-ds-stats-route:
+
+/api/1.2/deliveryservice_stats
+++++++++++++++++++++++++++++++
+
+**GET /api/1.2/deliveryservice_stats.json**
+
+ Retrieves statistics on the delivery services. See also `Using Traffic Ops - Delivery Service <http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service>`_.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Request Query Parameters**
+
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | Name | Required | Description |
+ +==========================+==========+==============================================================================================================================================+
+ | ``deliveryServiceName`` | yes | The delivery service with the desired stats |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``metricType`` | yes | The metric type (valid metric types: 'kbps', 'out_bytes', 'status_4xx', 'status_5xx', tps_total', 'tps_2xx','tps_3xx', 'tps_4xx', 'tps_5xx') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``startDate`` | yes | The begin date (Formatted as ISO8601, for example: '2015-08-11T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+ | ``endDate`` | yes | The end date (Formatted as ISO8601, for example: '2015-08-12T12:30:00-06:00') |
+ +--------------------------+----------+----------------------------------------------------------------------------------------------------------------------------------------------+
+
+ **Response Properties**
+
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +============================+===============+=========================================================================================+
+ |``source`` | string | The source of the data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``summary`` | hash | Summary data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>totalBytes`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>min`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>max`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>fifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyEighthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>ninetyFifthPercentile`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>average`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>totalTransactions`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``series`` | hash | Series data |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>count`` | int | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>columns`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>name`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>values`` | array | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>time`` | string | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+ |``>>value`` | float | |
+ +----------------------------+---------------+-----------------------------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ "source": "TrafficStats",
+ "summary": {
+ "average": 1081172.785,
+ "count": 28,
+ "fifthPercentile": 888827.26,
+ "max": 1326680.31,
+ "min": 888827.26,
+ "ninetyEighthPercentile": 1324785.47,
+ "ninetyFifthPercentile": 1324785.47,
+ "totalBytes": 37841047.475,
+ "totalTransactions": 1020202030101
+ },
+ "series": {
+ "columns": [
+ "time",
+ ""
+ ],
+ "count": 60,
+ "name": "kbps",
+ "tags": {
+ "cachegroup": "total"
+ },
+ "values": [
+ [
+ "2015-08-11T11:36:00Z",
+ 888827.26
+ ],
+ [
+ "2015-08-11T11:37:00Z",
+ 980336.563333333
+ ],
+ [
+ "2015-08-11T11:38:00Z",
+ 952111.975
+ ],
+ [
+ "2015-08-11T11:39:00Z",
+ null
+ ],
+ [
+ "2015-08-11T11:43:00Z",
+ null
+ ],
+ [
+ "2015-08-11T11:44:00Z",
+ 934682.943333333
+ ],
+ [
+ "2015-08-11T11:45:00Z",
+ 1251121.28
+ ],
+ [
+ "2015-08-11T11:46:00Z",
+ 1111012.99
+ ]
+ ]
+ }
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/division.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/division.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/division.rst.txt
deleted file mode 100644
index 934c393..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/division.rst.txt
+++ /dev/null
@@ -1,202 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-division:
-
-Divisions
-=========
-
-.. _to-api-v12-division-route:
-
-/api/1.2/divisions
-++++++++++++++++
-
-**GET /api/1.2/divisions**
- Get all divisions.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+=================================================+
- |``id`` | string | Division id |
- +----------------------+--------+-------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+-------------------------------------------------+
- |``name`` | string | Division name |
- +----------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "1"
- "name": "Central",
- "lastUpdated": "2014-10-02 08:22:43"
- },
- {
- "id": "2"
- "name": "West",
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-
-**GET /api/1.2/divisions/:id**
- Get division by Id.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +----------------------+--------+-------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+=================================================+
- |``id`` | string | Division id |
- +----------------------+--------+-------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+-------------------------------------------------+
- |``name`` | string | Division name |
- +----------------------+--------+-------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "id": "1"
- "name": "Central",
- "lastUpdated": "2014-10-02 08:22:43"
- }
- ]
- }
-
-|
-
-
-**PUT /api/1.2/divisions/:id**
- Update a division
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
-
- +-------------------+----------+------------------------------------------------+
- | Name | Type | Description |
- +===================+==========+================================================+
- | ``id`` | int | Division id. |
- +-------------------+----------+------------------------------------------------+
-
- **Request Properties**
-
- +-----------+----------+--------------------------+
- | Parameter | Required | Description |
- +===========+==========+==========================+
- | ``name`` | yes | The name of the division |
- +-----------+----------+--------------------------+
-
- **Request Example** ::
-
- {
- "name": "mydivision1"
- }
-
-|
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``lastUpdated`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "alerts": [
- {
- "level": "success",
- "text": "Division update was successful."
- }
- ],
- "response": {
- "id": "1",
- "lastUpdated": "2014-03-18 08:57:39",
- "name": "mydivision1"
- }
- }
-|
-
-
-**POST /api/1.2/divisions**
- Create division
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Properties**
-
- +-----------+----------+--------------------------+
- | Parameter | Required | Description |
- +===========+==========+==========================+
- | ``name`` | yes | The name of the division |
- +-----------+----------+--------------------------+
-
- **Request Example** ::
-
- {
- "name": "mydivision1"
- }
-
-|
-
- **Response Properties**
-
- +----------------------+--------+------------------------------------------------+
- | Parameter | Type | Description |
- +======================+========+================================================+
- |``name`` | string | |
- +----------------------+--------+------------------------------------------------+
- |``id`` | string | |
- +----------------------+--------+------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": {
- 'name': 'mydivision1',
- 'id': '4'
- }
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/division.txt b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
new file mode 100644
index 0000000..934c393
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/division.txt
@@ -0,0 +1,202 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-division:
+
+Divisions
+=========
+
+.. _to-api-v12-division-route:
+
+/api/1.2/divisions
+++++++++++++++++
+
+**GET /api/1.2/divisions**
+ Get all divisions.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ },
+ {
+ "id": "2"
+ "name": "West",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**GET /api/1.2/divisions/:id**
+ Get division by Id.
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +----------------------+--------+-------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+=================================================+
+ |``id`` | string | Division id |
+ +----------------------+--------+-------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+-------------------------------------------------+
+ |``name`` | string | Division name |
+ +----------------------+--------+-------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "id": "1"
+ "name": "Central",
+ "lastUpdated": "2014-10-02 08:22:43"
+ }
+ ]
+ }
+
+|
+
+
+**PUT /api/1.2/divisions/:id**
+ Update a division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Route Parameters**
+
+ +-------------------+----------+------------------------------------------------+
+ | Name | Type | Description |
+ +===================+==========+================================================+
+ | ``id`` | int | Division id. |
+ +-------------------+----------+------------------------------------------------+
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``lastUpdated`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "alerts": [
+ {
+ "level": "success",
+ "text": "Division update was successful."
+ }
+ ],
+ "response": {
+ "id": "1",
+ "lastUpdated": "2014-03-18 08:57:39",
+ "name": "mydivision1"
+ }
+ }
+|
+
+
+**POST /api/1.2/divisions**
+ Create division
+
+ Authentication Required: Yes
+
+ Role(s) Required: admin or oper
+
+ **Request Properties**
+
+ +-----------+----------+--------------------------+
+ | Parameter | Required | Description |
+ +===========+==========+==========================+
+ | ``name`` | yes | The name of the division |
+ +-----------+----------+--------------------------+
+
+ **Request Example** ::
+
+ {
+ "name": "mydivision1"
+ }
+
+|
+
+ **Response Properties**
+
+ +----------------------+--------+------------------------------------------------+
+ | Parameter | Type | Description |
+ +======================+========+================================================+
+ |``name`` | string | |
+ +----------------------+--------+------------------------------------------------+
+ |``id`` | string | |
+ +----------------------+--------+------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": {
+ 'name': 'mydivision1',
+ 'id': '4'
+ }
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/federation.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/federation.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/federation.rst.txt
deleted file mode 100644
index a15922e..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/federation.rst.txt
+++ /dev/null
@@ -1,151 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-federation:
-
-Federation
-==========
-
-.. _to-api-v12-federation-route:
-
-/api/1.2/federations
-++++++++++++++++++++
-
-**GET /api/1.2/federations.json**
-
- Retrieves a list of federations for a user's delivery service(s).
-
- Authentication Required: Yes
-
- Role(s) Required: Federation
-
- **Response Properties**
-
- +---------------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=====================+========+====================================================+
- | ``cname`` | string | |
- +---------------------+--------+----------------------------------------------------+
- | ``ttl`` | int | Time to live for the cname. |
- +---------------------+--------+----------------------------------------------------+
- | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
- +---------------------+--------+----------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "mappings": [
- "cname": "cname-01.",
- "ttl": 8865,
- ]
- "deliveryService": "ds-01",
- }
- ]
- }
-
-|
-
-**POST /api/1.2/federations.json**
-
- Allows a user to add federations for their delivery service(s).
-
- Authentication Required: Yes
-
- Role(s) Required: Federation
-
- **Request Properties**
-
- +---------------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=====================+========+====================================================+
- | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
- +---------------------+--------+----------------------------------------------------+
- | ``resolve4`` | array | Array of IPv4 Addresses. |
- +---------------------+--------+----------------------------------------------------+
- | ``resolve6`` | array | Array of IPv6 Addresses. |
- +---------------------+--------+----------------------------------------------------+
-
- **Request Example** ::
-
- {
- "federations": [
- {
- "deliveryService": "ccp-omg-01",
- "mappings": {
- "resolve4": [
- "255.255.255.255"
- ],
- "resolve6": [
- "FE80::0202:B3FF:FE1E:8329",
- ]
- }
- }
- ]
- }
-
-|
-
-**DELETE /api/1.2/federations.json**
-
- Deletes **all** federations associated with a user's delivery service(s).
-
- Authentication Required: Yes
-
- Role(s) Required: Federation
-
-|
-
-
-**PUT /api/1.2/federations.json**
-
- Deletes **all** federations associated with a user's delivery service(s) then adds the new federations.
-
- Authentication Required: Yes
-
- Role(s) Required: Federation
-
- **Request Properties**
-
- +---------------------+--------+----------------------------------------------------+
- | Parameter | Type | Description |
- +=====================+========+====================================================+
- | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
- +---------------------+--------+----------------------------------------------------+
- | ``resolve4`` | array | Array of IPv4 Addresses. |
- +---------------------+--------+----------------------------------------------------+
- | ``resolve6`` | array | Array of IPv6 Addresses. |
- +---------------------+--------+----------------------------------------------------+
-
- **Request Example** ::
-
- {
- "federations": [
- {
- "deliveryService": "ccp-omg-01",
- "mappings": {
- "resolve4": [
- "255.255.255.255"
- ],
- "resolve6": [
- "FE80::0202:B3FF:FE1E:8329",
- ]
- }
- }
- ]
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt b/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt
new file mode 100644
index 0000000..a15922e
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/federation.txt
@@ -0,0 +1,151 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-federation:
+
+Federation
+==========
+
+.. _to-api-v12-federation-route:
+
+/api/1.2/federations
+++++++++++++++++++++
+
+**GET /api/1.2/federations.json**
+
+ Retrieves a list of federations for a user's delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Response Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``cname`` | string | |
+ +---------------------+--------+----------------------------------------------------+
+ | ``ttl`` | int | Time to live for the cname. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "mappings": [
+ "cname": "cname-01.",
+ "ttl": 8865,
+ ]
+ "deliveryService": "ds-01",
+ }
+ ]
+ }
+
+|
+
+**POST /api/1.2/federations.json**
+
+ Allows a user to add federations for their delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Request Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve4`` | array | Array of IPv4 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve6`` | array | Array of IPv6 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "federations": [
+ {
+ "deliveryService": "ccp-omg-01",
+ "mappings": {
+ "resolve4": [
+ "255.255.255.255"
+ ],
+ "resolve6": [
+ "FE80::0202:B3FF:FE1E:8329",
+ ]
+ }
+ }
+ ]
+ }
+
+|
+
+**DELETE /api/1.2/federations.json**
+
+ Deletes **all** federations associated with a user's delivery service(s).
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+|
+
+
+**PUT /api/1.2/federations.json**
+
+ Deletes **all** federations associated with a user's delivery service(s) then adds the new federations.
+
+ Authentication Required: Yes
+
+ Role(s) Required: Federation
+
+ **Request Properties**
+
+ +---------------------+--------+----------------------------------------------------+
+ | Parameter | Type | Description |
+ +=====================+========+====================================================+
+ | ``deliveryService`` | string | Unique string that describes the deliveryservice. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve4`` | array | Array of IPv4 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+ | ``resolve6`` | array | Array of IPv6 Addresses. |
+ +---------------------+--------+----------------------------------------------------+
+
+ **Request Example** ::
+
+ {
+ "federations": [
+ {
+ "deliveryService": "ccp-omg-01",
+ "mappings": {
+ "resolve4": [
+ "255.255.255.255"
+ ],
+ "resolve6": [
+ "FE80::0202:B3FF:FE1E:8329",
+ ]
+ }
+ }
+ ]
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.rst.txt
deleted file mode 100644
index 2da59c5..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.rst.txt
+++ /dev/null
@@ -1,68 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-
-.. _to-api-v12-hwinfo:
-
-Hardware Info
-=============
-
-.. _to-api-v12-hwinfo-route:
-
-/api/1.2/hwinfo
-+++++++++++++++
-
-**GET /api/1.2/hwinfo.json**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +--------------------+--------+----------------------------------------------------------------------+
- | Parameter | Type | Description |
- +====================+========+======================================================================+
- | ``serverId`` | string | Local unique identifier for this specific server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``serverHostName`` | string | Hostname for this specific server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``val`` | string | Freeform value used to track anything about a server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
- | ``description`` | string | Freeform description for this specific server's hardware info |
- +--------------------+--------+----------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "serverId": "odol-atsmid-cen-09",
- "lastUpdated": "2014-05-27 09:06:02",
- "val": "D1S4",
- "description": "Physical Disk 0:1:0"
- },
- {
- "serverId": "odol-atsmid-cen-09",
- "lastUpdated": "2014-05-27 09:06:02",
- "val": "D1S4",
- "description": "Physical Disk 0:1:1"
- }
- ]
- }
-
-|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
new file mode 100644
index 0000000..2da59c5
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/hwinfo.txt
@@ -0,0 +1,68 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+
+.. _to-api-v12-hwinfo:
+
+Hardware Info
+=============
+
+.. _to-api-v12-hwinfo-route:
+
+/api/1.2/hwinfo
++++++++++++++++
+
+**GET /api/1.2/hwinfo.json**
+
+ Authentication Required: Yes
+
+ Role(s) Required: None
+
+ **Response Properties**
+
+ +--------------------+--------+----------------------------------------------------------------------+
+ | Parameter | Type | Description |
+ +====================+========+======================================================================+
+ | ``serverId`` | string | Local unique identifier for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``serverHostName`` | string | Hostname for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``lastUpdated`` | string | The Time and Date for the last update for this server. |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``val`` | string | Freeform value used to track anything about a server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+ | ``description`` | string | Freeform description for this specific server's hardware info |
+ +--------------------+--------+----------------------------------------------------------------------+
+
+ **Response Example** ::
+
+ {
+ "response": [
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:0"
+ },
+ {
+ "serverId": "odol-atsmid-cen-09",
+ "lastUpdated": "2014-05-27 09:06:02",
+ "val": "D1S4",
+ "description": "Physical Disk 0:1:1"
+ }
+ ]
+ }
+
+|
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.rst.txt
deleted file mode 100644
index ca82cf5..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.rst.txt
+++ /dev/null
@@ -1,65 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-influxdb:
-
-InfluxDB
-==========
-
-.. Note:: The documentation needs a thorough review!
-
-**GET /api/1.2/traffic_monitor/stats.json**
-
-Authentication Required: Yes
-
-Role(s) Required: None
-
-**Response Properties**
-
-+----------------------+--------+------------------------------------------------+
-| Parameter | Type | Description |
-+======================+========+================================================+
-| ``aaData`` | array | |
-+----------------------+--------+------------------------------------------------+
-
-**Response Example**
-::
-
- {
- "aaData": [
- [
- "0",
- "ALL",
- "ALL",
- "ALL",
- "true",
- "ALL",
- "142035",
- "172365661.85"
- ],
- [
- 1,
- "EDGE1_TOP_421_PSPP",
- "odol-atsec-atl-03",
- "us-ga-atlanta",
- "1",
- "REPORTED",
- "596",
- "923510.04",
- "69.241.82.126"
- ]
- ],
- }
-
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
new file mode 100644
index 0000000..ca82cf5
--- /dev/null
+++ b/docs/latest/_sources/development/traffic_ops_api/v12/influxdb.txt
@@ -0,0 +1,65 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+
+.. _to-api-v12-influxdb:
+
+InfluxDB
+==========
+
+.. Note:: The documentation needs a thorough review!
+
+**GET /api/1.2/traffic_monitor/stats.json**
+
+Authentication Required: Yes
+
+Role(s) Required: None
+
+**Response Properties**
+
++----------------------+--------+------------------------------------------------+
+| Parameter | Type | Description |
++======================+========+================================================+
+| ``aaData`` | array | |
++----------------------+--------+------------------------------------------------+
+
+**Response Example**
+::
+
+ {
+ "aaData": [
+ [
+ "0",
+ "ALL",
+ "ALL",
+ "ALL",
+ "true",
+ "ALL",
+ "142035",
+ "172365661.85"
+ ],
+ [
+ 1,
+ "EDGE1_TOP_421_PSPP",
+ "odol-atsec-atl-03",
+ "us-ga-atlanta",
+ "1",
+ "REPORTED",
+ "596",
+ "923510.04",
+ "69.241.82.126"
+ ]
+ ],
+ }
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/0ba7314b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.rst.txt
----------------------------------------------------------------------
diff --git a/docs/latest/_sources/development/traffic_ops_api/v12/parameter.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v12/parameter.rst.txt
deleted file mode 100644
index 307d4c7..0000000
--- a/docs/latest/_sources/development/traffic_ops_api/v12/parameter.rst.txt
+++ /dev/null
@@ -1,516 +0,0 @@
-..
-..
-.. Licensed under the Apache License, Version 2.0 (the "License");
-.. you may not use this file except in compliance with the License.
-.. You may obtain a copy of the License at
-..
-.. http://www.apache.org/licenses/LICENSE-2.0
-..
-.. Unless required by applicable law or agreed to in writing, software
-.. distributed under the License is distributed on an "AS IS" BASIS,
-.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-.. See the License for the specific language governing permissions and
-.. limitations under the License.
-..
-
-.. _to-api-v12-parameter:
-
-Parameter
-=========
-
-.. _to-api-v12-parameters-route:
-
-/api/1.2/parameters
-+++++++++++++++++++
-
-**GET /api/1.2/parameters**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``last_updated`` | string | The Time / Date this server entry was last updated |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "foo.bar.net",
- "name": "domain_name",
- "config_file": "FooConfig.xml"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "0,1,2,3,4,5,6",
- "name": "Drive_Letters",
- "config_file": "storage.config"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": true,
- "value": "STRING __HOSTNAME__",
- "name": "CONFIG proxy.config.proxy_name",
- "config_file": "records.config"
- }
- ],
- }
-
-|
-
-**GET /api/1.2/parameters/:id**
-
- Authentication Required: Yes
-
- Role(s) Required: if secure of the parameter fetched is 1, require admin role, or any valid role can access.
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``id`` | integer | The parameter index |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": 0,
- "value": "foo.bar.net",
- "name": "domain_name",
- "id": "27",
- "config_file": "FooConfig.xml",
- }
- ]
- }
-
-|
-
-**GET /api/1.2/profiles/:id/parameters**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-----------------------+
- | Name | Required | Description |
- +==================+==========+=======================+
- | ``id`` | yes | Profile id |
- +------------------+----------+-----------------------+
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``last_updated`` | string | The Time / Date this server entry was last updated |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "foo.bar.net",
- "name": "domain_name",
- "config_file": "FooConfig.xml"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "0,1,2,3,4,5,6",
- "name": "Drive_Letters",
- "config_file": "storage.config"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": true,
- "value": "STRING __HOSTNAME__",
- "name": "CONFIG proxy.config.proxy_name",
- "config_file": "records.config"
- }
- ],
- }
-
-|
-
-**GET /api/1.2/profiles/name/:name/parameters**
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +------------------+----------+-----------------------+
- | Name | Required | Description |
- +==================+==========+=======================+
- | ``name`` | yes | Profile name |
- +------------------+----------+-----------------------+
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``last_updated`` | string | The Time / Date this server entry was last updated |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | boolean | When true, the parameter is accessible only by admin users. Defaults to false. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Response Example** ::
-
- {
- "response": [
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "foo.bar.net",
- "name": "domain_name",
- "config_file": "FooConfig.xml"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": false,
- "value": "0,1,2,3,4,5,6",
- "name": "Drive_Letters",
- "config_file": "storage.config"
- },
- {
- "last_updated": "2012-09-17 21:41:22",
- "secure": true,
- "value": "STRING __HOSTNAME__",
- "name": "CONFIG proxy.config.proxy_name",
- "config_file": "records.config"
- }
- ],
- }
-
-|
-
-**POST /api/1.2/parameters**
- Create parameters.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper
-
- **Request Route Parameters**
- The request route parameters accept 2 formats, both single paramter and parameters array formats are acceptable.
-
- single parameter format:
-
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +================+==========+=========+======================================================================================+
- | ``name`` | yes | string | parameter name |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``configFile`` | yes | string | parameter config_file |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``value`` | yes | string | parameter value |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- parameters array format:
-
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +=================+==========+=========+======================================================================================+
- | | yes | array | parameters array |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>name`` | yes | string | parameter name |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>configFile`` | yes | string | parameter config_file |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>value`` | yes | string | parameter value |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``>secure`` | yes | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +-----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- **Response Properties**
-
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +=================+=========+======================================================================================+
- | | array | parameters array |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>id`` | integer | The parameter id |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>name`` | string | parameter name |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>configFile`` | string | parameter config_file |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>value`` | string | parameter value |
- +-----------------+---------+--------------------------------------------------------------------------------------+
- | ``>secure`` | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +-----------------+---------+--------------------------------------------------------------------------------------+
-
-
- **Request Example** ::
-
- 1. single parameter format exampe:
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":0,
- }
-
- 2. array format example:
- [
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":0,
- },
- {
- "name":"param2",
- "configFile":"configFile2"
- "value":"value2",
- "secure":1,
- }
- ]
-
- **Response Example** ::
-
- {
- "response": [
- {
- "value":"value1",
- "secure":0,
- "name":"param1",
- "id":"1139",
- "configFile":"configFile1"
- },
- {
- "value":"value2",
- "secure":1,
- "name":"param2",
- "id":"1140",
- "configFile":"configFile2"
- }
- ]
- }
-
-|
-
-**PUT /api/1.2/parameters/{:id}**
- Edit parameter.
-
- Authentication Required: Yes
-
- Role(s) Required: if the parameter's secure equals 1, only admin role can edit the parameter, or admin or oper role can access the API.
-
- **Request Parameters**
-
- +-----------+---------+------------------+
- | Parameter | Type | Description |
- +===========+=========+==================+
- | ``id`` | integer | The parameter id |
- +-----------+---------+------------------+
-
- **Request Route Parameters**
-
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | Name | Required | Type | Description |
- +================+==========+=========+======================================================================================+
- | ``name`` | no | string | parameter name |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``configFile`` | no | string | parameter config_file |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``value`` | no | string | parameter value |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
- | ``secure`` | no | integer | secure flag, when 1, the parameter is accessible only by admin users. Defaults to 0. |
- +----------------+----------+---------+--------------------------------------------------------------------------------------+
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``id`` | integer | The parameter id |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- "secure":"0",
- }
-
- **Response Example** ::
-
- {
- "response": {
- "value":"value1",
- "secure":"0",
- "name":"param1",
- "id":"1134",
- "configFile":"configFile1"
- }
- }
-
-|
-
-**DELETE /api/1.2/parameters/{:id}**
- delete parameter. If the parameter have profile associated, can not be deleted.
-
- Authentication Required: Yes
-
- Role(s) Required: admin or oper role
-
- **Request Parameters**
-
- +-----------+---------+------------------+
- | Parameter | Type | Description |
- +===========+=========+==================+
- | ``id`` | integer | The parameter id |
- +-----------+---------+------------------+
-
- **No Request Route Parameters**
-
- **Response Properties**
-
- +-------------+--------+----------------------------------+
- | Parameter | Type | Description |
- +=============+========+==================================+
- | ``alerts`` | array | A collection of alert messages. |
- +-------------+--------+----------------------------------+
- | ``>level`` | string | Success, info, warning or error. |
- +-------------+--------+----------------------------------+
- | ``>text`` | string | Alert message. |
- +-------------+--------+----------------------------------+
- | ``version`` | string | |
- +-------------+--------+----------------------------------+
-
- **Response Example** ::
-
- Response Example:
-
- {
- "alerts":
- [
- {
- "level": "success",
- "text": "Parameter was successfully deleted."
- }
- ],
- }
-
-|
-
-**POST /api/1.2/parameters/validate**
- Validate if the parameter exists.
-
- Authentication Required: Yes
-
- Role(s) Required: None
-
- **Request Route Parameters**
-
- +----------------+----------+--------------------------------+
- | Name | Required | Type | Description |
- +================+==========+================================+
- | ``name`` | yes | string | parameter name |
- +----------------+----------+--------------------------------+
- | ``configFile`` | yes | string | parameter config_file |
- +----------------+----------+--------------------------------+
- | ``value`` | yes | string | parameter value |
- +----------------+----------+--------------------------------+
-
- **Response Properties**
-
- +------------------+---------+--------------------------------------------------------------------------------+
- | Parameter | Type | Description |
- +==================+=========+================================================================================+
- | ``id`` | integer | The parameter id |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``secure`` | integer | When 1, the parameter is accessible only by admin users. Defaults to 0. |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``value`` | string | The parameter value, only visible to admin if secure is true |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``name`` | string | The parameter name |
- +------------------+---------+--------------------------------------------------------------------------------+
- | ``config_file`` | string | The parameter config_file |
- +------------------+---------+--------------------------------------------------------------------------------+
-
- **Request Example** ::
-
- {
- "name":"param1",
- "configFile":"configFile1"
- "value":"value1",
- }
-
- **Response Example** ::
-
- {
- "response": {
- "value":"value1",
- "secure":"0",
- "name":"param1",
- "id":"1134",
- "configFile":"configFile1"
- }
- }
-
-|
-