| |
| |
| <!DOCTYPE html> |
| <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> |
| <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> |
| <head> |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| |
| <title>Server — Traffic Control 2.1-dev documentation </title> |
| |
| |
| |
| |
| <link rel="shortcut icon" href="../../../_static/favicon.ico"/> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> |
| |
| |
| |
| <link rel="stylesheet" href="../../../_static/theme_overrides.css" type="text/css" /> |
| |
| |
| |
| <link rel="top" title="Traffic Control 2.1-dev 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_c_only.png" class="logo" /> |
| |
| </a> |
| |
| |
| <div role="search"> |
| <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> |
| <input type="text" name="q" placeholder="Search docs" /> |
| <input type="hidden" name="check_keywords" value="yes" /> |
| <input type="hidden" name="area" value="default" /> |
| </form> |
| </div> |
| |
| |
| </div> |
| |
| <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> |
| |
| |
| |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../basics/index.html">CDN Basics</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../../basics/content_delivery_networks.html">Content Delivery Networks</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../basics/http_11.html">HTTP 1.1</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../basics/caching_proxies.html">Caching Proxies</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../basics/cache_revalidation.html">Cache Control Headers and Revalidation</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../overview/index.html">Traffic Control Overview</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/introduction.html">Introduction</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_ops.html">Traffic Ops</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_monitor.html">Traffic Monitor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_stats.html">Traffic Stats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_server.html">Traffic Server</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../overview/traffic_vault.html">Traffic Vault</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul> |
| <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">Administrator’s Guide</a><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/installation.html">Traffic Ops - Installing</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/default_profiles.html">Traffic Ops - Default Profiles</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/migration_from_10_to_20.html">Traffic Ops - Migrating from 1.x to 2.x</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/configuration.html">Traffic Ops - Configuring</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/using.html">Traffic Ops - Using</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_ops/extensions.html">Managing Traffic Ops Extensions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_portal.html">Traffic Portal Administration</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_monitor_golang.html">Traffic Monitor Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_router.html">Traffic Router Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_stats.html">Traffic Stats Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_server.html">Traffic Server Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/traffic_vault.html">Traffic Vault Administration</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../../admin/quick_howto/index.html">Quick How To Guides</a></li> |
| </ul> |
| </li> |
| </ul> |
| <ul 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"><a class="reference internal" href="../../building.html">Building Traffic Control</a></li> |
| <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_portal.html">Traffic Portal</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_router.html">Traffic Router</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor.html">Traffic Monitor</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../../traffic_monitor_golang.html">Traffic Monitor Golang</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 2.1-dev</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/v12/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-v12-server"></span><h1>Server<a class="headerlink" href="#server" title="Permalink to this headline">¶</a></h1> |
| <div class="section" id="api-1-2-servers"> |
| <span id="to-api-v12-servers-route"></span><h2>/api/1.2/servers<a class="headerlink" href="#api-1-2-servers" title="Permalink to this headline">¶</a></h2> |
| <p><strong>GET /api/1.2/servers</strong></p> |
| <blockquote> |
| <div><p>Retrieves properties of CDN servers.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request Query Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="27%" /> |
| <col width="13%" /> |
| <col width="60%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">dsId</span></code></td> |
| <td>no</td> |
| <td>Used to filter servers by delivery service.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">status</span></code></td> |
| <td>no</td> |
| <td>Used to filter servers by status.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>no</td> |
| <td>Used to filter servers by type.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileId</span></code></td> |
| <td>no</td> |
| <td>Used to filter servers by profile ID.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cdn</span></code></td> |
| <td>no</td> |
| <td>Used to filter servers by CDN ID.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td> |
| <td>no</td> |
| <td>Used to filter servers by cache group ID.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td> |
| <td>no</td> |
| <td>Used to filter servers by phys location ID.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="15%" /> |
| <col width="6%" /> |
| <col width="79%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td> |
| <td>string</td> |
| <td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td> |
| <td>string</td> |
| <td>The cache group id.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td> |
| <td>string</td> |
| <td>Id of the CDN to which the server belongs to.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> |
| <td>string</td> |
| <td>Name of the CDN to which the server belongs to.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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">guid</span></code></td> |
| <td>string</td> |
| <td>An identifier used to uniquely identify the server.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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">httpsPort</span></code></td> |
| <td>string</td> |
| <td>The HTTPS port on which the main application listens (443 in most cases).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td>The server id (database row number).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td> |
| <td>string</td> |
| <td>The IPv4 address of the lights-out-management port.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td> |
| <td>string</td> |
| <td>The IPv4 gateway address of the lights-out-management port.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td> |
| <td>string</td> |
| <td>The IPv4 netmask of the lights-out-management port.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td> |
| <td>string</td> |
| <td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td> |
| <td>string</td> |
| <td>The user name for lights-out-management.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td> |
| <td>string</td> |
| <td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td> |
| <td>string</td> |
| <td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td> |
| <td>string</td> |
| <td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td> |
| <td>string</td> |
| <td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td> |
| <td>string</td> |
| <td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td> |
| <td>string</td> |
| <td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td> |
| <td>string</td> |
| <td>A string indicating rack location.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td> |
| <td>string</td> |
| <td>The human readable name of the router.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td> |
| <td>string</td> |
| <td>The human readable name of the router port.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td> |
| <td>string</td> |
| <td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td> |
| <td>string</td> |
| <td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> |
| <td>string</td> |
| <td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span> |
| <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> |
| <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> |
| <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span> |
| <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span> |
| <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span> |
| <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span> |
| <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span> |
| <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span> |
| <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span> |
| <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span> |
| <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span> |
| <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span> |
| <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span> |
| <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span> |
| <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span> |
| <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span> |
| <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span> |
| <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span> |
| <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span> |
| <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span> |
| <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span> |
| <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> |
| <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span> |
| <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> |
| <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span> |
| <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span> |
| <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> |
| <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="o">...</span> <span class="n">more</span> <span class="n">server</span> <span class="n">data</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>GET /api/1.2/servers/:id</strong></p> |
| <blockquote> |
| <div><p>Retrieves properties of a CDN server by server ID.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="17%" /> |
| <col width="15%" /> |
| <col width="68%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>yes</td> |
| <td>Server id.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="15%" /> |
| <col width="6%" /> |
| <col width="79%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Parameter</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cachegroup</span></code></td> |
| <td>string</td> |
| <td>The cache group name (see <a class="reference internal" href="../v11/cachegroup.html#to-api-v11-cachegroup"><span class="std std-ref">Cache Group</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cachegroupId</span></code></td> |
| <td>string</td> |
| <td>The cache group id.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td> |
| <td>string</td> |
| <td>Id of the CDN to which the server belongs to.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> |
| <td>string</td> |
| <td>Name of the CDN to which the server belongs to.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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">guid</span></code></td> |
| <td>string</td> |
| <td>An identifier used to uniquely identify the server.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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">httpsPort</span></code></td> |
| <td>string</td> |
| <td>The HTTPS port on which the main application listens (443 in most cases).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td>The server id (database row number).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpAddress</span></code></td> |
| <td>string</td> |
| <td>The IPv4 address of the lights-out-management port.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">iloIpGateway</span></code></td> |
| <td>string</td> |
| <td>The IPv4 gateway address of the lights-out-management port.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloIpNetmask</span></code></td> |
| <td>string</td> |
| <td>The IPv4 netmask of the lights-out-management port.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">iloPassword</span></code></td> |
| <td>string</td> |
| <td>The password of the of the lights-out-management user (displays as <strong>**</strong> unless you are an ‘admin’ user).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">iloUsername</span></code></td> |
| <td>string</td> |
| <td>The user name for lights-out-management.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><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-even"><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-odd"><td><code class="docutils literal"><span class="pre">offlineReason</span></code></td> |
| <td>string</td> |
| <td>A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">physLocation</span></code></td> |
| <td>string</td> |
| <td>The physical location name (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">physLocationId</span></code></td> |
| <td>string</td> |
| <td>The physical location id (see <a class="reference internal" href="../v11/phys_location.html#to-api-v11-phys-loc"><span class="std std-ref">Physical Location</span></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">profile</span></code></td> |
| <td>string</td> |
| <td>The assigned profile name (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDesc</span></code></td> |
| <td>string</td> |
| <td>The assigned profile description (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td> |
| <td>string</td> |
| <td>The assigned profile Id (see <a class="reference internal" href="../v11/profile.html#to-api-v11-profile"><span class="std std-ref">Profiles</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">rack</span></code></td> |
| <td>string</td> |
| <td>A string indicating rack location.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">routerHostName</span></code></td> |
| <td>string</td> |
| <td>The human readable name of the router.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">routerPortName</span></code></td> |
| <td>string</td> |
| <td>The human readable name of the router port.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">status</span></code></td> |
| <td>string</td> |
| <td>The Status string (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">statusId</span></code></td> |
| <td>string</td> |
| <td>The Status id (See <a class="reference internal" href="../v11/status.html#to-api-v11-status"><span class="std std-ref">Status</span></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> |
| <td>string</td> |
| <td>The id of the type of this server (see <a class="reference internal" href="../v11/type.html#to-api-v11-type"><span class="std std-ref">Types</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">updPending</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span> |
| <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> |
| <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> |
| <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"CDN-1"</span><span class="p">,</span> |
| <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s2">"guid"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span> |
| <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span> |
| <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span> |
| <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span> |
| <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span> |
| <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span> |
| <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span> |
| <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span> |
| <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span> |
| <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span> |
| <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2015-03-08 15:57:32"</span><span class="p">,</span> |
| <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"N/A"</span><span class="p">,</span> |
| <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span> |
| <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="s2">"9"</span><span class="p">,</span> |
| <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span> |
| <span class="s2">"profileDesc"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL profile"</span><span class="p">,</span> |
| <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"12"</span><span class="p">,</span> |
| <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span> |
| <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> |
| <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span> |
| <span class="s2">"statusId"</span><span class="p">:</span> <span class="s2">"6"</span><span class="p">,</span> |
| <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span> |
| <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span> |
| <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"3"</span><span class="p">,</span> |
| <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">false</span> |
| <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>GET /api/1.2/servers/:id/deliveryservices</strong></p> |
| <blockquote> |
| <div><p>Retrieves all delivery services assigned to the server. See also <a class="reference external" href="http://trafficcontrol.apache.org/docs/latest/admin/traffic_ops_using.html#delivery-service">Using Traffic Ops - Delivery Service</a>.</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="22%" /> |
| <col width="13%" /> |
| <col width="65%" /> |
| </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>Server ID.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="15%" /> |
| <col width="5%" /> |
| <col width="80%" /> |
| </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">active</span></code></td> |
| <td>bool</td> |
| <td>true if active, false if inactive.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cacheurl</span></code></td> |
| <td>string</td> |
| <td>Cache URL rule to apply to this delivery service.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">ccrDnsTtl</span></code></td> |
| <td>string</td> |
| <td>The TTL of the DNS response for A or AAAA queries requesting the IP address of the tr. host.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">cdnId</span></code></td> |
| <td>string</td> |
| <td>Id of the CDN to which the delivery service belongs to.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">cdnName</span></code></td> |
| <td>string</td> |
| <td>Name of the CDN to which the delivery service belongs to.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">checkPath</span></code></td> |
| <td>string</td> |
| <td>The path portion of the URL to check this deliveryservice for health.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">displayName</span></code></td> |
| <td>string</td> |
| <td>The display name of the delivery service.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassIp</span></code></td> |
| <td>string</td> |
| <td>The IPv4 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| globalMaxMbps traffic on this deliveryservice.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">dnsBypassIp6</span></code></td> |
| <td>string</td> |
| <td>The IPv6 IP to use for bypass on a DNS deliveryservice - bypass starts when serving more than the |
| globalMaxMbps traffic on this deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">dnsBypassTtl</span></code></td> |
| <td>string</td> |
| <td>The TTL of the DNS bypass response.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">dscp</span></code></td> |
| <td>string</td> |
| <td>The Differentiated Services Code Point (DSCP) with which to mark downstream (EDGE -> customer) traffic.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">edgeHeaderRewrite</span></code></td> |
| <td>string</td> |
| <td>The EDGE header rewrite actions to perform.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitRedirectUrl</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoLimit</span></code></td> |
| <td>string</td> |
| <td><ul class="first simple"> |
| <li>0: None - no limitations</li> |
| <li>1: Only route on CZF file hit</li> |
| <li>2: Only route on CZF hit or when from USA</li> |
| </ul> |
| <p class="last">Note that this does not prevent access to content or makes content secure; it just prevents |
| routing to the content by Traffic Router.</p> |
| </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">geoLimitCountries</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">geoProvider</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">globalMaxMbps</span></code></td> |
| <td>string</td> |
| <td>The maximum global bandwidth allowed on this deliveryservice. If exceeded, the traffic routes to the |
| dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for HTTP deliveryservices.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">globalMaxTps</span></code></td> |
| <td>string</td> |
| <td>The maximum global transactions per second allowed on this deliveryservice. When this is exceeded |
| traffic will be sent to the dnsByPassIp* for DNS deliveryservices and to the httpBypassFqdn for |
| HTTP deliveryservices</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">httpBypassFqdn</span></code></td> |
| <td>string</td> |
| <td>The HTTP destination to use for bypass on an HTTP deliveryservice - bypass starts when serving more than the |
| globalMaxMbps traffic on this deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">id</span></code></td> |
| <td>string</td> |
| <td>The deliveryservice id (database row number).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">infoUrl</span></code></td> |
| <td>string</td> |
| <td>Use this to add a URL that points to more information about that deliveryservice.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">initialDispersion</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">ipv6RoutingEnabled</span></code></td> |
| <td>bool</td> |
| <td>false: send IPv4 address of Traffic Router to client on HTTP type del.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">lastUpdated</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">logsEnabled</span></code></td> |
| <td>bool</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc</span></code></td> |
| <td>string</td> |
| <td>Description field 1.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">longDesc1</span></code></td> |
| <td>string</td> |
| <td>Description field 2.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">longDesc2</span></code></td> |
| <td>string</td> |
| <td>Description field 2.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>>type</span></code></td> |
| <td>string</td> |
| <td>The type of MatchList (one of :ref:to-api-v11-types use_in_table=’regex’).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">>>setNumber</span></code></td> |
| <td>string</td> |
| <td>The set Number of the matchList.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">>>pattern</span></code></td> |
| <td>string</td> |
| <td>The regexp for the matchList.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">maxDnsAnswers</span></code></td> |
| <td>string</td> |
| <td>The maximum number of IPs to put in a A/AAAA response for a DNS deliveryservice (0 means all |
| available).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">midHeaderRewrite</span></code></td> |
| <td>string</td> |
| <td>The MID header rewrite actions to perform.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">missLat</span></code></td> |
| <td>string</td> |
| <td>The latitude to use when the client cannot be found in the CZF or the Geo lookup.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">missLong</span></code></td> |
| <td>string</td> |
| <td>The longitude to use when the client cannot be found in the CZF or the Geo lookup.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">multiSiteOrigin</span></code></td> |
| <td>bool</td> |
| <td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">multiSiteOriginAlgor</span></code></td> |
| <td>bool</td> |
| <td>Is the Multi Site Origin feature enabled for this delivery service (0=false, 1=true). See <a class="reference internal" href="../../../admin/traffic_ops/using.html#rl-multi-site-origin"><span class="std std-ref">Multi Site Origin</span></a></td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">orgServerFqdn</span></code></td> |
| <td>string</td> |
| <td>The origin server base URL (FQDN when used in this instance, includes the |
| protocol (<a class="reference external" href="http://">http://</a> or <a class="reference external" href="https://">https://</a>) for use in retrieving content from the origin server.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">originShield</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileDescription</span></code></td> |
| <td>string</td> |
| <td>The description of the Traffic Router Profile with which this deliveryservice is associated.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">profileId</span></code></td> |
| <td>string</td> |
| <td>The id of the Traffic Router Profile with which this deliveryservice is associated.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">profileName</span></code></td> |
| <td>string</td> |
| <td>The name of the Traffic Router Profile with which this deliveryservice is associated.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">protocol</span></code></td> |
| <td>string</td> |
| <td><ul class="first last simple"> |
| <li>0: serve with <a class="reference external" href="http://">http://</a> at EDGE</li> |
| <li>1: serve with <a class="reference external" href="https://">https://</a> at EDGE</li> |
| <li>2: serve with both <a class="reference external" href="http://">http://</a> and <a class="reference external" href="https://">https://</a> at EDGE</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">qstringIgnore</span></code></td> |
| <td>string</td> |
| <td><ul class="first last simple"> |
| <li>0: no special query string handling; it is for use in the cache-key and pass up to origin.</li> |
| <li>1: ignore query string in cache-key, but pass it up to parent and or origin.</li> |
| <li>2: drop query string at edge, and do not use it in the cache-key.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">rangeRequestHandling</span></code></td> |
| <td>string</td> |
| <td><p class="first">How to treat range requests:</p> |
| <ul class="last simple"> |
| <li>0 Do not cache (ranges requested from files taht are already cached due to a non range request will be a HIT)</li> |
| <li>1 Use the <a class="reference external" href="https://docs.trafficserver.apache.org/en/latest/reference/plugins/background_fetch.en.html">background_fetch</a> plugin.</li> |
| <li>2 Use the cache_range_requests plugin.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">regexRemap</span></code></td> |
| <td>string</td> |
| <td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">regionalGeoBlocking</span></code></td> |
| <td>bool</td> |
| <td>Regex Remap rule to apply to this delivery service at the Edge tier.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">remapText</span></code></td> |
| <td>string</td> |
| <td>Additional raw remap line text.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">signed</span></code></td> |
| <td>bool</td> |
| <td><ul class="first last simple"> |
| <li>false: token based auth (see :ref:token-based-auth) is not enabled for this deliveryservice.</li> |
| <li>true: token based auth is enabled for this deliveryservice.</li> |
| </ul> |
| </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">sslKeyVersion</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">tenant</span></code></td> |
| <td>string</td> |
| <td>Owning tenant name</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">tenantId</span></code></td> |
| <td>int</td> |
| <td>Owning tenant ID.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">trRequestHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">trResponseHeaders</span></code></td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">type</span></code></td> |
| <td>string</td> |
| <td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">typeId</span></code></td> |
| <td>string</td> |
| <td>The type of this deliveryservice (one of :ref:to-api-v11-types use_in_table=’deliveryservice’).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">xmlId</span></code></td> |
| <td>string</td> |
| <td>Unique string that describes this deliveryservice.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"active"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"cacheurl"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"ccrDnsTtl"</span><span class="p">:</span> <span class="s2">"3600"</span><span class="p">,</span> |
| <span class="s2">"cdnId"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> |
| <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"over-the-top"</span><span class="p">,</span> |
| <span class="s2">"checkPath"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"displayName"</span><span class="p">:</span> <span class="s2">"My Cool Delivery Service"</span><span class="p">,</span> |
| <span class="s2">"dnsBypassCname"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"dnsBypassIp"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"dnsBypassIp6"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"dnsBypassTtl"</span><span class="p">:</span> <span class="s2">"30"</span><span class="p">,</span> |
| <span class="s2">"dscp"</span><span class="p">:</span> <span class="s2">"40"</span><span class="p">,</span> |
| <span class="s2">"edgeHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"exampleURLs"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"http://edge.foo-ds.foo.bar.net"</span> |
| <span class="p">],</span> |
| <span class="s2">"geoLimit"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"geoLimitCountries"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"geoLimitRedirectURL"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"geoProvider"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"globalMaxMbps"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"globalMaxTps"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"httpBypassFqdn"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"442"</span><span class="p">,</span> |
| <span class="s2">"infoUrl"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"initialDispersion"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> |
| <span class="s2">"ipv6RoutingEnabled"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> |
| <span class="s2">"lastUpdated"</span><span class="p">:</span> <span class="s2">"2016-01-26 08:49:35"</span><span class="p">,</span> |
| <span class="s2">"logsEnabled"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"longDesc"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"longDesc1"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"longDesc2"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"matchList"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"pattern"</span><span class="p">:</span> <span class="s2">".*</span><span class="se">\\</span><span class="s2">.foo-ds</span><span class="se">\\</span><span class="s2">..*"</span><span class="p">,</span> |
| <span class="s2">"setNumber"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HOST_REGEXP"</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="s2">"maxDnsAnswers"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"midHeaderRewrite"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"missLat"</span><span class="p">:</span> <span class="s2">"41.881944"</span><span class="p">,</span> |
| <span class="s2">"missLong"</span><span class="p">:</span> <span class="s2">"-87.627778"</span><span class="p">,</span> |
| <span class="s2">"multiSiteOrigin"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"multiSiteOriginAlgorithm"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"orgServerFqdn"</span><span class="p">:</span> <span class="s2">"http://baz.boo.net"</span><span class="p">,</span> |
| <span class="s2">"originShield"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"profileDescription"</span><span class="p">:</span> <span class="s2">"Content Router for over-the-top"</span><span class="p">,</span> |
| <span class="s2">"profileId"</span><span class="p">:</span> <span class="s2">"5"</span><span class="p">,</span> |
| <span class="s2">"profileName"</span><span class="p">:</span> <span class="s2">"ROUTER_TOP"</span><span class="p">,</span> |
| <span class="s2">"protocol"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"qstringIgnore"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> |
| <span class="s2">"rangeRequestHandling"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"regexRemap"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"regionalGeoBlocking"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"remapText"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"signed"</span><span class="p">:</span> <span class="n">false</span><span class="p">,</span> |
| <span class="s2">"sslKeyVersion"</span><span class="p">:</span> <span class="s2">"0"</span><span class="p">,</span> |
| <span class="s2">"tenant"</span><span class="p">:</span> <span class="s2">"root"</span><span class="p">,</span> |
| <span class="s2">"tenantId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"trRequestHeaders"</span><span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s2">"trResponseHeaders"</span><span class="p">:</span> <span class="s2">"Access-Control-Allow-Origin: *"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"HTTP"</span><span class="p">,</span> |
| <span class="s2">"typeId"</span><span class="p">:</span> <span class="s2">"8"</span><span class="p">,</span> |
| <span class="s2">"xmlId"</span><span class="p">:</span> <span class="s2">"foo-ds"</span> |
| <span class="p">}</span> |
| <span class="p">{</span> <span class="o">..</span> <span class="p">},</span> |
| <span class="p">{</span> <span class="o">..</span> <span class="p">}</span> |
| <span class="p">]</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>GET /api/1.2/servers/totals</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-v12-type"><span class="std std-ref">Types</span></a>).</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"CCR"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="s2">"count"</span><span class="p">:</span> <span class="mi">55</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"MID"</span><span class="p">,</span> |
| <span class="s2">"count"</span><span class="p">:</span> <span class="mi">18</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="s2">"count"</span><span class="p">:</span> <span class="mi">0</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"INFLUXDB"</span> |
| <span class="p">},</span> |
| <span class="p">{</span> |
| <span class="s2">"count"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"RASCAL"</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>GET /api/1.2/servers/status</strong></p> |
| <blockquote> |
| <div><p>Retrieves a count of CDN servers by status.</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="6%" /> |
| <col width="83%" /> |
| </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">ONLINE</span></code></td> |
| <td>int</td> |
| <td>The number of ONLINE servers. Traffic Monitor will not monitor the state of ONLINE servers. True health is unknown.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">REPORTED</span></code></td> |
| <td>int</td> |
| <td>The number of REPORTED servers. Traffic Monitor monitors the state of REPORTED servers and removes them if unhealthy.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">OFFLINE</span></code></td> |
| <td>int</td> |
| <td>The number of OFFLINE servers. Used for longer-term maintenance. These servers are excluded from CRConfig.json.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">ADMIN_DOWN</span></code></td> |
| <td>int</td> |
| <td>The number of ADMIN_DOWN servers. Used for short-term maintenance. These servers are included in CRConfig.json.</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><span class="pre">CCR_IGNORE</span></code></td> |
| <td>int</td> |
| <td>The number of CCR_IGNORE servers. These servers are excluded from CRConfig.json.</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">PRE_PROD</span></code></td> |
| <td>int</td> |
| <td>The number of PRE_PROD servers. Used for servers to be deployed. These servers are excluded from CRConfig.json.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> |
| <span class="p">{</span> |
| <span class="s2">"ONLINE"</span><span class="p">:</span> <span class="mi">100</span><span class="p">,</span> |
| <span class="s2">"OFFLINE"</span><span class="p">:</span> <span class="mi">23</span><span class="p">,</span> |
| <span class="s2">"REPORTED"</span><span class="p">:</span> <span class="mi">45</span><span class="p">,</span> |
| <span class="s2">"ADMIN_DOWN"</span><span class="p">:</span> <span class="mi">4</span><span class="p">,</span> |
| <span class="s2">"CCR_IGNORE"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> |
| <span class="s2">"PRE_PROD"</span><span class="p">:</span> <span class="mi">0</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.2/servers/hostname/:name/details</strong></p> |
| <blockquote> |
| <div><p>Retrieves the details of a server.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: None</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="19%" /> |
| <col width="19%" /> |
| <col width="63%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Required</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td><code class="docutils literal"><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-v12-cachegroup"><span class="std std-ref">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-v12-ds"><span class="std std-ref">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-v12-hwinfo"><span class="std std-ref">Hardware Info</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-v12-phys-loc"><span class="std std-ref">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-v12-profile"><span class="std std-ref">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-v12-status"><span class="std std-ref">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">httpsPort</span></code></td> |
| <td>string</td> |
| <td>The default HTTPS port on which the main application listens (443 for a cache in most cases).</td> |
| </tr> |
| <tr class="row-even"><td><code class="docutils literal"><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-v12-type"><span class="std std-ref">Types</span></a>).</td> |
| </tr> |
| <tr class="row-odd"><td><code class="docutils literal"><span class="pre">xmppId</span></code></td> |
| <td>string</td> |
| <td>Deprecated.</td> |
| </tr> |
| <tr class="row-even"><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-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"us-il-chicago"</span><span class="p">,</span> |
| <span class="s2">"deliveryservices"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="s2">"1"</span><span class="p">,</span> |
| <span class="s2">"2"</span><span class="p">,</span> |
| <span class="s2">"3"</span><span class="p">,</span> |
| <span class="s2">"4"</span> |
| <span class="p">],</span> |
| <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s2">"hardwareInfo"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"Physical Disk 0:1:3"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:2"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:15"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Power Supply.Slot.2"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:24"</span><span class="p">:</span> <span class="s2">"YS08"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:1"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Model"</span><span class="p">:</span> <span class="s2">"PowerEdge R720xd"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:22"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:18"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Enterprise UEFI Diagnostics"</span><span class="p">:</span> <span class="s2">"4217A5"</span><span class="p">,</span> |
| <span class="s2">"Lifecycle Controller"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:8"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Manufacturer"</span><span class="p">:</span> <span class="s2">"Dell Inc."</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:6"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"SysMemTotalSize"</span><span class="p">:</span> <span class="s2">"196608"</span><span class="p">,</span> |
| <span class="s2">"PopulatedDIMMSlots"</span><span class="p">:</span> <span class="s2">"24"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:20"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Intel(R) Ethernet 10G 2P X520 Adapter"</span><span class="p">:</span> <span class="s2">"13.5.7"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:14"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"BACKPLANE FIRMWARE"</span><span class="p">:</span> <span class="s2">"1.00"</span><span class="p">,</span> |
| <span class="s2">"Dell OS Drivers Pack, 7.0.0.29, A00"</span><span class="p">:</span> <span class="s2">"7.0.0.29"</span><span class="p">,</span> |
| <span class="s2">"Integrated Dell Remote Access Controller"</span><span class="p">:</span> <span class="s2">"1.57.57"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:5"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"ServiceTag"</span><span class="p">:</span> <span class="s2">"D6XPDV1"</span><span class="p">,</span> |
| <span class="s2">"PowerState"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:23"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:25"</span><span class="p">:</span> <span class="s2">"D903"</span><span class="p">,</span> |
| <span class="s2">"BIOS"</span><span class="p">:</span> <span class="s2">"1.3.6"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:12"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"System CPLD"</span><span class="p">:</span> <span class="s2">"1.0.3"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:4"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:0"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Power Supply.Slot.1"</span><span class="p">:</span> <span class="s2">"04.07.15"</span><span class="p">,</span> |
| <span class="s2">"PERC H710P Mini"</span><span class="p">:</span> <span class="s2">"21.0.2-0001"</span><span class="p">,</span> |
| <span class="s2">"PowerCap"</span><span class="p">:</span> <span class="s2">"689"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:16"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:10"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:11"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Lifecycle Controller 2"</span><span class="p">:</span> <span class="s2">"1.0.8.42"</span><span class="p">,</span> |
| <span class="s2">"BP12G+EXP 0:1"</span><span class="p">:</span> <span class="s2">"1.07"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:9"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:17"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Broadcom Gigabit Ethernet BCM5720"</span><span class="p">:</span> <span class="s2">"7.2.20"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:21"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:13"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:7"</span><span class="p">:</span> <span class="s2">"D1S2"</span><span class="p">,</span> |
| <span class="s2">"Physical Disk 0:1:19"</span><span class="p">:</span> <span class="s2">"D1S2"</span> |
| <span class="p">},</span> |
| <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"atsec-chi-00"</span><span class="p">,</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">"19"</span><span class="p">,</span> |
| <span class="s2">"iloIpAddress"</span><span class="p">:</span> <span class="s2">"172.16.2.6"</span><span class="p">,</span> |
| <span class="s2">"iloIpGateway"</span><span class="p">:</span> <span class="s2">"172.16.2.1"</span><span class="p">,</span> |
| <span class="s2">"iloIpNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s2">"iloPassword"</span><span class="p">:</span> <span class="s2">"********"</span><span class="p">,</span> |
| <span class="s2">"iloUsername"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"9000"</span><span class="p">,</span> |
| <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"bond0"</span><span class="p">,</span> |
| <span class="s2">"ip6Address"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:2/64"</span><span class="p">,</span> |
| <span class="s2">"ip6Gateway"</span><span class="p">:</span> <span class="s2">"2033:D0D0:3300::2:1"</span><span class="p">,</span> |
| <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.10.2.2"</span><span class="p">,</span> |
| <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.10.2.1"</span><span class="p">,</span> |
| <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s2">"mgmtIpAddress"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"mgmtIpGateway"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"mgmtIpNetmask"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span> |
| <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421_SSL"</span><span class="p">,</span> |
| <span class="s2">"rack"</span><span class="p">:</span> <span class="s2">"RR 119.02"</span><span class="p">,</span> |
| <span class="s2">"routerHostName"</span><span class="p">:</span> <span class="s2">"rtr-chi.kabletown.net"</span><span class="p">,</span> |
| <span class="s2">"routerPortName"</span><span class="p">:</span> <span class="s2">"2"</span><span class="p">,</span> |
| <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ONLINE"</span><span class="p">,</span> |
| <span class="s2">"tcpPort"</span><span class="p">:</span> <span class="s2">"80"</span><span class="p">,</span> |
| <span class="s2">"httpsPort"</span><span class="p">:</span> <span class="s2">"443"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span> |
| <span class="s2">"xmppId"</span><span class="p">:</span> <span class="s2">"atsec-chi-00-dummyxmpp"</span><span class="p">,</span> |
| <span class="s2">"xmppPasswd"</span><span class="p">:</span> <span class="s2">"X"</span> |
| |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>POST /api/1.2/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-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"id"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"host_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"servercheck_short_name"</span><span class="p">:</span> <span class="s2">""</span><span class="p">,</span> |
| <span class="s2">"value"</span><span class="p">:</span> <span class="s2">""</span> |
| <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-default"><div class="highlight"><pre><span></span><span class="n">Response</span> <span class="n">Example</span><span class="p">:</span> |
| |
| <span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> |
| <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server Check was successfully updated."</span> |
| <span class="p">}</span> |
| <span class="p">],</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| <p><strong>POST /api/1.2/servers</strong></p> |
| <blockquote> |
| <div><p>Allow user to create a server.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</p> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="21%" /> |
| <col width="13%" /> |
| <col width="65%" /> |
| </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>hostName</td> |
| <td>yes</td> |
| <td>The host name part of the server.</td> |
| </tr> |
| <tr class="row-odd"><td>domainName</td> |
| <td>yes</td> |
| <td>The domain name part of the FQDN of the cache.</td> |
| </tr> |
| <tr class="row-even"><td>cachegroup</td> |
| <td>yes</td> |
| <td>cache group name</td> |
| </tr> |
| <tr class="row-odd"><td>interfaceName</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ipAddress</td> |
| <td>yes</td> |
| <td>Must be unique per server profile.</td> |
| </tr> |
| <tr class="row-odd"><td>ipNetmask</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ipGateway</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>interfaceMtu</td> |
| <td>no</td> |
| <td>1500 or 9000</td> |
| </tr> |
| <tr class="row-even"><td>physLocation</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>type</td> |
| <td>yes</td> |
| <td>server type</td> |
| </tr> |
| <tr class="row-even"><td>profile</td> |
| <td>yes</td> |
| <td>Profile ID - Profile’s CDN must match server’s.</td> |
| </tr> |
| <tr class="row-odd"><td>cdnName</td> |
| <td>yes</td> |
| <td>cdn name the server belongs to</td> |
| </tr> |
| <tr class="row-even"><td>tcpPort</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>httpsPort</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>xmppId</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>xmppPasswd</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ip6Address</td> |
| <td>no</td> |
| <td>Must be unique per server profile.</td> |
| </tr> |
| <tr class="row-odd"><td>ip6Gateway</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>rack</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>mgmtIpAddress</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>mgmtIpNetmask</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>mgmtIpGateway</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloIpAddress</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloIpNetmask</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloIpGateway</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloUsername</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloPassword</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>routerHostName</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>routerPortName</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"tc1_ats1"</span><span class="p">,</span> |
| <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"my.test.com"</span><span class="p">,</span> |
| <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span> |
| <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span> |
| <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"eth0"</span><span class="p">,</span> |
| <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.74.27.188"</span><span class="p">,</span> |
| <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.74.27.1"</span><span class="p">,</span> |
| <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"1500"</span><span class="p">,</span> |
| <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span> |
| <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421"</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="22%" /> |
| <col width="11%" /> |
| <col width="67%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>hostName</td> |
| <td>string</td> |
| <td>The host name part of the server.</td> |
| </tr> |
| <tr class="row-odd"><td>Name</td> |
| <td>string</td> |
| <td>Description</td> |
| </tr> |
| <tr class="row-even"><td>domainName</td> |
| <td>string</td> |
| <td>The domain name part of the FQDN of the cache.</td> |
| </tr> |
| <tr class="row-odd"><td>cachegroup</td> |
| <td>string</td> |
| <td>cache group name</td> |
| </tr> |
| <tr class="row-even"><td>interfaceName</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>ipAddress</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ipNetmask</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>ipGateway</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>interfaceMtu</td> |
| <td>string</td> |
| <td>1500 or 9000</td> |
| </tr> |
| <tr class="row-odd"><td>physLocation</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>type</td> |
| <td>string</td> |
| <td>server type</td> |
| </tr> |
| <tr class="row-odd"><td>profile</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>cdnName</td> |
| <td>string</td> |
| <td>cdn name the server belongs to</td> |
| </tr> |
| <tr class="row-odd"><td>tcpPort</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>httpsPort</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>xmppId</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>xmppPasswd</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>ip6Address</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ip6Gateway</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>rack</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>mgmtIpAddress</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>mgmtIpNetmask</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>mgmtIpGateway</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloIpAddress</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloIpNetmask</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloIpGateway</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloUsername</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloPassword</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>routerHostName</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>routerPortName</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s1">'response'</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'xmppPasswd'</span> <span class="p">:</span> <span class="s1">'**********'</span><span class="p">,</span> |
| <span class="s1">'profile'</span> <span class="p">:</span> <span class="s1">'EDGE1_CDN1_421'</span><span class="p">,</span> |
| <span class="s1">'iloUsername'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'status'</span> <span class="p">:</span> <span class="s1">'REPORTED'</span><span class="p">,</span> |
| <span class="s1">'ipAddress'</span> <span class="p">:</span> <span class="s1">'10.74.27.188'</span><span class="p">,</span> |
| <span class="s1">'cdnId'</span> <span class="p">:</span> <span class="s1">'1'</span><span class="p">,</span> |
| <span class="s1">'physLocation'</span> <span class="p">:</span> <span class="s1">'plocation-chi-1'</span><span class="p">,</span> |
| <span class="s1">'cachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span> |
| <span class="s1">'interfaceName'</span> <span class="p">:</span> <span class="s1">'eth0'</span><span class="p">,</span> |
| <span class="s1">'ip6Gateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'iloPassword'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'1003'</span><span class="p">,</span> |
| <span class="s1">'routerPortName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 14:16:16'</span><span class="p">,</span> |
| <span class="s1">'ipNetmask'</span> <span class="p">:</span> <span class="s1">'255.255.255.0'</span><span class="p">,</span> |
| <span class="s1">'ipGateway'</span> <span class="p">:</span> <span class="s1">'10.74.27.1'</span><span class="p">,</span> |
| <span class="s1">'tcpPort'</span> <span class="p">:</span> <span class="s1">'80'</span><span class="p">,</span> |
| <span class="s1">'httpsPort'</span> <span class="p">:</span> <span class="s1">'443'</span><span class="p">,</span> |
| <span class="s1">'mgmtIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'ip6Address'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'interfaceMtu'</span> <span class="p">:</span> <span class="s1">'1500'</span><span class="p">,</span> |
| <span class="s1">'iloIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'hostName'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span> |
| <span class="s1">'xmppId'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span> |
| <span class="s1">'rack'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'mgmtIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'iloIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'mgmtIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'type'</span> <span class="p">:</span> <span class="s1">'EDGE'</span><span class="p">,</span> |
| <span class="s1">'domainName'</span> <span class="p">:</span> <span class="s1">'my.test.com'</span><span class="p">,</span> |
| <span class="s1">'iloIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'routerHostName'</span> <span class="p">:</span> <span class="n">null</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>PUT /api/1.2/servers/{:id}</strong></p> |
| <blockquote> |
| <div><p>Allow user to edit server through api.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="13%" /> |
| <col width="21%" /> |
| <col width="66%" /> |
| </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>id</td> |
| <td>yes</td> |
| <td>The id of the server to edit.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="21%" /> |
| <col width="13%" /> |
| <col width="65%" /> |
| </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>hostName</td> |
| <td>yes</td> |
| <td>The host name part of the server.</td> |
| </tr> |
| <tr class="row-odd"><td>domainName</td> |
| <td>yes</td> |
| <td>The domain name part of the FQDN of the cache.</td> |
| </tr> |
| <tr class="row-even"><td>cachegroup</td> |
| <td>yes</td> |
| <td>cache group name</td> |
| </tr> |
| <tr class="row-odd"><td>interfaceName</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ipAddress</td> |
| <td>yes</td> |
| <td>Must be unique per server profile.</td> |
| </tr> |
| <tr class="row-odd"><td>ipNetmask</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ipGateway</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>interfaceMtu</td> |
| <td>no</td> |
| <td>1500 or 9000</td> |
| </tr> |
| <tr class="row-even"><td>physLocation</td> |
| <td>yes</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>type</td> |
| <td>yes</td> |
| <td>server type</td> |
| </tr> |
| <tr class="row-even"><td>profile</td> |
| <td>yes</td> |
| <td>Profile ID - Profile’s CDN must match server’s.</td> |
| </tr> |
| <tr class="row-odd"><td>cdnName</td> |
| <td>yes</td> |
| <td>cdn name the server belongs to</td> |
| </tr> |
| <tr class="row-even"><td>tcpPort</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>httpsPort</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>xmppId</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>xmppPasswd</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ip6Address</td> |
| <td>no</td> |
| <td>Must be unique per server profile.</td> |
| </tr> |
| <tr class="row-odd"><td>ip6Gateway</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>rack</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>mgmtIpAddress</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>mgmtIpNetmask</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>mgmtIpGateway</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloIpAddress</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloIpNetmask</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloIpGateway</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloUsername</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloPassword</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>routerHostName</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>routerPortName</td> |
| <td>no</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"hostName"</span><span class="p">:</span> <span class="s2">"tc1_ats2"</span><span class="p">,</span> |
| <span class="s2">"domainName"</span><span class="p">:</span> <span class="s2">"my.test.com"</span><span class="p">,</span> |
| <span class="s2">"cachegroup"</span><span class="p">:</span> <span class="s2">"cache_group_edge"</span><span class="p">,</span> |
| <span class="s2">"cdnName"</span><span class="p">:</span> <span class="s2">"cdn_number_1"</span><span class="p">,</span> |
| <span class="s2">"interfaceName"</span><span class="p">:</span> <span class="s2">"eth0"</span><span class="p">,</span> |
| <span class="s2">"ipAddress"</span><span class="p">:</span> <span class="s2">"10.74.27.188"</span><span class="p">,</span> |
| <span class="s2">"ipNetmask"</span><span class="p">:</span> <span class="s2">"255.255.255.0"</span><span class="p">,</span> |
| <span class="s2">"ipGateway"</span><span class="p">:</span> <span class="s2">"10.74.27.1"</span><span class="p">,</span> |
| <span class="s2">"interfaceMtu"</span><span class="p">:</span> <span class="s2">"1500"</span><span class="p">,</span> |
| <span class="s2">"physLocation"</span><span class="p">:</span> <span class="s2">"plocation-chi-1"</span><span class="p">,</span> |
| <span class="s2">"type"</span><span class="p">:</span> <span class="s2">"EDGE"</span><span class="p">,</span> |
| <span class="s2">"profile"</span><span class="p">:</span> <span class="s2">"EDGE1_CDN1_421"</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="22%" /> |
| <col width="11%" /> |
| <col width="67%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>hostName</td> |
| <td>string</td> |
| <td>The host name part of the server.</td> |
| </tr> |
| <tr class="row-odd"><td>Name</td> |
| <td>string</td> |
| <td>Description</td> |
| </tr> |
| <tr class="row-even"><td>domainName</td> |
| <td>string</td> |
| <td>The domain name part of the FQDN of the cache.</td> |
| </tr> |
| <tr class="row-odd"><td>cachegroup</td> |
| <td>string</td> |
| <td>cache group name</td> |
| </tr> |
| <tr class="row-even"><td>interfaceName</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>ipAddress</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ipNetmask</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>ipGateway</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>interfaceMtu</td> |
| <td>string</td> |
| <td>1500 or 9000</td> |
| </tr> |
| <tr class="row-odd"><td>physLocation</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>type</td> |
| <td>string</td> |
| <td>server type</td> |
| </tr> |
| <tr class="row-odd"><td>profile</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>cdnName</td> |
| <td>string</td> |
| <td>cdn name the server belongs to</td> |
| </tr> |
| <tr class="row-odd"><td>tcpPort</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>httpsPort</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>xmppId</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>xmppPasswd</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>ip6Address</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>ip6Gateway</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>rack</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>mgmtIpAddress</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>mgmtIpNetmask</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>mgmtIpGateway</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloIpAddress</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloIpNetmask</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloIpGateway</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>iloUsername</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>iloPassword</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-even"><td>routerHostName</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| <tr class="row-odd"><td>routerPortName</td> |
| <td>string</td> |
| <td> </td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s1">'response'</span> <span class="p">:</span> <span class="p">{</span> |
| <span class="s1">'xmppPasswd'</span> <span class="p">:</span> <span class="s1">'**********'</span><span class="p">,</span> |
| <span class="s1">'profile'</span> <span class="p">:</span> <span class="s1">'EDGE1_CDN1_421'</span><span class="p">,</span> |
| <span class="s1">'iloUsername'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'status'</span> <span class="p">:</span> <span class="s1">'REPORTED'</span><span class="p">,</span> |
| <span class="s1">'ipAddress'</span> <span class="p">:</span> <span class="s1">'10.74.27.188'</span><span class="p">,</span> |
| <span class="s1">'cdnId'</span> <span class="p">:</span> <span class="s1">'1'</span><span class="p">,</span> |
| <span class="s1">'physLocation'</span> <span class="p">:</span> <span class="s1">'plocation-chi-1'</span><span class="p">,</span> |
| <span class="s1">'cachegroup'</span> <span class="p">:</span> <span class="s1">'cache_group_edge'</span><span class="p">,</span> |
| <span class="s1">'interfaceName'</span> <span class="p">:</span> <span class="s1">'eth0'</span><span class="p">,</span> |
| <span class="s1">'ip6Gateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'iloPassword'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'id'</span> <span class="p">:</span> <span class="s1">'1003'</span><span class="p">,</span> |
| <span class="s1">'routerPortName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'lastUpdated'</span> <span class="p">:</span> <span class="s1">'2016-01-25 14:16:16'</span><span class="p">,</span> |
| <span class="s1">'ipNetmask'</span> <span class="p">:</span> <span class="s1">'255.255.255.0'</span><span class="p">,</span> |
| <span class="s1">'ipGateway'</span> <span class="p">:</span> <span class="s1">'10.74.27.1'</span><span class="p">,</span> |
| <span class="s1">'tcpPort'</span> <span class="p">:</span> <span class="s1">'80'</span><span class="p">,</span> |
| <span class="s1">'httpsPort'</span> <span class="p">:</span> <span class="s1">'443'</span><span class="p">,</span> |
| <span class="s1">'mgmtIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'ip6Address'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'interfaceMtu'</span> <span class="p">:</span> <span class="s1">'1500'</span><span class="p">,</span> |
| <span class="s1">'iloIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'hostName'</span> <span class="p">:</span> <span class="s1">'tc1_ats2'</span><span class="p">,</span> |
| <span class="s1">'xmppId'</span> <span class="p">:</span> <span class="s1">'tc1_ats1'</span><span class="p">,</span> |
| <span class="s1">'rack'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'mgmtIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'iloIpAddress'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'mgmtIpGateway'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'type'</span> <span class="p">:</span> <span class="s1">'EDGE'</span><span class="p">,</span> |
| <span class="s1">'domainName'</span> <span class="p">:</span> <span class="s1">'my.test.com'</span><span class="p">,</span> |
| <span class="s1">'iloIpNetmask'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> |
| <span class="s1">'routerHostName'</span> <span class="p">:</span> <span class="n">null</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>PUT /api/1.2/servers/{:id}/status</strong></p> |
| <blockquote> |
| <div><p>Updates server status and queues updates on all child caches if server type is EDGE or MID. Also, captures offline reason if status is set to ADMIN_DOWN or OFFLINE and prepends offline reason with the user that initiated the status change.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: Admin or Operations</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="13%" /> |
| <col width="21%" /> |
| <col width="66%" /> |
| </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>id</td> |
| <td>yes</td> |
| <td>The id of the server.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="21%" /> |
| <col width="13%" /> |
| <col width="65%" /> |
| </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>status</td> |
| <td>yes</td> |
| <td>Status ID or name.</td> |
| </tr> |
| <tr class="row-odd"><td>offlineReason</td> |
| <td>yes|no</td> |
| <td>Required if status is ADMIN_DOWN or OFFLINE.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"status"</span><span class="p">:</span> <span class="s2">"ADMIN_DOWN"</span><span class="p">,</span> |
| <span class="s2">"offlineReason"</span><span class="p">:</span> <span class="s2">"Bad drives"</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> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Updated status [ ADMIN_DOWN ] for foo.bar.net [ user23: bad drives ] and queued updates on all child caches"</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>DELETE /api/1.2/servers/{:id}</strong></p> |
| <blockquote> |
| <div><p>Allow user to delete server through api.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="12%" /> |
| <col width="20%" /> |
| <col width="67%" /> |
| </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>id</td> |
| <td>yes</td> |
| <td>The id of the server to delete.</td> |
| </tr> |
| </tbody> |
| </table> |
| <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-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"alerts"</span><span class="p">:</span> <span class="p">[</span> |
| <span class="p">{</span> |
| <span class="s2">"level"</span><span class="p">:</span> <span class="s2">"success"</span><span class="p">,</span> |
| <span class="s2">"text"</span><span class="p">:</span> <span class="s2">"Server was deleted."</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>POST /api/1.2/servers/{:id}/queue_update</strong></p> |
| <blockquote> |
| <div><p>Queue or dequeue updates for a specific server.</p> |
| <p>Authentication Required: Yes</p> |
| <p>Role(s) Required: admin or oper</p> |
| <p><strong>Request Route Parameters</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="28%" /> |
| <col width="26%" /> |
| <col width="46%" /> |
| </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>id</td> |
| <td>yes</td> |
| <td>the server id.</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Request Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="20%" /> |
| <col width="13%" /> |
| <col width="67%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>action</td> |
| <td>string</td> |
| <td>queue or dequeue</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Properties</strong></p> |
| <table border="1" class="docutils"> |
| <colgroup> |
| <col width="20%" /> |
| <col width="13%" /> |
| <col width="67%" /> |
| </colgroup> |
| <thead valign="bottom"> |
| <tr class="row-odd"><th class="head">Name</th> |
| <th class="head">Type</th> |
| <th class="head">Description</th> |
| </tr> |
| </thead> |
| <tbody valign="top"> |
| <tr class="row-even"><td>action</td> |
| <td>string</td> |
| <td>The action processed, queue or dequeue.</td> |
| </tr> |
| <tr class="row-odd"><td>serverId</td> |
| <td>integer</td> |
| <td>server id</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Response Example</strong></p> |
| <div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">{</span> |
| <span class="s2">"response"</span><span class="p">:</span> <span class="p">{</span> |
| <span class="s2">"serverId"</span><span class="p">:</span> <span class="s2">"1"</span><span class="p">,</span> |
| <span class="s2">"action"</span><span class="p">:</span> <span class="s2">"queue"</span> |
| <span class="p">}</span> |
| <span class="p">}</span> |
| </pre></div> |
| </div> |
| </div></blockquote> |
| <div class="line-block"> |
| <div class="line"><br /></div> |
| </div> |
| </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:'2.1-dev', |
| COLLAPSE_INDEX:false, |
| FILE_SUFFIX:'.html', |
| HAS_SOURCE: true, |
| SOURCELINK_SUFFIX: '' |
| }; |
| </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> |