| |
| |
| <!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.3.0 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.3.0 documentation" href="../../../index.html"/> |
| <link rel="up" title="Traffic Ops" href="../../traffic_ops.html"/> |
| <link rel="next" title="Static DNS Entries" href="static_dns.html"/> |
| <link rel="prev" title="Roles" href="role.html"/> |
| |
| |
| <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> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</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.3.0</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_api/v11/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-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.json</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="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"><span class="pre">dsId</span></code></td> |
| <td>no</td> |
| <td>Used to filter servers by delivery service.</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"><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"><em>Cache Group</em></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-v11-phys-loc"><em>Physical Location</em></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td> |
| <td>string</td> |
| <td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td> |
| <td>string</td> |
| <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-v11-status"><em>Status</em></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td> |
| <td>string</td> |
| <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-v11-type"><em>Types</em></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><span class="p">{</span> |
| <span class="s">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span> |
| <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span> |
| <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span> |
| <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span> |
| <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span> |
| <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span> |
| <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> |
| <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span> |
| <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span> |
| <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span> |
| <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span> |
| <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span> |
| <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span> |
| <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s">"lastUpdated"</span><span class="p">:</span> <span class="s">"2015-03-08 15:57:32"</span><span class="p">,</span> |
| <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> |
| <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> |
| <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> |
| <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span> |
| <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span> |
| <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span> |
| <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span> |
| <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span> |
| <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span> |
| <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span> |
| <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span> |
| <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"**********"</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/summary.json</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"><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-v11-type"><em>Types</em></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" |
| } |
| } |
| </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>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"><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-v11-cachegroup"><em>Cache Group</em></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">deliveryservices</span></code></td> |
| <td>array</td> |
| <td>Array of strings with the delivery service ids assigned (see <a class="reference internal" href="deliveryservice.html#to-api-v11-ds"><em>Delivery Service</em></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">domainName</span></code></td> |
| <td>string</td> |
| <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-v11-hwinfo"><em>Hardware Info</em></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">hostName</span></code></td> |
| <td>string</td> |
| <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-v11-phys-loc"><em>Physical Location</em></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profile</span></code></td> |
| <td>string</td> |
| <td>The assigned profile name (see <a class="reference internal" href="profile.html#to-api-v11-profile"><em>Profiles</em></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">rack</span></code></td> |
| <td>string</td> |
| <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-v11-status"><em>Status</em></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">tcpPort</span></code></td> |
| <td>string</td> |
| <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-v11-type"><em>Types</em></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><span class="p">{</span> |
| <span class="s">"response"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s">"cachegroup"</span><span class="p">:</span> <span class="s">"us-il-chicago"</span><span class="p">,</span> |
| <span class="s">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s">"1"</span><span class="p">,</span> |
| <span class="s">"2"</span><span class="p">,</span> |
| <span class="s">"3"</span><span class="p">,</span> |
| <span class="s">"4"</span> |
| <span class="p">],</span> |
| <span class="s">"domainName"</span><span class="p">:</span> <span class="s">"chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s">"YS08"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Model"</span><span class="p">:</span> <span class="s">"PowerEdge R720xd"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s">"4217A5"</span><span class="p">,</span> |
| <span class="s">"Lifecycle Controller"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Manufacturer"</span><span class="p">:</span> <span class="s">"Dell Inc."</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"SysMemTotalSize"</span><span class="p">:</span> <span class="s">"196608"</span><span class="p">,</span> |
| <span class="s">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s">"24"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s">"13.5.7"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s">"1.00"</span><span class="p">,</span> |
| <span class="s">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s">"7.0.0.29"</span><span class="p">,</span> |
| <span class="s">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s">"1.57.57"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"ServiceTag"</span><span class="p">:</span> <span class="s">"D6XPDV1"</span><span class="p">,</span> |
| <span class="s">"PowerState"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s">"D903"</span><span class="p">,</span> |
| <span class="s">"BIOS"</span><span class="p">:</span> <span class="s">"1.3.6"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"System CPLD"</span><span class="p">:</span> <span class="s">"1.0.3"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s">"04.07.15"</span><span class="p">,</span> |
| <span class="s">"PERC H710P Mini"</span><span class="p">:</span> <span class="s">"21.0.2-0001"</span><span class="p">,</span> |
| <span class="s">"PowerCap"</span><span class="p">:</span> <span class="s">"689"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s">"1.0.8.42"</span><span class="p">,</span> |
| <span class="s">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s">"1.07"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s">"7.2.20"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s">"D1S2"</span><span class="p">,</span> |
| <span class="s">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s">"D1S2"</span> |
| <span class="p">},</span> |
| <span class="s">"hostName"</span><span class="p">:</span> <span class="s">"atsec-chi-00"</span><span class="p">,</span> |
| <span class="s">"id"</span><span class="p">:</span> <span class="s">"19"</span><span class="p">,</span> |
| <span class="s">"iloIpAddress"</span><span class="p">:</span> <span class="s">"172.16.2.6"</span><span class="p">,</span> |
| <span class="s">"iloIpGateway"</span><span class="p">:</span> <span class="s">"172.16.2.1"</span><span class="p">,</span> |
| <span class="s">"iloIpNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s">"iloPassword"</span><span class="p">:</span> <span class="s">"********"</span><span class="p">,</span> |
| <span class="s">"iloUsername"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> |
| <span class="s">"interfaceMtu"</span><span class="p">:</span> <span class="s">"9000"</span><span class="p">,</span> |
| <span class="s">"interfaceName"</span><span class="p">:</span> <span class="s">"bond0"</span><span class="p">,</span> |
| <span class="s">"ip6Address"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span> |
| <span class="s">"ip6Gateway"</span><span class="p">:</span> <span class="s">"2033:D0D0:3300::2:1"</span><span class="p">,</span> |
| <span class="s">"ipAddress"</span><span class="p">:</span> <span class="s">"10.10.2.2"</span><span class="p">,</span> |
| <span class="s">"ipGateway"</span><span class="p">:</span> <span class="s">"10.10.2.1"</span><span class="p">,</span> |
| <span class="s">"ipNetmask"</span><span class="p">:</span> <span class="s">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s">"mgmtIpAddress"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> |
| <span class="s">"mgmtIpGateway"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> |
| <span class="s">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s">""</span><span class="p">,</span> |
| <span class="s">"physLocation"</span><span class="p">:</span> <span class="s">"plocation-chi-1"</span><span class="p">,</span> |
| <span class="s">"profile"</span><span class="p">:</span> <span class="s">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span> |
| <span class="s">"rack"</span><span class="p">:</span> <span class="s">"RR 119.02"</span><span class="p">,</span> |
| <span class="s">"routerHostName"</span><span class="p">:</span> <span class="s">"rtr-chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s">"routerPortName"</span><span class="p">:</span> <span class="s">"2"</span><span class="p">,</span> |
| <span class="s">"status"</span><span class="p">:</span> <span class="s">"ONLINE"</span><span class="p">,</span> |
| <span class="s">"tcpPort"</span><span class="p">:</span> <span class="s">"80"</span><span class="p">,</span> |
| <span class="s">"type"</span><span class="p">:</span> <span class="s">"EDGE"</span><span class="p">,</span> |
| <span class="s">"xmppId"</span><span class="p">:</span> <span class="s">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span> |
| <span class="s">"xmppPasswd"</span><span class="p">:</span> <span class="s">"X"</span> |
| |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </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"><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> |
| </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"><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." |
| } |
| ], |
| } |
| </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> |
| |
| |
| |
| |
| |
| <script type="text/javascript"> |
| var DOCUMENTATION_OPTIONS = { |
| URL_ROOT:'../../../', |
| VERSION:'1.3.0', |
| 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> |