[Survey] The 2025 Observability Survey - Share your opinion and earn $10.Take the survey

IP Group AP

1. IPGroup Creation

Api: http://ServerIP:port/api/json/nfaipgroup/addIPGroup

Type: POST

Parameters:

Field Description

apiKey

api key
GroupName IPGroup Name
Desc ipgroup description
speed

speed

DevList interface id (multiple interface id can be specified with , seperated)
IPData

IPData need to be formed based on IPType parameter.

if IPType is ipaddress => IP Address

if IPType is ipnetwork => IP Address,NetMask

if IPType is iprange => Starting IP Address, Ending IP Address, NetMask

(multiple ip address can be specified with - seperated )

IPType

IPData type detail. possible values are "ipaddress/ipnetwork/iprange"

(multiple type can be specified with , seperated)

status

IPData status. possible values are "include/exclude".

(multiple type can be specified with, seperated)

Note *: The number of values in IPData, IPType, status should be equal.

port

port (multiple port can be specified with, seperated)

protocol

protocol (multiple protocol can be specified with, seperated)

Note *: The number of values in port, protocol should be equal.

Dscp

dscp (multiple dscp can be specified with, seperated)

Sample API:

Request:

http://localhost:8083/api/json/nfaipgroup/addIPGroup

formData = {

"apiKey": "fa6073c78bfe85e71b0a69e7c7b27f77",

 

"GroupName": "MyIpGroup",

"Desc": "my network",

"DevList": "5000018,5000014,5000001,5000059,5000053",

"speed": "30000"

 

"IPData": "192.168.1.1-100.1.1.1,255.255.128.0,-200.0.0.1,200.0.0.250,255.255.255.0",

"IPType": "ipaddress,ipnetwork,iprange",

"status": "include,include,include",

 

"port": "80,80",

"protocol": "TCP,UDP",

"Dscp": "AF32,100001",

};

Response:

{

"message": "IPGroup added successfully",

"GName": "MyIpGroup"

}

 

2. IPGroup Modification

Api: http://ServerIP:port/api/json/nfaipgroup/modifyIPGroup

Type: POST

Parameters:

Field Description

apiKey

api key
ipGrpID IP Group Id (exisitng Ip group id that needs to be modified)
GroupName IPGroup Name (exisitng IPGroup Name that needs to be modified)
Desc ipgroup description
speed

speed

DevList interface id (multiple interface id can be specified with , seperated)
IPData

IPData need to be formed based on IPType parameter.

if IPType is ipaddress => IP Address

if IPType is ipnetwork => IP Address,NetMask

if IPType is iprange => Starting IP Address, Ending IP Address, NetMask

(multiple ip address can be specified with - seperated )

IPType

IPData type detail. possible values are "ipaddress/ipnetwork/iprange"

(multiple type can be specified with , seperated)

status

IPData status. possible values are "include/exclude".

(multiple type can be specified with, seperated)

Note *: The number of values in IPData, IPType, status should be equal.

port

port (multiple port can be specified with, seperated)

protocol

protocol (multiple protocol can be specified with, seperated)

Note *: The number of values in port, protocol should be equal.

Dscp

dscp (multiple dscp can be specified with, seperated)

Sample API:

Request:

http://localhost:8083/api/json/nfaipgroup/modifyIPGroup

formData = {

"apiKey": "fa6073c78bfe85e71b0a69e7c7b27f77",

 

"ipGrpID":"2500005"

"GroupName": "MyIpGroup",

"Desc": "my network",

"DevList": "5000018,5000014,5000001,5000059,5000053",

"speed": "30000"

 

"IPData": "192.168.1.1-100.1.1.1,255.255.128.0,-200.0.0.1,200.0.0.250,255.255.255.0",

"IPType": "ipaddress,ipnetwork,iprange",

"status": "include,include,include",

 

"port": "80,80",

"protocol": "TCP,UDP",

"Dscp": "AF32,100001",

};

Response:

{

"message": "[MyIpGroup] IP Group has been modified successfully"

"GName": "MyIpGroup"

}

 

 

3. Get IPGroup Deta

Api: http://ServerIP:port/api/json/nfaipgroup/listIPGroup

Type: GET

Parameters:

Field Description

apiKey

api key
GroupName ip group name to fetch details

Sample API:

Request:

http://localhost:8083/api/json/nfaipgroup/listIPGroup?apiKey=fa6073c78bfe85e71b0a69e7c7b27f77&GroupName=MyIpGroup

Response:

{

"app": [

"80 (TCP)",

"80 (UDP)"

],

"dscp": [

"AF32 (28)",

"100001 (33)"

],

"base": {

"Name": "MyIpGroup",

"speed": 40000,

"status": "Enabled",

"ID": 2500005,

"bandwidth": 0

},

"Asso_Device": [

"2.2.2.81 (IfIndex1)",

"2.2.2.9 (IfIndex2, IfIndex1)",

"2.2.2.49 (IfIndex2, IfIndex1)"

],

"Asso_Dev_id": [

"5000053",

"5000059",

"5000001",

"5000014",

"5000018"

],

"ip": [

[

"IPAddress",

"Include",

"192.168.1.1",

"---"

],

[

"IPNetwork",

"Include",

"100.1.1.1",

"255.255.128.0"

],

[

"IPRange",

"Include",

"200.0.0.1 to 200.0.0.250",

"255.255.255.0"

]

]

}

]

}

 

Back to Top