GET datacollectorranges/{clientRangeID}

Get client range for DataCollector client Roles: ApiRole

Request Information

URI Parameters

NameDescriptionTypeAdditional information
clientRangeID

Client Range ID

integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns a client range for DataCollector specific to ClientID.

DCClientRange
NameDescriptionTypeAdditional information
ClientRangeID

Client range id

integer

None.

ClientID

Client ID

integer

None.

Name

Client range name

string

None.

StartIP

Client range start IPv4 address

string

None.

EndIP

Client range end IPv4 address

string

None.

State

Client range state - Disabled, enabled, Force Dicover or Force collect

string

None.

IsEnabled

Is Client range enabled

boolean

None.

Community

Client range community

string

None.

NumOfDevices

No. of devices found in client range

integer

None.

Created

Client range created date

date

None.

Comment

Client range comment.

string

None.

Exclude

Client range excluded. Set true if this client range to be excluded

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "ClientRangeID": 1,
  "ClientID": 2,
  "Name": "sample string 3",
  "StartIP": "sample string 4",
  "EndIP": "sample string 5",
  "State": "sample string 6",
  "IsEnabled": true,
  "Community": "sample string 8",
  "NumOfDevices": 1,
  "Created": "2018-10-20T02:29:28.1539429+00:00",
  "Comment": "sample string 10",
  "Exclude": true
}

application/xml, text/xml

Sample:
<DCClientRange xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ClientRangeID>1</ClientRangeID>
  <ClientID>2</ClientID>
  <Name>sample string 3</Name>
  <StartIP>sample string 4</StartIP>
  <EndIP>sample string 5</EndIP>
  <State>sample string 6</State>
  <IsEnabled>true</IsEnabled>
  <Community>sample string 8</Community>
  <NumOfDevices>1</NumOfDevices>
  <Created>2018-10-20T02:29:28.1539429+00:00</Created>
  <Comment>sample string 10</Comment>
  <Exclude>true</Exclude>
</DCClientRange>