servers/details

Retrieves details of Servers.

Deprecated since version 3.1: This endpoint has been removed from the latest version of the API, and clients are advised to use servers instead.

GET

Auth. Required

Yes

Roles Required

None

Response Type

Array

Note

On top of the response including the response key that is of type array it will also include the keys limit, orderby, and size.

Request Structure

Table 223 Request Query Parameters

Name

Required

Description

hostName

Required if no physLocationID provided

Return only the servers with this (short) hostname. Capitalization of “hostName” is important.

physLocationID

Required if no hostName provided

Return only servers with this integral, unique identifier for the physical location where the server resides. Capitalization of “physLocationID” is important.

#515 Request Example
GET /api/3.0/servers/details?hostName=edge HTTP/1.1
User-Agent: python-requests/2.22.0
Accept-Encoding: gzip, deflate
Accept: */*
Connection: keep-alive
Cookie: mojolicious=...

Response Structure

limit

The maximum size of the response array, also indicative of the number of results per page using the pagination requested by the query parameters (if any) - this should be the same as the limit query parameter (if given)

orderby

A string that names the field by which the elements of the response array are ordered - should be the same as the orderby request query parameter (if given)

response

An array of objects, each of which represents the details of a given Server.

cachegroup

A string that is the name of the Cache Group to which the server belongs

cdnName

Name of the CDN to which the server belongs

deliveryservices

An array of integral, unique identifiers for Delivery Services to which this server belongs

domainName

The domain part of the server’s FQDN

guid

An identifier used to uniquely identify the server

Note

This is a legacy key which only still exists for compatibility reasons - it should always be null

hostName

The (short) hostname of the server

httpsPort

The port on which the server listens for incoming HTTPS connections/requests

id

An integral, unique identifier for this server

iloIpAddress

The IPv4 address of the server’s ILO service1

iloIpGateway

The IPv4 gateway address of the server’s ILO service1

iloIpNetmask

The IPv4 subnet mask of the server’s ILO service1

iloPassword

The password of the of the server’s ILO service user1 - displays as simply ****** if the currently logged-in user does not have the ‘admin’ or ‘operations’ Role(s)

iloUsername

The user name for the server’s ILO service1

interfaces

An array of interface and IP address information

max_bandwidth

The maximum allowed bandwidth for this interface to be considered “healthy” by Traffic Monitor. This has no effect if monitor is not true. Values are in kb/s. The value 0 means “no limit”.

monitor

A boolean indicating if Traffic Monitor should monitor this interface

mtu

The MTU to configure for interfaceName

name

The network interface name used by the server.

ipAddresses

An array of the IP address information for the interface

address

The IPv4 or IPv6 address and subnet mask of the server - applicable for the interface name

gateway

The IPv4 or IPv6 gateway address of the server - applicable for the interface name

service_address

A boolean determining if content will be routed to the IP address

mgmtIpAddress

The IPv4 address of the server’s management port

mgmtIpGateway

The IPv4 gateway of the server’s management port

mgmtIpNetmask

The IPv4 subnet mask of the server’s management port

offlineReason

A user-entered reason why the server is in ADMIN_DOWN or OFFLINE status

physLocation

The name of the physical location where the server resides

profile

The Name of the Profile used by this server

profileDesc

A Description of the Profile used by this server

rack

A string indicating “server rack” location

routerHostName

The human-readable name of the router responsible for reaching this server

routerPortName

The human-readable name of the port used by the router responsible for reaching this server

status

The status of the server

See also

Health Protocol

tcpPort

The port on which this server listens for incoming TCP connections

Note

This is typically thought of as synonymous with “HTTP port”, as the port specified by httpsPort may also be used for incoming TCP connections.

type

The name of the ‘type’ of this server

xmppId

A system-generated UUID used to generate a server hashId for use in Traffic Router’s consistent hashing algorithm. This value is set when a server is created and cannot be changed afterwards.

xmppPasswd

The password used in XMPP communications with the server

size

The page number - if pagination was requested in the query parameters, else 0 to indicate no pagination - of the results represented by the response array. This is named “size” for legacy reasons

#516 Response Example
HTTP/1.1 200 OK
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
Access-Control-Allow-Origin: *
Content-Encoding: gzip
Content-Type: application/json
Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 01:27:36 GMT; Max-Age=3600; HttpOnly
Whole-Content-Sha512: HW2F3CEpohNAvNlEDhUfXmtwpEka4dwUWFVUSSjW98aXiv10vI6ysRIcC2P9huabCz5fdHqY3tp0LR4ekwEHqw==
X-Server-Name: traffic_ops_golang/
Date: Mon, 24 Feb 2020 00:27:36 GMT
Content-Length: 493

{
    "limit": 1000,
    "orderby": "hostName",
    "response": [
        {
            "cachegroup": "CDN_in_a_Box_Edge",
            "cdnName": "CDN-in-a-Box",
            "deliveryservices": [
                1
            ],
            "domainName": "infra.ciab.test",
            "guid": null,
            "hardwareInfo": null,
            "hostName": "edge",
            "httpsPort": 443,
            "id": 5,
            "iloIpAddress": "",
            "iloIpGateway": "",
            "iloIpNetmask": "",
            "iloPassword": "",
            "iloUsername": "",
            "mgmtIpAddress": "",
            "mgmtIpGateway": "",
            "mgmtIpNetmask": "",
            "offlineReason": "",
            "physLocation": "Apachecon North America 2018",
            "profile": "ATS_EDGE_TIER_CACHE",
            "profileDesc": "Edge Cache - Apache Traffic Server",
            "rack": "",
            "routerHostName": "",
            "routerPortName": "",
            "status": "REPORTED",
            "tcpPort": 80,
            "type": "EDGE",
            "xmppId": "edge",
            "xmppPasswd": "",
            "interfaces": [
                { "ipAddresses": [
                        {
                            "address": "172.16.239.100",
                            "gateway": "172.16.239.1",
                            "service_address": true
                        },
                        {
                            "address": "fc01:9400:1000:8::100",
                            "gateway": "fc01:9400:1000:8::1",
                            "service_address": true
                        }
                    ],
                    "max_bandwidth": 0,
                    "monitor": true,
                    "mtu": 1500,
                    "name": "eth0"
                }
            ]
        }
    ],
    "size": 1
}
1(1,2,3,4,5)

For more information see the Wikipedia page on Lights-Out management.