http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/server.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/server.html b/docs/1.1.2/development/traffic_ops_rest/server.html new file mode 100644 index 0000000..53e0e38 --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/server.html @@ -0,0 +1,861 @@ + + +<!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 1.1.2 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="top" title="Traffic Control 1.1.2 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"/> + + + <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.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_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_portal.html">Traffic Portal</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_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</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_monitor.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> +</ul> +</li> +</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="reference internal" href="../traffic_ops.html">Traffic Ops</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> +<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> +</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 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Server</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/server.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-server"></span><h1>Server<a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h1> +<p><strong>GET /api/1.1/servers.json</strong></p> +<blockquote> +<div><p>Retrieves properties of CDN servers.</p> +<p>Authentication Required: Yes</p> +<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"><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-cachegroup"><span>Cache Group</span></a>).</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><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-even"><td><code class="docutils literal"><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"><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"><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"><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"><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"><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"><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"><span class="pre">interfaceMtu</span></code></td> +<td>string</td> +<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><span class="pre">ip6Address</span></code></td> +<td>string</td> +<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td> +<td>string</td> +<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td> +<td>string</td> +<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td> +<td>string</td> +<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td> +<td>string</td> +<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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-odd"><td><code class="docutils literal"><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"><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"><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"><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-phys-loc"><span>Physical Location</span></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-profile"><span>Profiles</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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"><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"><span class="pre">status</span></code></td> +<td>string</td> +<td>The Status string (See <a class="reference internal" href="status.html#to-api-status"><span>Status</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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-type"><span>Types</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td> +<td>string</td> +<td>Deprecated.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><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-python"><div class="highlight"><pre>{ + "response": [ + { + "cachegroup": "us-il-chicago", + "domainName": "chi.kabletown.net", + "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": "", + "physLocation": "plocation-chi-1", + "profile": "EDGE1_CDN1_421_SSL", + "rack": "RR 119.02", + "routerHostName": "rtr-chi.kabletown.net", + "routerPortName": "2", + "status": "ONLINE", + "tcpPort": "80", + "type": "EDGE", + "xmppId": "atsec-chi-00-dummyxmpp", + "xmppPasswd": "**********" + }, + { + ... more server data + } + ] + "version": "1.1" + } +</pre></div> +</div> +</div></blockquote> +<div class="line-block"> +<div class="line"><br /></div> +</div> +<p><strong>GET /api/1.1/servers/summary.json</strong></p> +<blockquote> +<div><p>Retrieves a count of CDN servers by type.</p> +<p>Authentication Required: Yes</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="13%" /> +<col width="9%" /> +<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"><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"><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-type"><span>Types</span></a>).</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre>{ + "response": [ + { + "count": 4, + "type": "CCR" + }, + { + "count": 55, + "type": "EDGE" + }, + { + "type": "MID", + "count": 18 + }, + { + "count": 0, + "type": "REDIS" + }, + { + "count": 4, + "type": "RASCAL" + } + "version": "1.1", +} +</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.json</strong></p> +<blockquote> +<div><p>Retrieves the details of a server.</p> +<p>Authentication Required: Yes</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"><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"><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-cachegroup"><span>Cache Group</span></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-ds"><span>Delivery Service</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><span class="pre">hardwareInfo</span></code></td> +<td>hash</td> +<td>Hwinfo struct (see <a class="reference internal" href="hwinfo.html#to-api-hwinfo"><span>hwinfo</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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"><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"><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"><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"><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"><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"><span class="pre">interfaceMtu</span></code></td> +<td>string</td> +<td>The Maximum Transmission Unit (MTU) to configure for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><span class="pre">ip6Address</span></code></td> +<td>string</td> +<td>The IPv6 address/netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">ip6Gateway</span></code></td> +<td>string</td> +<td>The IPv6 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipAddress</span></code></td> +<td>string</td> +<td>The IPv4 address for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">ipGateway</span></code></td> +<td>string</td> +<td>The IPv4 gateway for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">ipNetmask</span></code></td> +<td>string</td> +<td>The IPv4 netmask for <code class="docutils literal"><span class="pre">interfaceName</span></code>.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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"><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"><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"><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-phys-loc"><span>Physical Location</span></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-profile"><span>Profiles</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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"><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"><span class="pre">status</span></code></td> +<td>string</td> +<td>The Status string (See <a class="reference internal" href="status.html#to-api-status"><span>Status</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><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"><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-type"><span>Types</span></a>).</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td> +<td>string</td> +<td>Deprecated.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><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-python"><div class="highlight"><pre>{ + "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", + "type": "EDGE", + "xmppId": "atsec-chi-00-dummyxmpp", + "xmppPasswd": "X" + + } + "version": "1.1", + +} +</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><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"><span class="pre">id</span></code></td> +<td>yes</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">host_name</span></code></td> +<td>yes</td> +<td> </td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">servercheck_short_name</span></code></td> +<td>yes</td> +<td> </td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">value</span></code></td> +<td>yes</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Request Example</strong></p> +<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> +<p>Response Content Type: application/json</p> +<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"><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"><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"><span class="pre">>text</span></code></td> +<td>string</td> +<td>Alert message.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">version</span></code></td> +<td>string</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre>Response Example: + +{ + "alerts": + [ + { + "level": "success", + "text": "Server Check was successfully updated." + } + ], + "version": "1.1" +} +</pre></div> +</div> +</div></blockquote> +</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> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </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
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/static_dns.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/static_dns.html b/docs/1.1.2/development/traffic_ops_rest/static_dns.html new file mode 100644 index 0000000..2fe8dfa --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/static_dns.html @@ -0,0 +1,281 @@ + + +<!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>Static DNS Entries — Traffic Control 1.1.2 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="top" title="Traffic Control 1.1.2 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"/> + + + <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.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_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_portal.html">Traffic Portal</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_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</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_monitor.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> +</ul> +</li> +</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="reference internal" href="../traffic_ops.html">Traffic Ops</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> +<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> +</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 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Static DNS Entries</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/static_dns.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="status.html" class="btn btn-neutral float-right" title="Status">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="server.html" class="btn btn-neutral" title="Server"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="static-dns-entries"> +<span id="to-api-dns"></span><h1>Static DNS Entries<a class="headerlink" href="#static-dns-entries" title="Permalink to this headline">¶</a></h1> +<p><strong>GET /api/1.1/staticdnsentries.json</strong></p> +<p>Authentication Required: Yes</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="28%" /> +<col width="10%" /> +<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>TBD</td> +<td>array</td> +<td> </td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre><span class="n">TBD</span> +</pre></div> +</div> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="status.html" class="btn btn-neutral float-right" title="Status">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="server.html" class="btn btn-neutral" title="Server"><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> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </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 http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/status.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/status.html b/docs/1.1.2/development/traffic_ops_rest/status.html new file mode 100644 index 0000000..59f7c6a --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/status.html @@ -0,0 +1,330 @@ + + +<!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>Status — Traffic Control 1.1.2 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="top" title="Traffic Control 1.1.2 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"/> + + + <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.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_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_portal.html">Traffic Portal</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_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</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_monitor.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> +</ul> +</li> +</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="reference internal" href="../traffic_ops.html">Traffic Ops</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> +<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> +</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 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>Status</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/status.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="system.html" class="btn btn-neutral float-right" title="System">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="static_dns.html" class="btn btn-neutral" title="Static DNS Entries"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="status"> +<span id="to-api-status"></span><h1>Status<a class="headerlink" href="#status" title="Permalink to this headline">¶</a></h1> +<p><strong>GET /api/1.1/statuses.json</strong></p> +<blockquote> +<div><p>Retrieves a list of the server status codes available. May be useful when the status is retrieved from other APIs as a number and not a string.</p> +<p>Authentication Required: Yes</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="16%" /> +<col width="8%" /> +<col width="76%" /> +</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"><span class="pre">lastUpdated</span></code></td> +<td>string</td> +<td>The Time / Date this server entry was last updated</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">name</span></code></td> +<td>string</td> +<td>The string equivalent of the status</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> +<td>string</td> +<td>The id with which Traffic Ops stores this status, and references it internally</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">description</span></code></td> +<td>string</td> +<td>A short description of the status</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<div class="highlight-python"><div class="highlight"><pre> { + "response": [ + { + "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", + "id": "4", + "name": "ADMIN_DOWN", + "lastUpdated": "2013-02-13 16:34:29" + }, + { + "lastUpdated": "2013-02-13 16:34:29", + "name": "CCR_IGNORE", + "id": "5", + "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now" + }, + { + "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", + "id": "1", + "lastUpdated": "2013-02-13 16:34:29", + "name": "OFFLINE" + }, + { + "id": "2", + "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", + "name": "ONLINE" + }, + { + "id": "3", + "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now", + "name": "REPORTED", + "lastUpdated": "2013-02-13 16:34:29" + } + ], + "version": "1.1" +} +</pre></div> +</div> +</div></blockquote> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="system.html" class="btn btn-neutral float-right" title="System">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="static_dns.html" class="btn btn-neutral" title="Static DNS Entries"><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> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </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 http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/8582b168/docs/1.1.2/development/traffic_ops_rest/system.html ---------------------------------------------------------------------- diff --git a/docs/1.1.2/development/traffic_ops_rest/system.html b/docs/1.1.2/development/traffic_ops_rest/system.html new file mode 100644 index 0000000..54586ba --- /dev/null +++ b/docs/1.1.2/development/traffic_ops_rest/system.html @@ -0,0 +1,333 @@ + + +<!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>System — Traffic Control 1.1.2 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="top" title="Traffic Control 1.1.2 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"/> + + + <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.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_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_portal.html">Traffic Portal</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_install.html">Installing Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_config.html">Configuring Traffic Ops</a></li> +<li class="toctree-l2"><a class="reference internal" href="../../admin/traffic_ops_using.html">Using Traffic Ops</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_monitor.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> +</ul> +</li> +</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="reference internal" href="../traffic_ops.html">Traffic Ops</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> +<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> +</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 1.1.2</a> »</li> + + <li><a href="../index.html">Developer’s Guide</a> »</li> + + <li><a href="../traffic_ops.html">Traffic Ops</a> »</li> + + <li>System</li> + <li class="wy-breadcrumbs-aside"> + + <a href="../../_sources/development/traffic_ops_rest/system.txt" rel="nofollow"> View page source</a> + + </li> + </ul> + <hr/> +</div> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="to_extension.html" class="btn btn-neutral float-right" title="TO Extensions">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="status.html" class="btn btn-neutral" title="Status"><span class="fa fa-arrow-circle-left"></span> Previous</a> + + </div> + + <div role="main" class="document"> + + <div class="section" id="system"> +<span id="to-api-sys"></span><h1>System<a class="headerlink" href="#system" title="Permalink to this headline">¶</a></h1> +<p><strong>GET /api/1.1/system/info.json</strong></p> +<blockquote> +<div><p>Authentication Required: Yes</p> +<p><strong>Response Properties</strong></p> +<table border="1" class="docutils"> +<colgroup> +<col width="16%" /> +<col width="5%" /> +<col width="79%" /> +</colgroup> +<thead valign="bottom"> +<tr class="row-odd"><th class="head">Key</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"><span class="pre">parameters</span></code></td> +<td>hash</td> +<td>This is a hash with the parameter names that describe the Traffic Ops installation as keys. +These are all the parameters in the <code class="docutils literal"><span class="pre">GLOBAL</span></code> profile.</td> +</tr> +<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> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tm.instance_name</span></code></td> +<td>string</td> +<td>The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>traffic_rtr_fwd_proxy</span></code></td> +<td>string</td> +<td>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.</td> +</tr> +<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> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>traffic_mon_fwd_proxy</span></code></td> +<td>string</td> +<td>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.</td> +</tr> +<tr class="row-even"><td><code class="docutils literal"><span class="pre">>tm.logourl</span></code></td> +<td>string</td> +<td>This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public.</td> +</tr> +<tr class="row-odd"><td><code class="docutils literal"><span class="pre">>tm.infourl</span></code></td> +<td>string</td> +<td>This is the “for more information go here” URL, which is visible in the About page.</td> +</tr> +</tbody> +</table> +<p><strong>Response Example</strong></p> +<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="s">"version"</span><span class="p">:</span> <span class="s">"1.1"</span> +<span class="p">}</span> +</pre></div> +</div> +</div></blockquote> +</div> + + + </div> + <footer> + + <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> + + <a href="to_extension.html" class="btn btn-neutral float-right" title="TO Extensions">Next <span class="fa fa-arrow-circle-right"></span></a> + + + <a href="status.html" class="btn btn-neutral" title="Status"><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> + + + + + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT:'../../', + VERSION:'1.1.2', + COLLAPSE_INDEX:false, + FILE_SUFFIX:'.html', + HAS_SOURCE: true + }; + </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
