2.20.1 Obtaining IP Switch List

The API acquires a list of IP switches.

Execution permission

Admin, Modify

API version

Request format

GET http[s]://host:port/Analytics/version/objects/IPSwitches

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddress":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "accessPointType":"...",
            "accessPointSnmpVersion":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	IPSwitch[]	A list of IPSwitch objects. For details about IPSwitch, see the table below.
pagination	Pagination	Page information. This parameter is displayed only when the relevant resource exists.
count	int	Number of data items that meet the conditions.

data (Type: IPSwitch)

Attribute	Type	Description
instanceID	long	ID of the IP switch
name	string	Name of the IP switch
ipAddress	string	IP address of the IP switch
status	enum	Status of the IP switch (For details about the specifiable values, see the table NodeStatusType in List of enumerators.) The specifiable values are as follows: Normal Warning Error Unreachable Unknown NotMonitored
monitorStatus	enum	Monitoring status of the IP switch. (For details about the specifiable values, see the table ManagementLevelType in List of enumerators.) The specifiable values are as follows: New Manage ignore MonitorOff
description	string	Detailed information about the IP Switch
usedCredentialID	long	ID for identifying authentication information used for detection
usedCredentials	string	Name of authentication information used for detection
thresholdProfileID	long	ID of the threshold profile assigned to the IP switch
thresholdProfileName	string	Name of the threshold profile assigned to the IP switch
originalThresholdProfileID	string	Original threshold profile ID of the threshold profile assigned to the IP switch
accessPointType	enum	Type of authentication information used for detection. (For details about the specifiable values, see the table ProtocolType in List of enumerators.) The specifiable values are as follows: SNMP
accessPointSnmpVersion	enum	Version of SNMP used for detection (For details about the specifiable values, see the table SnmpVersion in List of enumerators.) The specifiable values are as follows: V1_V2C V3
accessPointIpAddress	string	IP address used for connections to monitoring targets
accessPointUser	string	User ID used for connections to monitoring targets

pagination (Type: Pagination)

Attribute	Type	Description
page	integer	page
pageSize	integer	Size of the pages
numPages	integer	Number of the pages
totalCount	integer	Number of the objects

Status codes

Status code	Reason phrase	Description
200	OK	Success.
401	Unauthorized	No login privilege.
403	Forbidden	No reference privilege.
412	Precondition Failed	The server is not available.
500	Internal Server Error	Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/IPSwitches HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja


[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 21:15:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : 3,
    "name" : "dell2",
    "ipAddress" : "10.197.87.242",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "YYYY Ethernet Switch",
    "usedCredentialID" : 7,
    "usedCredentials" : "10.197.87.242",
    "thresholdProfileID" : 10,
    "thresholdProfileName" : "Default Profile for IP Switch",
    "accessPointType" : "SNMP",
    "accessPointSnmpVersion" : "V1_V2C",
    "accessPointIpAddress" : "10.197.87.242",
  } ],
  "count" : 1
}