http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/2ca12610/docs/master/api/v11/server.html
----------------------------------------------------------------------
diff --git a/docs/master/api/v11/server.html b/docs/master/api/v11/server.html
new file mode 100644
index 0000000..7ef6bc8
--- /dev/null
+++ b/docs/master/api/v11/server.html
@@ -0,0 +1,1248 @@
+
+
+
+
+<!DOCTYPE html>
+<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
+<head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <title>Server — Traffic Control 2.2-dev documentation </title>
+
+
+
+
+ <link rel="shortcut icon" href="../../_static/favicon.ico"/>
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css"
/>
+
+
+
+ <link rel="stylesheet" href="../../_static/theme_overrides.css"
type="text/css" />
+
+
+
+ <link rel="index" title="Index"
+ href="../../genindex.html"/>
+ <link rel="search" title="Search" href="../../search.html"/>
+ <link rel="top" title="Traffic Control 2.2-dev documentation"
href="../../index.html"/>
+ <link rel="up" title="API 1.1 Reference" href="index.html"/>
+ <link rel="next" title="Static DNS Entries" href="static_dns.html"/>
+ <link rel="prev" title="Roles" href="role.html"/>
+
+
+ <script src="_static/js/modernizr.min.js"></script>
+
+</head>
+
+<body class="wy-body-for-nav" role="document">
+
+ <div class="wy-grid-for-nav">
+
+
+ <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+ <div class="wy-side-nav-search">
+
+
+
+ <a href="/" class="icon icon-home"> Traffic Control
+
+
+
+
+ <img src="../../_static/tc_logo_c_only.png" class="logo" />
+
+ </a>
+
+
+<div role="search">
+ <form id="rtd-search-form" class="wy-form" action="../../search.html"
method="get">
+ <input type="text" name="q" placeholder="Search docs" />
+ <input type="hidden" name="check_keywords" value="yes" />
+ <input type="hidden" name="area" value="default" />
+ </form>
+</div>
+
+
+ </div>
+
+ <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation"
aria-label="main navigation">
+
+
+
+ <ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../basics/index.html">CDN Basics</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../basics/content_delivery_networks.html">Content Delivery
Networks</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../basics/http_11.html">HTTP 1.1</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../basics/caching_proxies.html">Caching Proxies</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../basics/cache_revalidation.html">Cache Control Headers and
Revalidation</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../overview/index.html">Traffic Control Overview</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/introduction.html">Introduction</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_monitor.html">Traffic Monitor</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_server.html">Traffic Server</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../overview/traffic_vault.html">Traffic Vault</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../admin/index.html">Administratorâs Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/installation.html">Traffic Ops -
Installing</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default
Profiles</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops -
Migrating from 1.x to 2.x</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/migration_from_20_to_22.html">Traffic Ops -
Migrating from 2.0 to 2.2</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/configuration.html">Traffic Ops -
Configuring</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_ops/extensions.html">Managing Traffic Ops
Extensions</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_portal/installation.html">Traffic Portal
Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_portal/usingtrafficportal.html">Traffic Portal -
Using</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_monitor.html">Traffic Monitor Administration
(Legacy)</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_monitor_golang.html">Traffic Monitor
Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_router.html">Traffic Router Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_stats.html">Traffic Stats Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_server.html">Traffic Server Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/traffic_vault.html">Traffic Vault Administration</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../admin/quick_howto/index.html">Quick How To Guides</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../development/index.html">Developerâs Guide</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/building.html">Building Traffic Control</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_ops.html">Traffic Ops</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_portal.html">Traffic Portal</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_router.html">Traffic Router</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_monitor.html">Traffic Monitor Golang</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_stats.html">Traffic Stats</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../development/traffic_server.html">Traffic Server</a></li>
+</ul>
+</li>
+</ul>
+<ul class="current">
+<li class="toctree-l1 current"><a class="reference internal"
href="../index.html">APIs</a><ul class="current">
+<li class="toctree-l2"><a class="reference internal"
href="../traffic_ops_api.html">API Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="../routes.html">API
Routes</a></li>
+<li class="toctree-l2 current"><a class="reference internal"
href="index.html">API 1.1 Reference</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../v12/index.html">API 1.2 Reference</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../faq/index.html">FAQ</a><ul>
+<li class="toctree-l2"><a class="reference internal"
href="../../faq/general.html">General</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../faq/development.html">Development</a></li>
+<li class="toctree-l2"><a class="reference internal"
href="../../faq/administration.html">Running a Traffic Control CDN</a></li>
+</ul>
+</li>
+</ul>
+<ul>
+<li class="toctree-l1"><a class="reference internal"
href="../../glossary.html">Glossary</a></li>
+</ul>
+
+
+
+ </div>
+
+ </nav>
+
+ <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
+
+
+ <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
+ <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+ <a href="../../index.html">Traffic Control</a>
+ </nav>
+
+
+
+ <div class="wy-nav-content">
+ <div class="rst-content">
+ <div role="navigation" aria-label="breadcrumbs navigation">
+ <ul class="wy-breadcrumbs">
+ <li><a href="../../index.html">Traffic Control 2.2-dev</a> »</li>
+
+ <li><a href="../index.html">APIs</a> »</li>
+
+ <li><a href="index.html">API 1.1 Reference</a> »</li>
+
+ <li>Server</li>
+ <li class="wy-breadcrumbs-aside">
+
+ <a href="../../_sources/api/v11/server.rst.txt" rel="nofollow"> View
page source</a>
+
+ </li>
+ </ul>
+ <hr/>
+</div>
+
+ <div class="rst-footer-buttons" role="navigation"
aria-label="footer navigation">
+
+ <a href="static_dns.html" class="btn btn-neutral
float-right" title="Static DNS Entries">Next <span class="fa
fa-arrow-circle-right"></span></a>
+
+
+ <a href="role.html" class="btn btn-neutral"
title="Roles"><span class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+ <div role="main" class="document">
+
+ <div class="section" id="server">
+<span id="to-api-v11-server"></span><h1>Server<a class="headerlink"
href="#server" title="Permalink to this headline">¶</a></h1>
+<div class="section" id="api-1-1-servers">
+<span id="to-api-v11-servers-route"></span><h2>/api/1.1/servers<a
class="headerlink" href="#api-1-1-servers" title="Permalink to this
headline">¶</a></h2>
+<p><strong>GET /api/1.1/servers</strong></p>
+<blockquote>
+<div><p>Retrieves properties of CDN servers.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Query Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="27%" />
+<col width="13%" />
+<col width="60%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">dsId</span></code></td>
+<td>no</td>
+<td>Used to filter servers by delivery service.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">status</span></code></td>
+<td>no</td>
+<td>Used to filter servers by status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">type</span></code></td>
+<td>no</td>
+<td>Used to filter servers by type.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most
cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as
<strong>**</strong> unless you are an âadminâ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils
literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal
notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE
status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache
in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"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="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>
+ <span class="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/servers/:id</strong></p>
+<blockquote>
+<div><p>Retrieves properties of a CDN server by server ID.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="17%" />
+<col width="15%" />
+<col width="68%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>yes</td>
+<td>Server id.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="15%" />
+<col width="6%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">cachegroupId</span></code></td>
+<td>string</td>
+<td>The cache group id.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">cdnId</span></code></td>
+<td>string</td>
+<td>Id of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">cdnName</span></code></td>
+<td>string</td>
+<td>Name of the CDN to which the server belongs to.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">guid</span></code></td>
+<td>string</td>
+<td>An identifier used to uniquely identify the server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The HTTPS port on which the main application listens (443 in most
cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as
<strong>**</strong> unless you are an âadminâ user).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils
literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal
notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time and Date for the last update for this server.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">offlineReason</span></code></td>
+<td>string</td>
+<td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE
status.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache
in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">updPending</span></code></td>
+<td>bool</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="p">{</span>
+ <span class="s2">"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="p">}</span>
+ <span class="p">]</span>
+ <span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/servers/summary</strong></p>
+<blockquote>
+<div><p>Retrieves a count of CDN servers by type.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="12%" />
+<col width="9%" />
+<col width="79%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">count</span></code></td>
+<td>int</td>
+<td>The number of servers of this type in this instance of Traffic Ops.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><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>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>GET /api/1.1/servers/hostname/:name/details</strong></p>
+<blockquote>
+<div><p>Retrieves the details of a server.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="19%" />
+<col width="19%" />
+<col width="63%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">name</span></code></td>
+<td>yes</td>
+<td>The host name part of the cache.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="16%" />
+<col width="6%" />
+<col width="78%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">domainName</span></code></td>
+<td>string</td>
+<td>The domain name part of the FQDN of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">hostName</span></code></td>
+<td>string</td>
+<td>The host name part of the cache.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>string</td>
+<td>The server id (database row number).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">iloIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">iloIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway address of the lights-out-management port.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">iloIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the lights-out-management port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">iloPassword</span></code></td>
+<td>string</td>
+<td>The password of the of the lights-out-management user (displays as
<strong>**</strong> unless you are an âadminâ user).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">iloUsername</span></code></td>
+<td>string</td>
+<td>The user name for lights-out-management.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">interfaceMtu</span></code></td>
+<td>string</td>
+<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils
literal notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code></td>
+<td>string</td>
+<td>The network interface name used for serving traffic.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">ip6Address</span></code></td>
+<td>string</td>
+<td>The IPv6 address/netmask for <code class="docutils literal
notranslate"><span class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">ip6Gateway</span></code></td>
+<td>string</td>
+<td>The IPv6 gateway for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">ipAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">ipGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">ipNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask for <code class="docutils literal notranslate"><span
class="pre">interfaceName</span></code>.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">lastUpdated</span></code></td>
+<td>string</td>
+<td>The Time/Date of the last update for this server.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">mgmtIpAddress</span></code></td>
+<td>string</td>
+<td>The IPv4 address of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">mgmtIpGateway</span></code></td>
+<td>string</td>
+<td>The IPv4 gateway of the management port (optional).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">mgmtIpNetmask</span></code></td>
+<td>string</td>
+<td>The IPv4 netmask of the management port (optional).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">rack</span></code></td>
+<td>string</td>
+<td>A string indicating rack location.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">routerHostName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">routerPortName</span></code></td>
+<td>string</td>
+<td>The human readable name of the router port.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">tcpPort</span></code></td>
+<td>string</td>
+<td>The default TCP port on which the main application listens (80 for a cache
in most cases).</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">httpsPort</span></code></td>
+<td>string</td>
+<td>The default HTTPS port on which the main application listens (443 for a
cache in most cases).</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><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>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">xmppId</span></code></td>
+<td>string</td>
+<td>Deprecated.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">xmppPasswd</span></code></td>
+<td>string</td>
+<td>Deprecated.</td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><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>
+ <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="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="p">}</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<p><strong>POST /api/1.1/servercheck</strong></p>
+<blockquote>
+<div><p>Post a server check result to the serverchecks table.</p>
+<p>Authentication Required: Yes</p>
+<p>Role(s) Required: None</p>
+<p><strong>Request Route Parameters</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="55%" />
+<col width="20%" />
+<col width="25%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Name</th>
+<th class="head">Required</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">id</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">host_name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">servercheck_short_name</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">value</span></code></td>
+<td>yes</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Request Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><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>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+<div class="line-block">
+<div class="line"><br /></div>
+</div>
+<blockquote>
+<div><p><strong>Response Properties</strong></p>
+<table border="1" class="docutils">
+<colgroup>
+<col width="24%" />
+<col width="15%" />
+<col width="62%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Parameter</th>
+<th class="head">Type</th>
+<th class="head">Description</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">alerts</span></code></td>
+<td>array</td>
+<td>A collection of alert messages.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">>level</span></code></td>
+<td>string</td>
+<td>Success, info, warning or error.</td>
+</tr>
+<tr class="row-even"><td><code class="docutils literal notranslate"><span
class="pre">>text</span></code></td>
+<td>string</td>
+<td>Alert message.</td>
+</tr>
+<tr class="row-odd"><td><code class="docutils literal notranslate"><span
class="pre">version</span></code></td>
+<td>string</td>
+<td> </td>
+</tr>
+</tbody>
+</table>
+<p><strong>Response Example</strong></p>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span
class="n">Response</span> <span class="n">Example</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">"Server Check was successfully updated."</span>
+ <span class="p">}</span>
+ <span class="p">],</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</div></blockquote>
+</div>
+</div>
+
+
+ </div>
+ <footer>
+
+ <div class="rst-footer-buttons" role="navigation" aria-label="footer
navigation">
+
+ <a href="static_dns.html" class="btn btn-neutral float-right"
title="Static DNS Entries">Next <span class="fa
fa-arrow-circle-right"></span></a>
+
+
+ <a href="role.html" class="btn btn-neutral" title="Roles"><span
class="fa fa-arrow-circle-left"></span> Previous</a>
+
+ </div>
+
+
+ <hr/>
+
+ <div role="contentinfo">
+ <p>
+ </p>
+ </div>
+ Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a
href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a
href="https://readthedocs.org">Read the Docs</a>.
+
+</footer>
+
+ </div>
+ </div>
+
+ </section>
+
+ </div>
+
+
+
+ <div class="rst-versions" data-toggle="rst-versions" role="note"
aria-label="versions">
+ <span class="rst-current-version" data-toggle="rst-current-version">
+ <span class="fa fa-book">Apache Traffic Control (Incubating)</span>
+ v:
+ <span class="fa fa-caret-down"></span>
+ </span>
+ <div class="rst-other-versions">
+ <dl>
+ <dt>Versions</dt>
+ <dd><a href="/docs/master/">latest</a></dd>
+ <dd><a href="/docs/2.0/">2.0</a></dd>
+ <dd><a href="/docs/1.8.1/">1.8</a></dd>
+ <dd><a href="/docs/1.7.0/">1.7</a></dd>
+ </dl>
+ <hr/>
+ Free document hosting provided by <a
href="http://www.readthedocs.org">Read the Docs</a>.
+
+ </div>
+ </div>
+
+
+
+ <script type="text/javascript">
+ var DOCUMENTATION_OPTIONS = {
+ URL_ROOT:'../../',
+ VERSION:'2.2-dev',
+ COLLAPSE_INDEX:false,
+ FILE_SUFFIX:'.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt'
+ };
+ </script>
+ <script type="text/javascript" src="../../_static/jquery.js"></script>
+ <script type="text/javascript"
src="../../_static/underscore.js"></script>
+ <script type="text/javascript" src="../../_static/doctools.js"></script>
+
+
+
+
+
+ <script type="text/javascript" src="../../_static/js/theme.js"></script>
+
+
+
+
+ <script type="text/javascript">
+ jQuery(function () {
+ SphinxRtdTheme.StickyNav.enable();
+ });
+ </script>
+
+
+</body>
+</html>
\ No newline at end of file