http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v11/server.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/server.txt b/docs/latest/_sources/development/traffic_ops_api/v11/server.txt new file mode 100644 index 0000000..44f1292 --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v11/server.txt @@ -0,0 +1,630 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-v11-server: + +Server +====== + +.. _to-api-v11-servers-route: + +/api/1.1/servers +++++++++++++++++ + +**GET /api/1.1/servers** + + Retrieves properties of CDN servers. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Query Parameters** + + +--------------------+----------+---------------------------------------------+ + | Name | Required | Description | + +====================+==========+=============================================+ + | ``dsId`` | no | Used to filter servers by delivery service. | + +--------------------+----------+---------------------------------------------+ + | ``status`` | no | Used to filter servers by status. | + +--------------------+----------+---------------------------------------------+ + | ``type`` | no | Used to filter servers by type. | + +--------------------+----------+---------------------------------------------+ + + **Response Properties** + + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================+========+============================================================================================================+ + | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``cachegroupId`` | string | The cache group id. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``cdnId`` | string | Id of the CDN to which the server belongs to. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``cdnName`` | string | Name of the CDN to which the server belongs to. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``domainName`` | string | The domain name part of the FQDN of the cache. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``guid`` | string | An identifier used to uniquely identify the server. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``hostName`` | string | The host name part of the cache. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``id`` | string | The server id (database row number). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloUsername`` | string | The user name for lights-out-management. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``interfaceName`` | string | The network interface name used for serving traffic. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time and Date for the last update for this server. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``rack`` | string | A string indicating rack location. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``routerHostName`` | string | The human readable name of the router. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``routerPortName`` | string | The human readable name of the router port. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``updPending`` | bool | | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "cachegroup": "us-il-chicago", + "cachegroupId": "3", + "cdnId": "3", + "cdnName": "CDN-1", + "domainName": "chi.kabletown.net", + "guid": null, + "hostName": "atsec-chi-00", + "id": "19", + "iloIpAddress": "172.16.2.6", + "iloIpGateway": "172.16.2.1", + "iloIpNetmask": "255.255.255.0", + "iloPassword": "********", + "iloUsername": "", + "interfaceMtu": "9000", + "interfaceName": "bond0", + "ip6Address": "2033:D0D0:3300::2:2/64", + "ip6Gateway": "2033:D0D0:3300::2:1", + "ipAddress": "10.10.2.2", + "ipGateway": "10.10.2.1", + "ipNetmask": "255.255.255.0", + "lastUpdated": "2015-03-08 15:57:32", + "mgmtIpAddress": "", + "mgmtIpGateway": "", + "mgmtIpNetmask": "", + "offlineReason": "N/A", + "physLocation": "plocation-chi-1", + "physLocationId": "9", + "profile": "EDGE1_CDN1_421_SSL", + "profileDesc": "EDGE1_CDN1_421_SSL profile", + "profileId": "12", + "rack": "RR 119.02", + "routerHostName": "rtr-chi.kabletown.net", + "routerPortName": "2", + "status": "ONLINE", + "statusId": "6", + "tcpPort": "80", + "httpsPort": "443", + "type": "EDGE", + "typeId": "3", + "updPending": false + }, + { + ... more server data + } + ] + } + +| + +**GET /api/1.1/servers/:id** + + Retrieves properties of a CDN server by server ID. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +-----------+----------+---------------------------------------------+ + | Name | Required | Description | + +===========+==========+=============================================+ + | ``id`` | yes | Server id. | + +-----------+----------+---------------------------------------------+ + + **Response Properties** + + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +====================+========+============================================================================================================+ + | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``cachegroupId`` | string | The cache group id. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``cdnId`` | string | Id of the CDN to which the server belongs to. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``cdnName`` | string | Name of the CDN to which the server belongs to. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``domainName`` | string | The domain name part of the FQDN of the cache. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``guid`` | string | An identifier used to uniquely identify the server. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``hostName`` | string | The host name part of the cache. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``httpsPort`` | string | The HTTPS port on which the main application listens (443 in most cases). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``id`` | string | The server id (database row number). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``iloUsername`` | string | The user name for lights-out-management. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``interfaceName`` | string | The network interface name used for serving traffic. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time and Date for the last update for this server. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``offlineReason`` | string | A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``physLocationId`` | string | The physical location id (see :ref:`to-api-v11-phys-loc`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``profileDesc`` | string | The assigned profile description (see :ref:`to-api-v11-profile`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``profileId`` | string | The assigned profile Id (see :ref:`to-api-v11-profile`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``rack`` | string | A string indicating rack location. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``routerHostName`` | string | The human readable name of the router. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``routerPortName`` | string | The human readable name of the router port. | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``statusId`` | string | The Status id (See :ref:`to-api-v11-status`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``typeId`` | string | The id of the type of this server (see :ref:`to-api-v11-type`). | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + | ``updPending`` | bool | | + +--------------------+--------+------------------------------------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "cachegroup": "us-il-chicago", + "cachegroupId": "3", + "cdnId": "3", + "cdnName": "CDN-1", + "domainName": "chi.kabletown.net", + "guid": null, + "hostName": "atsec-chi-00", + "id": "19", + "iloIpAddress": "172.16.2.6", + "iloIpGateway": "172.16.2.1", + "iloIpNetmask": "255.255.255.0", + "iloPassword": "********", + "iloUsername": "", + "interfaceMtu": "9000", + "interfaceName": "bond0", + "ip6Address": "2033:D0D0:3300::2:2/64", + "ip6Gateway": "2033:D0D0:3300::2:1", + "ipAddress": "10.10.2.2", + "ipGateway": "10.10.2.1", + "ipNetmask": "255.255.255.0", + "lastUpdated": "2015-03-08 15:57:32", + "mgmtIpAddress": "", + "mgmtIpGateway": "", + "mgmtIpNetmask": "", + "offlineReason": "N/A", + "physLocation": "plocation-chi-1", + "physLocationId": "9", + "profile": "EDGE1_CDN1_421_SSL", + "profileDesc": "EDGE1_CDN1_421_SSL profile", + "profileId": "12", + "rack": "RR 119.02", + "routerHostName": "rtr-chi.kabletown.net", + "routerPortName": "2", + "status": "ONLINE", + "statusId": "6", + "tcpPort": "80", + "httpsPort": "443", + "type": "EDGE", + "typeId": "3", + "updPending": false + } + ] + } + +| + + +**GET /api/1.1/servers/summary** + + Retrieves a count of CDN servers by type. + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +-----------+--------+------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+========================================================================+ + | ``count`` | int | The number of servers of this type in this instance of Traffic Ops. | + +-----------+--------+------------------------------------------------------------------------+ + | ``type`` | string | The name of the type of the server count (see :ref:`to-api-v11-type`). | + +-----------+--------+------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "count": 4, + "type": "CCR" + }, + { + "count": 55, + "type": "EDGE" + }, + { + "type": "MID", + "count": 18 + }, + { + "count": 0, + "type": "INFLUXDB" + }, + { + "count": 4, + "type": "RASCAL" + } + } + +| + +**GET /api/1.1/servers/hostname/:name/details** + + Retrieves the details of a server. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +----------+----------+----------------------------------+ + | Name | Required | Description | + +==========+==========+==================================+ + | ``name`` | yes | The host name part of the cache. | + +----------+----------+----------------------------------+ + + **Response Properties** + + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +======================+========+=============================================================================================================+ + | ``cachegroup`` | string | The cache group name (see :ref:`to-api-v11-cachegroup`). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``deliveryservices`` | array | Array of strings with the delivery service ids assigned (see :ref:`to-api-v11-ds`). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``domainName`` | string | The domain name part of the FQDN of the cache. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``hardwareInfo`` | hash | Hwinfo struct (see :ref:`to-api-v11-hwinfo`). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``hostName`` | string | The host name part of the cache. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``id`` | string | The server id (database row number). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``iloIpAddress`` | string | The IPv4 address of the lights-out-management port. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``iloIpGateway`` | string | The IPv4 gateway address of the lights-out-management port. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``iloIpNetmask`` | string | The IPv4 netmask of the lights-out-management port. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``iloPassword`` | string | The password of the of the lights-out-management user (displays as ****** unless you are an 'admin' user). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``iloUsername`` | string | The user name for lights-out-management. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``interfaceMtu`` | string | The Maximum Transmission Unit (MTU) to configure for ``interfaceName``. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``interfaceName`` | string | The network interface name used for serving traffic. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``ip6Address`` | string | The IPv6 address/netmask for ``interfaceName``. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``ip6Gateway`` | string | The IPv6 gateway for ``interfaceName``. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``ipAddress`` | string | The IPv4 address for ``interfaceName``. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``ipGateway`` | string | The IPv4 gateway for ``interfaceName``. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``ipNetmask`` | string | The IPv4 netmask for ``interfaceName``. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time/Date of the last update for this server. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``mgmtIpAddress`` | string | The IPv4 address of the management port (optional). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``mgmtIpGateway`` | string | The IPv4 gateway of the management port (optional). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``mgmtIpNetmask`` | string | The IPv4 netmask of the management port (optional). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``physLocation`` | string | The physical location name (see :ref:`to-api-v11-phys-loc`). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``profile`` | string | The assigned profile name (see :ref:`to-api-v11-profile`). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``rack`` | string | A string indicating rack location. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``routerHostName`` | string | The human readable name of the router. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``routerPortName`` | string | The human readable name of the router port. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``status`` | string | The Status string (See :ref:`to-api-v11-status`). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``tcpPort`` | string | The default TCP port on which the main application listens (80 for a cache in most cases). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``httpsPort`` | string | The default HTTPS port on which the main application listens (443 for a cache in most cases). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``type`` | string | The name of the type of this server (see :ref:`to-api-v11-type`). | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``xmppId`` | string | Deprecated. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + | ``xmppPasswd`` | string | Deprecated. | + +----------------------+--------+-------------------------------------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "cachegroup": "us-il-chicago", + "deliveryservices": [ + "1", + "2", + "3", + "4" + ], + "domainName": "chi.kabletown.net", + "hardwareInfo": { + "Physical Disk 0:1:3": "D1S2", + "Physical Disk 0:1:2": "D1S2", + "Physical Disk 0:1:15": "D1S2", + "Power Supply.Slot.2": "04.07.15", + "Physical Disk 0:1:24": "YS08", + "Physical Disk 0:1:1": "D1S2", + "Model": "PowerEdge R720xd", + "Physical Disk 0:1:22": "D1S2", + "Physical Disk 0:1:18": "D1S2", + "Enterprise UEFI Diagnostics": "4217A5", + "Lifecycle Controller": "1.0.8.42", + "Physical Disk 0:1:8": "D1S2", + "Manufacturer": "Dell Inc.", + "Physical Disk 0:1:6": "D1S2", + "SysMemTotalSize": "196608", + "PopulatedDIMMSlots": "24", + "Physical Disk 0:1:20": "D1S2", + "Intel(R) Ethernet 10G 2P X520 Adapter": "13.5.7", + "Physical Disk 0:1:14": "D1S2", + "BACKPLANE FIRMWARE": "1.00", + "Dell OS Drivers Pack, 7.0.0.29, A00": "7.0.0.29", + "Integrated Dell Remote Access Controller": "1.57.57", + "Physical Disk 0:1:5": "D1S2", + "ServiceTag": "D6XPDV1", + "PowerState": "2", + "Physical Disk 0:1:23": "D1S2", + "Physical Disk 0:1:25": "D903", + "BIOS": "1.3.6", + "Physical Disk 0:1:12": "D1S2", + "System CPLD": "1.0.3", + "Physical Disk 0:1:4": "D1S2", + "Physical Disk 0:1:0": "D1S2", + "Power Supply.Slot.1": "04.07.15", + "PERC H710P Mini": "21.0.2-0001", + "PowerCap": "689", + "Physical Disk 0:1:16": "D1S2", + "Physical Disk 0:1:10": "D1S2", + "Physical Disk 0:1:11": "D1S2", + "Lifecycle Controller 2": "1.0.8.42", + "BP12G+EXP 0:1": "1.07", + "Physical Disk 0:1:9": "D1S2", + "Physical Disk 0:1:17": "D1S2", + "Broadcom Gigabit Ethernet BCM5720": "7.2.20", + "Physical Disk 0:1:21": "D1S2", + "Physical Disk 0:1:13": "D1S2", + "Physical Disk 0:1:7": "D1S2", + "Physical Disk 0:1:19": "D1S2" + }, + "hostName": "atsec-chi-00", + "id": "19", + "iloIpAddress": "172.16.2.6", + "iloIpGateway": "172.16.2.1", + "iloIpNetmask": "255.255.255.0", + "iloPassword": "********", + "iloUsername": "", + "interfaceMtu": "9000", + "interfaceName": "bond0", + "ip6Address": "2033:D0D0:3300::2:2/64", + "ip6Gateway": "2033:D0D0:3300::2:1", + "ipAddress": "10.10.2.2", + "ipGateway": "10.10.2.1", + "ipNetmask": "255.255.255.0", + "mgmtIpAddress": "", + "mgmtIpGateway": "", + "mgmtIpNetmask": "", + "physLocation": "plocation-chi-1", + "profile": "EDGE1_CDN1_421_SSL", + "rack": "RR 119.02", + "routerHostName": "rtr-chi.kabletown.net", + "routerPortName": "2", + "status": "ONLINE", + "tcpPort": "80", + "httpsPort": "443", + "type": "EDGE", + "xmppId": "atsec-chi-00-dummyxmpp", + "xmppPasswd": "X" + + } + } + +| + +**POST /api/1.1/servercheck** + + Post a server check result to the serverchecks table. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +----------------------------+----------+-------------+ + | Name | Required | Description | + +============================+==========+=============+ + | ``id`` | yes | | + +----------------------------+----------+-------------+ + | ``host_name`` | yes | | + +----------------------------+----------+-------------+ + | ``servercheck_short_name`` | yes | | + +----------------------------+----------+-------------+ + | ``value`` | yes | | + +----------------------------+----------+-------------+ + + **Request Example** :: + + { + "id": "", + "host_name": "", + "servercheck_short_name": "", + "value": "" + } + +| + + **Response Properties** + + +-------------+--------+----------------------------------+ + | Parameter | Type | Description | + +=============+========+==================================+ + | ``alerts`` | array | A collection of alert messages. | + +-------------+--------+----------------------------------+ + | ``>level`` | string | Success, info, warning or error. | + +-------------+--------+----------------------------------+ + | ``>text`` | string | Alert message. | + +-------------+--------+----------------------------------+ + | ``version`` | string | | + +-------------+--------+----------------------------------+ + + **Response Example** :: + + + Response Example: + + { + "alerts": + [ + { + "level": "success", + "text": "Server Check was successfully updated." + } + ], + } +
http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.rst.txt deleted file mode 100644 index c9d3a3d..0000000 --- a/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.rst.txt +++ /dev/null @@ -1,63 +0,0 @@ -.. -.. -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. - -.. _to-api-v11-dns: - -Static DNS Entries -================== - -.. _to-api-v11-static-dns-route: - -/api/1.1/staticdnsentries -+++++++++++++++++++++++++ - -**GET /api/1.1/staticdnsentries.json** - - Authentication Required: Yes - - Role(s) Required: None - - **Response Properties** - - +---------------------+-----------+------------------------------------------------------------+ - | Parameter | Type | Description | - +=====================+===========+============================================================+ - | ``deliveryservice`` | string | | - +---------------------+-----------+------------------------------------------------------------+ - | ``ttl`` | string | | - +---------------------+-----------+------------------------------------------------------------+ - | ``type`` | string | | - +---------------------+-----------+------------------------------------------------------------+ - | ``address`` | string | | - +---------------------+-----------+------------------------------------------------------------+ - | ``cachegroup`` | string | | - +---------------------+-----------+------------------------------------------------------------+ - | ``host`` | string | | - +---------------------+-----------+------------------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "deliveryservice": "foo-ds", - "ttl": "30", - "type": "CNAME_RECORD", - "address": "bar.foo.baz.tv.", - "cachegroup": "us-co-denver", - "host": "mm" - } - ] - } http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.txt b/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.txt new file mode 100644 index 0000000..c9d3a3d --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v11/static_dns.txt @@ -0,0 +1,63 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-v11-dns: + +Static DNS Entries +================== + +.. _to-api-v11-static-dns-route: + +/api/1.1/staticdnsentries ++++++++++++++++++++++++++ + +**GET /api/1.1/staticdnsentries.json** + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +---------------------+-----------+------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+===========+============================================================+ + | ``deliveryservice`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``ttl`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``type`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``address`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``cachegroup`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + | ``host`` | string | | + +---------------------+-----------+------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "deliveryservice": "foo-ds", + "ttl": "30", + "type": "CNAME_RECORD", + "address": "bar.foo.baz.tv.", + "cachegroup": "us-co-denver", + "host": "mm" + } + ] + } http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v11/status.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/status.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/status.rst.txt deleted file mode 100644 index 6a8c92a..0000000 --- a/docs/latest/_sources/development/traffic_ops_api/v11/status.rst.txt +++ /dev/null @@ -1,127 +0,0 @@ -.. -.. -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. - -.. _to-api-v11-status: - -Status -====== - -.. _to-api-v11-statuses-route: - -/api/1.1/statuses -+++++++++++++++++ - -**GET /api/1.1/statuses** - - Retrieves a list of the server status codes available. - - Authentication Required: Yes - - Role(s) Required: None - - **Response Properties** - - +-----------------+--------+--------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+================================================================================+ - | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally | - +-----------------+--------+--------------------------------------------------------------------------------+ - | ``name`` | string | The string equivalent of the status | - +-----------------+--------+--------------------------------------------------------------------------------+ - | ``description`` | string | A short description of the status | - +-----------------+--------+--------------------------------------------------------------------------------+ - | ``lastUpdated`` | string | The Time / Date this server entry was last updated | - +-----------------+--------+--------------------------------------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "id": "4", - "name": "ADMIN_DOWN", - "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches", - "lastUpdated": "2013-02-13 16:34:29" - }, - { - "id": "5", - "name": "CCR_IGNORE", - "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now", - "lastUpdated": "2013-02-13 16:34:29" - }, - { - "id": "1", - "name": "OFFLINE", - "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches", - "lastUpdated": "2013-02-13 16:34:29" - }, - { - "id": "2", - "name": "ONLINE", - "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges", - "lastUpdated": "2013-02-13 16:34:29" - }, - { - "id": "3", - "name": "REPORTED", - "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now", - "lastUpdated": "2013-02-13 16:34:29" - } - ] - } - -**GET /api/1.1/statuses/:id** - - Retrieves a server status by ID. - - Authentication Required: Yes - - Role(s) Required: None - - **Request Route Parameters** - - +-----------+----------+---------------------------------------------+ - | Name | Required | Description | - +===========+==========+=============================================+ - | ``id`` | yes | Status id. | - +-----------+----------+---------------------------------------------+ - - **Response Properties** - - +-----------------+--------+--------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=================+========+================================================================================+ - | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally | - +-----------------+--------+--------------------------------------------------------------------------------+ - | ``name`` | string | The string equivalent of the status | - +-----------------+--------+--------------------------------------------------------------------------------+ - | ``description`` | string | A short description of the status | - +-----------------+--------+--------------------------------------------------------------------------------+ - | ``lastUpdated`` | string | The Time / Date this server entry was last updated | - +-----------------+--------+--------------------------------------------------------------------------------+ - - **Response Example** :: - - { - "response": [ - { - "id": "4", - "name": "ADMIN_DOWN", - "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches", - "lastUpdated": "2013-02-13 16:34:29" - } - ] - } - http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v11/status.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/status.txt b/docs/latest/_sources/development/traffic_ops_api/v11/status.txt new file mode 100644 index 0000000..6a8c92a --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v11/status.txt @@ -0,0 +1,127 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-v11-status: + +Status +====== + +.. _to-api-v11-statuses-route: + +/api/1.1/statuses ++++++++++++++++++ + +**GET /api/1.1/statuses** + + Retrieves a list of the server status codes available. + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +-----------------+--------+--------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+================================================================================+ + | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``name`` | string | The string equivalent of the status | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``description`` | string | A short description of the status | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time / Date this server entry was last updated | + +-----------------+--------+--------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "4", + "name": "ADMIN_DOWN", + "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches", + "lastUpdated": "2013-02-13 16:34:29" + }, + { + "id": "5", + "name": "CCR_IGNORE", + "description": "Edge: 12M will not include caches in this state in CCR config files. Mid: N\/A for now", + "lastUpdated": "2013-02-13 16:34:29" + }, + { + "id": "1", + "name": "OFFLINE", + "description": "Edge: Puts server in CCR config file in this state, but CCR will never route traffic to it. Mid: Server will not be included in parent.config files for its edge caches", + "lastUpdated": "2013-02-13 16:34:29" + }, + { + "id": "2", + "name": "ONLINE", + "description": "Edge: Puts server in CCR config file in this state, and CCR will always route traffic to it. Mid: Server will be included in parent.config files for its edges", + "lastUpdated": "2013-02-13 16:34:29" + }, + { + "id": "3", + "name": "REPORTED", + "description": "Edge: Puts server in CCR config file in this state, and CCR will adhere to the health protocol. Mid: N\/A for now", + "lastUpdated": "2013-02-13 16:34:29" + } + ] + } + +**GET /api/1.1/statuses/:id** + + Retrieves a server status by ID. + + Authentication Required: Yes + + Role(s) Required: None + + **Request Route Parameters** + + +-----------+----------+---------------------------------------------+ + | Name | Required | Description | + +===========+==========+=============================================+ + | ``id`` | yes | Status id. | + +-----------+----------+---------------------------------------------+ + + **Response Properties** + + +-----------------+--------+--------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+========+================================================================================+ + | ``id`` | string | The id with which Traffic Ops stores this status, and references it internally | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``name`` | string | The string equivalent of the status | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``description`` | string | A short description of the status | + +-----------------+--------+--------------------------------------------------------------------------------+ + | ``lastUpdated`` | string | The Time / Date this server entry was last updated | + +-----------------+--------+--------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": [ + { + "id": "4", + "name": "ADMIN_DOWN", + "description": "Temporary down. Edge: XMPP client will send status OFFLINE to CCR, otherwise similar to REPORTED. Mid: Server will not be included in parent.config files for its edge caches", + "lastUpdated": "2013-02-13 16:34:29" + } + ] + } + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v11/system.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/system.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/system.rst.txt deleted file mode 100644 index c4e53df..0000000 --- a/docs/latest/_sources/development/traffic_ops_api/v11/system.rst.txt +++ /dev/null @@ -1,79 +0,0 @@ -.. -.. -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. - -.. _to-api-v11-sys: - -System -====== - -.. _to-api-v11-sys-route: - -/api/1.1/system -+++++++++++++++ - -**GET /api/1.1/system/info.json** - - Authentication Required: Yes - - Role(s) Required: None - - **Response Properties** - - +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | Key | Type | Description | - +============================+========+======================================================================================================================================+ - | ``parameters`` | hash | This is a hash with the parameter names that describe the Traffic Ops installation as keys. | - | | | These are all the parameters in the ``GLOBAL`` profile. | - +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``>tm.toolname`` | string | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated | - | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). | - +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``>tm.instance_name`` | string | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. | - +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``>traffic_rtr_fwd_proxy`` | string | When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. | - | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting | - | | | this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to | - | | | set this parameter on a production system. | - +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``>tm.url`` | string | The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated | - | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). | - +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``>traffic_mon_fwd_proxy`` | string | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. | - | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting | - | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to | - | | | set this parameter on a production system. | - +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``>tm.logourl`` | string | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. | - +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - | ``>tm.infourl`` | string | This is the "for more information go here" URL, which is visible in the About page. | - +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ - - **Response Example** :: - - { - "response": { - "parameters": { - "tm.toolname": "Traffic Ops", - "tm.infourl": "http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info", - "traffic_mon_fwd_proxy": "http:\/\/proxy.kabletown.net:81", - "traffic_rtr_fwd_proxy": "http:\/\/proxy.kabletown.net:81", - "tm.logourl": "\/images\/tc_logo.png", - "tm.url": "https:\/\/tm.kabletown.net\/", - "tm.instance_name": "Kabletown CDN" - } - }, - } - - http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v11/system.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/system.txt b/docs/latest/_sources/development/traffic_ops_api/v11/system.txt new file mode 100644 index 0000000..c4e53df --- /dev/null +++ b/docs/latest/_sources/development/traffic_ops_api/v11/system.txt @@ -0,0 +1,79 @@ +.. +.. +.. Licensed under the Apache License, Version 2.0 (the "License"); +.. you may not use this file except in compliance with the License. +.. You may obtain a copy of the License at +.. +.. http://www.apache.org/licenses/LICENSE-2.0 +.. +.. Unless required by applicable law or agreed to in writing, software +.. distributed under the License is distributed on an "AS IS" BASIS, +.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +.. See the License for the specific language governing permissions and +.. limitations under the License. +.. + +.. _to-api-v11-sys: + +System +====== + +.. _to-api-v11-sys-route: + +/api/1.1/system ++++++++++++++++ + +**GET /api/1.1/system/info.json** + + Authentication Required: Yes + + Role(s) Required: None + + **Response Properties** + + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | Key | Type | Description | + +============================+========+======================================================================================================================================+ + | ``parameters`` | hash | This is a hash with the parameter names that describe the Traffic Ops installation as keys. | + | | | These are all the parameters in the ``GLOBAL`` profile. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.toolname`` | string | The name of the Traffic Ops tool. Usually "Traffic Ops". Used in the About screen and in the comments headers of the files generated | + | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.instance_name`` | string | The name of the Traffic Ops instance. Can be used when multiple instances are active. Visible in the About page. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>traffic_rtr_fwd_proxy`` | string | When collecting stats from Traffic Router, Traffic Ops uses this forward proxy to pull the stats through. | + | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting | + | | | this variable can significantly lighten the load on the Traffic Router stats system and it is recommended to | + | | | set this parameter on a production system. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.url`` | string | The URL for this Traffic Ops instance. Used in the About screen and in the comments headers of the files generated | + | | | (``# DO NOT EDIT - Generated for atsec-lax-04 by Traffic Ops (https://traffops.kabletown.net/) on Fri Mar 6 05:15:15 UTC 2015``). | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>traffic_mon_fwd_proxy`` | string | When collecting stats from Traffic Monitor, Traffic Ops uses this forward proxy to pull the stats through. | + | | | This can be any of the MID tier caches, or a forward cache specifically deployed for this purpose. Setting | + | | | this variable can significantly lighten the load on the Traffic Monitor system and it is recommended to | + | | | set this parameter on a production system. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.logourl`` | string | This is the URL of the logo for Traffic Ops and can be relative if the logo is under traffic_ops/app/public. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + | ``>tm.infourl`` | string | This is the "for more information go here" URL, which is visible in the About page. | + +----------------------------+--------+--------------------------------------------------------------------------------------------------------------------------------------+ + + **Response Example** :: + + { + "response": { + "parameters": { + "tm.toolname": "Traffic Ops", + "tm.infourl": "http:\/\/staging-03.cdnlab.kabletown.net\/tm\/info", + "traffic_mon_fwd_proxy": "http:\/\/proxy.kabletown.net:81", + "traffic_rtr_fwd_proxy": "http:\/\/proxy.kabletown.net:81", + "tm.logourl": "\/images\/tc_logo.png", + "tm.url": "https:\/\/tm.kabletown.net\/", + "tm.instance_name": "Kabletown CDN" + } + }, + } + + http://git-wip-us.apache.org/repos/asf/incubator-trafficcontrol-website/blob/5521f214/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.rst.txt ---------------------------------------------------------------------- diff --git a/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.rst.txt b/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.rst.txt deleted file mode 100644 index 5ed2654..0000000 --- a/docs/latest/_sources/development/traffic_ops_api/v11/to_extension.rst.txt +++ /dev/null @@ -1,210 +0,0 @@ -.. -.. -.. Licensed under the Apache License, Version 2.0 (the "License"); -.. you may not use this file except in compliance with the License. -.. You may obtain a copy of the License at -.. -.. http://www.apache.org/licenses/LICENSE-2.0 -.. -.. Unless required by applicable law or agreed to in writing, software -.. distributed under the License is distributed on an "AS IS" BASIS, -.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -.. See the License for the specific language governing permissions and -.. limitations under the License. -.. - -.. _to-api-v11-ext: - -TO Extensions -============= - -.. _to-api-v11-ext-route: - -/api/1.1/to_extensions -++++++++++++++++++++++ - -**GET /api/1.1/to_extensions.json** - -Retrieves the list of extensions. - -Authentication Required: Yes - -Role(s) Required: None - -**Response Properties** - -+--------------------------+--------+--------------------------------------------+ -| Parameter | Type | Description | -+==========================+========+============================================+ -|``script_file`` | string | | -+--------------------------+--------+--------------------------------------------+ -|``version`` | string | | -+--------------------------+--------+--------------------------------------------+ -|``name`` | string | | -+--------------------------+--------+--------------------------------------------+ -|``description`` | string | | -+--------------------------+--------+--------------------------------------------+ -|``info_url`` | string | | -+--------------------------+--------+--------------------------------------------+ -|``additional_config_json``| string | | -+--------------------------+--------+--------------------------------------------+ -|``isactive`` | string | | -+--------------------------+--------+--------------------------------------------+ -|``id`` | string | | -+--------------------------+--------+--------------------------------------------+ -|``type`` | string | | -+--------------------------+--------+--------------------------------------------+ -|``servercheck_short_name``| string | | -+--------------------------+--------+--------------------------------------------+ - -**Response Example** :: - - { - "response": [ - { - script_file: "ping", - version: "1.0.0", - name: "ILO_PING", - description: null, - info_url: "http://foo.com/bar.html", - additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ilo_ip_address", "cron": "9 * * * *" }", - isactive: "1", - id: "1", - type: "CHECK_EXTENSION_BOOL", - servercheck_short_name: "ILO" - }, - { - script_file: "ping", - version: "1.0.0", - name: "10G_PING", - description: null, - info_url: "http://foo.com/bar.html", - additional_config_json: "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}, "select": "ip_address", "cron": "18 * * * *" }", - isactive: "1", - id: "2", - type: "CHECK_EXTENSION_BOOL", - servercheck_short_name: "10G" - } - ], - } - - -| - -**POST /api/1.1/to_extensions** - - Creates a Traffic Ops extension. - - Authentication Required: Yes - - Role(s) Required: None - - **Request Parameters** - - +--------------------------+--------+--------------------------------------------+ - | Parameter | Type | Description | - +==========================+========+============================================+ - |``name`` | string | | - +--------------------------+--------+--------------------------------------------+ - |``version`` | string | | - +--------------------------+--------+--------------------------------------------+ - |``info_url`` | string | | - +--------------------------+--------+--------------------------------------------+ - |``script_file`` | string | | - +--------------------------+--------+--------------------------------------------+ - |``isactive`` | string | | - +--------------------------+--------+--------------------------------------------+ - |``additional_config_json``| string | | - +--------------------------+--------+--------------------------------------------+ - |``description`` | string | | - +--------------------------+--------+--------------------------------------------+ - |``servercheck_short_name``| string | | - +--------------------------+--------+--------------------------------------------+ - |``type`` | string | | - +--------------------------+--------+--------------------------------------------+ - - **Request Example** :: - - - { - "name": "ILO_PING", - "version": "1.0.0", - "info_url": "http://foo.com/bar.html", - "script_file": "ping", - "isactive": "1", - "additional_config_json": "{ "path": "/api/1.1/servers.json", "match": { "type": "EDGE"}", - "description": null, - "servercheck_short_name": "ILO" - "type": "CHECK_EXTENSION_BOOL", - } - -| - - **Response Properties** - - +------------+--------+----------------------------------+ - | Parameter | Type | Description | - +============+========+==================================+ - | ``alerts`` | array | A collection of alert messages. | - +------------+--------+----------------------------------+ - | ``>level`` | string | Success, info, warning or error. | - +------------+--------+----------------------------------+ - | ``>text`` | string | Alert message. | - +------------+--------+----------------------------------+ - - **Response Example** :: - - { - "alerts": [ - { - "level": "success", - "text": "Check Extension loaded." - } - ], - } - - -| - -**POST /api/1.1/to_extensions/:id/delete** - - Deletes a Traffic Ops extension. - - Authentication Required: Yes - - Role(s) Required: None - - **Request Route Parameters** - - +--------+----------+-----------------+ - | Name | Required | Description | - +========+==========+=================+ - | ``id`` | yes | TO extension id | - +--------+----------+-----------------+ - - **Response Properties** - - +------------+--------+----------------------------------+ - | Parameter | Type | Description | - +============+========+==================================+ - | ``alerts`` | array | A collection of alert messages. | - +------------+--------+----------------------------------+ - | ``>level`` | string | Success, info, warning or error. | - +------------+--------+----------------------------------+ - | ``>text`` | string | Alert message. | - +------------+--------+----------------------------------+ - - **Response Example** :: - - { - "alerts": [ - { - "level": "success", - "text": "Extension deleted." - } - ], - } - - -| -