Update docs from commit 512f97f55abda9c85da484ab7570283ee693bdd9
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/commit/795170bd Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/tree/795170bd Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/diff/795170bd Branch: refs/heads/asf-site Commit: 795170bdae2158f6c0de3e370d2d18baaed36cf1 Parents: 8ccbc54 Author: jenkins <bui...@apache.org> Authored: Fri Dec 1 16:32:09 2017 +0000 Committer: jenkins <bui...@apache.org> Committed: Fri Dec 1 16:32:09 2017 +0000 ---------------------------------------------------------------------- .../traffic_ops_api/v12/server.rst.txt | 168 ++++++++++--------- .../development/traffic_ops_api/v12/server.html | 112 ++++++++----- docs/master/searchindex.js | 2 +- 3 files changed, 159 insertions(+), 123 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/795170bd/docs/master/_sources/development/traffic_ops_api/v12/server.rst.txt ---------------------------------------------------------------------- diff --git a/docs/master/_sources/development/traffic_ops_api/v12/server.rst.txt b/docs/master/_sources/development/traffic_ops_api/v12/server.rst.txt index 2730827..77ae9f8 100644 --- a/docs/master/_sources/development/traffic_ops_api/v12/server.rst.txt +++ b/docs/master/_sources/development/traffic_ops_api/v12/server.rst.txt @@ -930,83 +930,89 @@ Server **Request Properties** - +----------------+----------+-------------------------------------------------+ - | Name | Required | Description | - +================+==========+=================================================+ - | hostName | yes | The host name part of the server. | - +----------------+----------+-------------------------------------------------+ - | domainName | yes | The domain name part of the FQDN of the cache. | - +----------------+----------+-------------------------------------------------+ - | cachegroup | yes | cache group name | - +----------------+----------+-------------------------------------------------+ - | interfaceName | yes | | - +----------------+----------+-------------------------------------------------+ - | ipAddress | yes | Must be unique per server profile. | - +----------------+----------+-------------------------------------------------+ - | ipNetmask | yes | | - +----------------+----------+-------------------------------------------------+ - | ipGateway | yes | | - +----------------+----------+-------------------------------------------------+ - | interfaceMtu | no | 1500 or 9000 | - +----------------+----------+-------------------------------------------------+ - | physLocation | yes | | - +----------------+----------+-------------------------------------------------+ - | type | yes | server type | - +----------------+----------+-------------------------------------------------+ - | profile | yes | Profile ID - Profile's CDN must match server's. | - +----------------+----------+-------------------------------------------------+ - | cdnName | yes | cdn name the server belongs to | - +----------------+----------+-------------------------------------------------+ - | tcpPort | no | | - +----------------+----------+-------------------------------------------------+ - | httpsPort | no | | - +----------------+----------+-------------------------------------------------+ - | xmppId | no | | - +----------------+----------+-------------------------------------------------+ - | xmppPasswd | no | | - +----------------+----------+-------------------------------------------------+ - | ip6Address | no | Must be unique per server profile. | - +----------------+----------+-------------------------------------------------+ - | ip6Gateway | no | | - +----------------+----------+-------------------------------------------------+ - | rack | no | | - +----------------+----------+-------------------------------------------------+ - | mgmtIpAddress | no | | - +----------------+----------+-------------------------------------------------+ - | mgmtIpNetmask | no | | - +----------------+----------+-------------------------------------------------+ - | mgmtIpGateway | no | | - +----------------+----------+-------------------------------------------------+ - | iloIpAddress | no | | - +----------------+----------+-------------------------------------------------+ - | iloIpNetmask | no | | - +----------------+----------+-------------------------------------------------+ - | iloIpGateway | no | | - +----------------+----------+-------------------------------------------------+ - | iloUsername | no | | - +----------------+----------+-------------------------------------------------+ - | iloPassword | no | | - +----------------+----------+-------------------------------------------------+ - | routerHostName | no | | - +----------------+----------+-------------------------------------------------+ - | routerPortName | no | | - +----------------+----------+-------------------------------------------------+ + +----------------+----------+-------------------------------------------------------------+ + | Name | Required | Description | + +================+==========+=============================================================+ + | hostName | yes | The host name part of the server. | + +----------------+----------+-------------------------------------------------------------+ + | domainName | yes | The domain name part of the FQDN of the cache. | + +----------------+----------+-------------------------------------------------------------+ + | cachegroupId | yes | Cache Group ID | + +----------------+----------+-------------------------------------------------------------+ + | interfaceName | yes | The interface name (e.g. eth0, p2p1). | + +----------------+----------+-------------------------------------------------------------+ + | ipAddress | yes | Must be unique per server profile. | + +----------------+----------+-------------------------------------------------------------+ + | ipNetmask | yes | The IPv4 Netmask | + +----------------+----------+-------------------------------------------------------------+ + | ipGateway | yes | The IPv4 Gateway. | + +----------------+----------+-------------------------------------------------------------+ + | interfaceMtu | yes | 1500 or 9000 | + +----------------+----------+-------------------------------------------------------------+ + | physLocationId | yes | The ID of the Physical Location. | + +----------------+----------+-------------------------------------------------------------+ + | typeId | yes | The ID of the Server Type | + +----------------+----------+-------------------------------------------------------------+ + | profileId | yes | Profile ID - Profile's CDN must match server's. | + +----------------+----------+-------------------------------------------------------------+ + | cdnId | yes | CDN ID the server belongs to | + +----------------+----------+-------------------------------------------------------------+ + | updPending | yes | Is there an update pending for this server. (true or false) | + +----------------+----------+-------------------------------------------------------------+ + | statusId | yes | The Status ID of the server. | + +----------------+----------+-------------------------------------------------------------+ + | tcpPort | no | Must be a valid TCP port if specified. | + +----------------+----------+-------------------------------------------------------------+ + | httpsPort | no | Must be a valid TCP port if specified. | + +----------------+----------+-------------------------------------------------------------+ + | xmppId | no | | + +----------------+----------+-------------------------------------------------------------+ + | xmppPasswd | no | | + +----------------+----------+-------------------------------------------------------------+ + | ip6Address | no | IPv6 address and prefix. Must be unique per server profile. | + +----------------+----------+-------------------------------------------------------------+ + | ip6Gateway | no | IPv6 Gateway | + +----------------+----------+-------------------------------------------------------------+ + | rack | no | The rack location in the Data Center. | + +----------------+----------+-------------------------------------------------------------+ + | mgmtIpAddress | no | The IPv4 management address. | + +----------------+----------+-------------------------------------------------------------+ + | mgmtIpNetmask | no | The IPv4 management netmask. | + +----------------+----------+-------------------------------------------------------------+ + | mgmtIpGateway | no | The IPv4 management gateway. | + +----------------+----------+-------------------------------------------------------------+ + | iloIpAddress | no | The IPv4 ILO address. | + +----------------+----------+-------------------------------------------------------------+ + | iloIpNetmask | no | The IPv4 ILO netmask. | + +----------------+----------+-------------------------------------------------------------+ + | iloIpGateway | no | The IPv4 ILO gateway. | + +----------------+----------+-------------------------------------------------------------+ + | iloUsername | no | The ILO username. | + +----------------+----------+-------------------------------------------------------------+ + | iloPassword | no | The ILO password. | + +----------------+----------+-------------------------------------------------------------+ + | routerHostName | no | The hostname of the router the server is connected to. | + +----------------+----------+-------------------------------------------------------------+ + | routerPortName | no | The portname in the router. | + +----------------+----------+-------------------------------------------------------------+ **Request Example** :: { "hostName": "tc1_ats1", - "domainName": "my.test.com", - "cachegroup": "cache_group_edge", - "cdnName": "cdn_number_1", + "domainName": "cdn1.kabletown.test", + "cachegroupId": 1, + "cdnId": 1, "interfaceName": "eth0", "ipAddress": "10.74.27.188", "ipNetmask": "255.255.255.0", "ipGateway": "10.74.27.1", - "interfaceMtu": "1500", - "physLocation": "plocation-chi-1", - "type": "EDGE", - "profile": "EDGE1_CDN1_421" + "interfaceMtu": 1500, + "physLocationId": 1, + "typeId": 1, + "profileId": 1, + "updPending": true, + "statusId": 1 } | @@ -1081,27 +1087,29 @@ Server { 'response' : { + 'profileId' : 1, 'xmppPasswd' : '**********', 'profile' : 'EDGE1_CDN1_421', - 'iloUsername' : null, + 'iloUsername' : 'username', + 'statusId' : 1, 'status' : 'REPORTED', 'ipAddress' : '10.74.27.188', - 'cdnId' : '1', + 'cdnId' : 1, 'physLocation' : 'plocation-chi-1', 'cachegroup' : 'cache_group_edge', 'interfaceName' : 'eth0', 'ip6Gateway' : null, 'iloPassword' : null, - 'id' : '1003', + 'id' : 1003, 'routerPortName' : null, 'lastUpdated' : '2016-01-25 14:16:16', 'ipNetmask' : '255.255.255.0', 'ipGateway' : '10.74.27.1', - 'tcpPort' : '80', - 'httpsPort' : '443', + 'tcpPort' : 80, + 'httpsPort' : 443, 'mgmtIpAddress' : null, 'ip6Address' : null, - 'interfaceMtu' : '1500', + 'interfaceMtu' : 1500, 'iloIpGateway' : null, 'hostName' : 'tc1_ats1', 'xmppId' : 'tc1_ats1', @@ -1110,9 +1118,17 @@ Server 'iloIpAddress' : null, 'mgmtIpGateway' : null, 'type' : 'EDGE', - 'domainName' : 'my.test.com', + 'domainName' : 'cdn1.kabletown.test', 'iloIpNetmask' : null, - 'routerHostName' : null + 'routerHostName' : null, + 'updPending' : false, + 'guid' : null, + 'physLocationId' : 1, + 'offlineReason' : 'N\/A', + 'cachegroupId' : 1, + 'typeId' : 1, + 'cdnName' : 'cdn1', + 'profileDesc' : 'The profile description' } } http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/795170bd/docs/master/development/traffic_ops_api/v12/server.html ---------------------------------------------------------------------- diff --git a/docs/master/development/traffic_ops_api/v12/server.html b/docs/master/development/traffic_ops_api/v12/server.html index 8317838..7b4c67f 100644 --- a/docs/master/development/traffic_ops_api/v12/server.html +++ b/docs/master/development/traffic_ops_api/v12/server.html @@ -1625,9 +1625,9 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" <p><strong>Request Properties</strong></p> <table border="1" class="docutils"> <colgroup> -<col width="21%" /> -<col width="13%" /> -<col width="65%" /> +<col width="18%" /> +<col width="11%" /> +<col width="70%" /> </colgroup> <thead valign="bottom"> <tr class="row-odd"><th class="head">Name</th> @@ -1644,13 +1644,13 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" <td>yes</td> <td>The domain name part of the FQDN of the cache.</td> </tr> -<tr class="row-even"><td>cachegroup</td> +<tr class="row-even"><td>cachegroupId</td> <td>yes</td> -<td>cache group name</td> +<td>Cache Group ID</td> </tr> <tr class="row-odd"><td>interfaceName</td> <td>yes</td> -<td> </td> +<td>The interface name (e.g. eth0, p2p1).</td> </tr> <tr class="row-even"><td>ipAddress</td> <td>yes</td> @@ -1658,39 +1658,47 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" </tr> <tr class="row-odd"><td>ipNetmask</td> <td>yes</td> -<td> </td> +<td>The IPv4 Netmask</td> </tr> <tr class="row-even"><td>ipGateway</td> <td>yes</td> -<td> </td> +<td>The IPv4 Gateway.</td> </tr> <tr class="row-odd"><td>interfaceMtu</td> -<td>no</td> +<td>yes</td> <td>1500 or 9000</td> </tr> -<tr class="row-even"><td>physLocation</td> +<tr class="row-even"><td>physLocationId</td> <td>yes</td> -<td> </td> +<td>The ID of the Physical Location.</td> </tr> -<tr class="row-odd"><td>type</td> +<tr class="row-odd"><td>typeId</td> <td>yes</td> -<td>server type</td> +<td>The ID of the Server Type</td> </tr> -<tr class="row-even"><td>profile</td> +<tr class="row-even"><td>profileId</td> <td>yes</td> <td>Profile ID - Profile’s CDN must match server’s.</td> </tr> -<tr class="row-odd"><td>cdnName</td> +<tr class="row-odd"><td>cdnId</td> <td>yes</td> -<td>cdn name the server belongs to</td> +<td>CDN ID the server belongs to</td> +</tr> +<tr class="row-even"><td>updPending</td> +<td>yes</td> +<td>Is there an update pending for this server. (true or false)</td> +</tr> +<tr class="row-odd"><td>statusId</td> +<td>yes</td> +<td>The Status ID of the server.</td> </tr> <tr class="row-even"><td>tcpPort</td> <td>no</td> -<td> </td> +<td>Must be a valid TCP port if specified.</td> </tr> <tr class="row-odd"><td>httpsPort</td> <td>no</td> -<td> </td> +<td>Must be a valid TCP port if specified.</td> </tr> <tr class="row-even"><td>xmppId</td> <td>no</td> @@ -1702,72 +1710,74 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" </tr> <tr class="row-even"><td>ip6Address</td> <td>no</td> -<td>Must be unique per server profile.</td> +<td>IPv6 address and prefix. Must be unique per server profile.</td> </tr> <tr class="row-odd"><td>ip6Gateway</td> <td>no</td> -<td> </td> +<td>IPv6 Gateway</td> </tr> <tr class="row-even"><td>rack</td> <td>no</td> -<td> </td> +<td>The rack location in the Data Center.</td> </tr> <tr class="row-odd"><td>mgmtIpAddress</td> <td>no</td> -<td> </td> +<td>The IPv4 management address.</td> </tr> <tr class="row-even"><td>mgmtIpNetmask</td> <td>no</td> -<td> </td> +<td>The IPv4 management netmask.</td> </tr> <tr class="row-odd"><td>mgmtIpGateway</td> <td>no</td> -<td> </td> +<td>The IPv4 management gateway.</td> </tr> <tr class="row-even"><td>iloIpAddress</td> <td>no</td> -<td> </td> +<td>The IPv4 ILO address.</td> </tr> <tr class="row-odd"><td>iloIpNetmask</td> <td>no</td> -<td> </td> +<td>The IPv4 ILO netmask.</td> </tr> <tr class="row-even"><td>iloIpGateway</td> <td>no</td> -<td> </td> +<td>The IPv4 ILO gateway.</td> </tr> <tr class="row-odd"><td>iloUsername</td> <td>no</td> -<td> </td> +<td>The ILO username.</td> </tr> <tr class="row-even"><td>iloPassword</td> <td>no</td> -<td> </td> +<td>The ILO password.</td> </tr> <tr class="row-odd"><td>routerHostName</td> <td>no</td> -<td> </td> +<td>The hostname of the router the server is connected to.</td> </tr> <tr class="row-even"><td>routerPortName</td> <td>no</td> -<td> </td> +<td>The portname in the router.</td> </tr> </tbody> </table> <p><strong>Request Example</strong></p> <div class="highlight-default"><div class="highlight"><pre><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">"domainName"</span><span class="p">:</span> <span class="s2">"cdn1.kabletown.test"</span><span class="p">,</span> + <span class="s2">"cachegroupId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"cdnId"</span><span class="p">:</span> <span class="mi">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="s2">"interfaceMtu"</span><span class="p">:</span> <span class="mi">1500</span><span class="p">,</span> + <span class="s2">"physLocationId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"typeId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"profileId"</span><span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s2">"updPending"</span><span class="p">:</span> <span class="n">true</span><span class="p">,</span> + <span class="s2">"statusId"</span><span class="p">:</span> <span class="mi">1</span> <span class="p">}</span> </pre></div> </div> @@ -1915,27 +1925,29 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" <p><strong>Response Example</strong></p> <div class="highlight-default"><div class="highlight"><pre><span class="p">{</span> <span class="s1">'response'</span> <span class="p">:</span> <span class="p">{</span> + <span class="s1">'profileId'</span> <span class="p">:</span> <span class="mi">1</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">'iloUsername'</span> <span class="p">:</span> <span class="s1">'username'</span><span class="p">,</span> + <span class="s1">'statusId'</span> <span class="p">:</span> <span class="mi">1</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">'cdnId'</span> <span class="p">:</span> <span class="mi">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">'id'</span> <span class="p">:</span> <span class="mi">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">'tcpPort'</span> <span class="p">:</span> <span class="mi">80</span><span class="p">,</span> + <span class="s1">'httpsPort'</span> <span class="p">:</span> <span class="mi">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">'interfaceMtu'</span> <span class="p">:</span> <span class="mi">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> @@ -1944,9 +1956,17 @@ protocol (<a class="reference external" href="http://";>http://</a> or <a class=" <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">'domainName'</span> <span class="p">:</span> <span class="s1">'cdn1.kabletown.test'</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="s1">'routerHostName'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s1">'updPending'</span> <span class="p">:</span> <span class="n">false</span><span class="p">,</span> + <span class="s1">'guid'</span> <span class="p">:</span> <span class="n">null</span><span class="p">,</span> + <span class="s1">'physLocationId'</span> <span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s1">'offlineReason'</span> <span class="p">:</span> <span class="s1">'N\/A'</span><span class="p">,</span> + <span class="s1">'cachegroupId'</span> <span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s1">'typeId'</span> <span class="p">:</span> <span class="mi">1</span><span class="p">,</span> + <span class="s1">'cdnName'</span> <span class="p">:</span> <span class="s1">'cdn1'</span><span class="p">,</span> + <span class="s1">'profileDesc'</span> <span class="p">:</span> <span class="s1">'The profile description'</span> <span class="p">}</span> <span class="p">}</span> </pre></div>
