POST datacollectorranges

Create new ranges for DataCollector client. Roles: ApiRole/FreeRole

Request Information

URI Parameters

None.

Body Parameters

List to create Ranges for DataCollector client.

Collection of DCClientRangeCreate
NameDescriptionTypeAdditional information
ClientID

Client ID

integer

Required

CustomerID

Customer ID

integer

Required

Name

Client range name

string

Required

Exclude

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

boolean

None.

StartIP

Client range start IPv4 address

string

Required

EndIP

Client range end IPv4 address

string

None.

IsEnabled

Is Client range enabled

boolean

None.

Community

Client range community

string

None.

Comment

Client range comment.

string

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "ClientID": 1,
    "CustomerID": 2,
    "Name": "sample string 3",
    "Exclude": true,
    "StartIP": "sample string 5",
    "EndIP": "sample string 6",
    "IsEnabled": true,
    "Community": "sample string 8",
    "Comment": "sample string 9"
  },
  {
    "ClientID": 1,
    "CustomerID": 2,
    "Name": "sample string 3",
    "Exclude": true,
    "StartIP": "sample string 5",
    "EndIP": "sample string 6",
    "IsEnabled": true,
    "Community": "sample string 8",
    "Comment": "sample string 9"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDCClientRangeCreate xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DCClientRangeCreate>
    <ClientID>1</ClientID>
    <CustomerID>2</CustomerID>
    <Name>sample string 3</Name>
    <Exclude>true</Exclude>
    <StartIP>sample string 5</StartIP>
    <EndIP>sample string 6</EndIP>
    <IsEnabled>true</IsEnabled>
    <Community>sample string 8</Community>
    <Comment>sample string 9</Comment>
  </DCClientRangeCreate>
  <DCClientRangeCreate>
    <ClientID>1</ClientID>
    <CustomerID>2</CustomerID>
    <Name>sample string 3</Name>
    <Exclude>true</Exclude>
    <StartIP>sample string 5</StartIP>
    <EndIP>sample string 6</EndIP>
    <IsEnabled>true</IsEnabled>
    <Community>sample string 8</Community>
    <Comment>sample string 9</Comment>
  </DCClientRangeCreate>
</ArrayOfDCClientRangeCreate>

Response Information

Resource Description

Returns newly created ranges for DC Client object.

Collection of 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-05-24T14:58:21.6872288+00:00",
    "Comment": "sample string 10",
    "Exclude": true
  },
  {
    "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-05-24T14:58:21.6872288+00:00",
    "Comment": "sample string 10",
    "Exclude": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfDCClientRange xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <DCClientRange>
    <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-05-24T14:58:21.6872288+00:00</Created>
    <Comment>sample string 10</Comment>
    <Exclude>true</Exclude>
  </DCClientRange>
  <DCClientRange>
    <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-05-24T14:58:21.6872288+00:00</Created>
    <Comment>sample string 10</Comment>
    <Exclude>true</Exclude>
  </DCClientRange>
</ArrayOfDCClientRange>