CER Config API v15su1
v15su1

IP Subnet Management

This section of API document provides all the operations that can be performed as part of IP Subnet management API in CER.

Add New IP Subnet

/ipsubnetphone

http
CopyPOST https://{CER-IP}/cerappservices/service/ipsubnetphone

Add a new IPv4 Subnet in CER. The request should be made using the POST method with a body formatted as below. On successful addition, a 200 OK response will be sent along with the direct url for the user in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request example

xml
json
Copy<addIPSubnetPhoneRequest>
       <SUBNETID>34.45.35.45</SUBNETID>
       <SUBNETMASK>255.255.255.0</SUBNETMASK>
       <ERLNAME>erl2</ERLNAME>
       <LOCATION>Nashik</LOCATION>
       <DONOTTRACK>false</DONOTTRACK>
</addIPSubnetPhoneRequest>

Copy{
    "SUBNETID": "34.45.35.45",
    "SUBNETMASK": "255.255.255.0",
    "ERLNAME": "erl2",
    "LOCATION": "Nashik",
    "DONOTTRACK": false
}
Fields Description
Subnet ID IP Address of the subnet
Subnet Mask Mask of the subnet
ERL Name ERL to assign to the IP subnet
Do not track phones under this IP subnet If checked, do not track the IPSubnet and the underlying phones in CER
Location (Optional) Location of the new IP Subnet

Response examples

xml
json
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ipSubnetPhoneResponse>
                     <status>SUCCESS</status>
                     <message>IpSubnet Data Added Successfully</message>
</ipSubnetPhoneResponse>

Copy{
    "status": "SUCCESS",
    "message": "IpSubnet Data Added Successfully"
}
Fields Description
status Overall status message for the response
message Detailed message for the response

Add New IPv6 Subnet

v1/ipsubnetv6

http
CopyPOST https://{CER-IP}/cerappservices/service/v1/ipsubnetv6

Add a new IPv6 Subnet in CER. The request should be made using the POST method with a body formatted as below. On successful addition, a 200 OK response will be sent along with the direct url for the user in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request example

xml
Copy<InsertIpSubnetV6Request>
       <subnetID>2001:0db8:85a3:0000:0000:8a2e:0370:700</subnetID>
       <prefix>23</prefix>
       <erlName>erl1</erlName>
       <location>loc3</location>
       <doNotTrack>false</doNotTrack>
</InsertIpSubnetV6Request>

Request Header

Key Type Mandatory/Optional Input Method Default Value Allowed Value Description
TrackingID String O Path variable Empty Random UUID A valid Random UUID generated from client side as path variable or will be generated one as part of server side reference

Request Body

Fields Description
Subnet ID IPv6 Address of the subnet
Prefix Prefix ranges from 1 to 128
ERL Name ERL to assign to the IPv6 subnet
Do not track phones under this IP subnet If checked, do not track the IPv6Subnet and the underlying phones in CER
Location Location of the new IPv6 Subnet

Response example

xml
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<InsertIpSubnetV6Response>
       <message>IpSubnet Data Added Successfully</message>
       <TrackingID>CERAPP_febf161c-51b8-49db-9ae4-5815a62a6374</TrackingID>
</InsertIpSubnetV6Response>
Fields Description
message Detailed message for the response
trackingID Random UUID value

Delete IP Subnet

/ipsubnetphone

http
CopyDELETE https://{CER-IP}/cerappservices/service/ipsubnetphone

Delete an IP Subnet in CER. The request should be made using the DELETE method with a body formatted as below. On successful deletion, a 200 OK response will be sent along with appropriate status message for the respective cluster. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request example

xml
json
Copy<deleteIPSubnetRequest>
<ipsubnet>10.17.36.20</ipsubnet>
</deleteIPSubnetRequest>

Copy{
    "ipsubnet":"10.17.36.20"
}
Fields Description
ipsubnet IP subnet address to be deleted

Response examples

xml
json
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<deleteIPSubnetResponse>
<status>SUCCESS</status>
     <message>IpSubnet Data Deleted Successfully</message>
 </deleteIPSubnetResponse>

Copy{
    "status": "SUCCESS",
    "message": "IpSubnet Data Deleted Successfully"
}
Fields Description
status Overall status message for the response
message Message related to the delete operation on IP Subnet

Update IP Subnet

/ipsubnetphone/update

http
CopyPUT https://{CER-IP}/cerappservices/service/ipsubnetphone/update

Update an existing IP Subnet in CER. The request should be made using the PUT method with a body formatted as below. On successful update, a 200 OK response will be sent in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Request example

xml
json
Copy<updateIPSubnetPhoneRequest>
       <SUBNETID>10.17.36.20</SUBNETID>
       <ERLNAME>Default</ERLNAME>
       <LOCATION>Delhi </LOCATION>
       <DONOTTRACK>false</DONOTTRACK>
</updateIPSubnetPhoneRequest>

Copy{
    "SUBNETID": "10.17.36.20",
    "ERLNAME": "Default",
    "LOCATION": "Delhi ",
    "DONOTTRACK": false
}
Fields Description
Subnet ID IP Address of the subnet
ERL Name ERL to assign to the IP subnet
Do not track phones under this IP subnet If checked, do not track the IPSubnet and the underlying phones in CER
Location (Optional) Location of the new IP Subnet

Response example

xml
JSON
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<updateipSubnetPhoneResponse>
       <status>FAILED</status>
      <message>Default ERL cannot be assigned for IPSubnet</message>
</updateipSubnetPhoneResponse>

Copy{
    "status": "FAILED",
    "message": "Default ERL cannot be assigned for IPSubnet"
}
Fields Description
status Overall status message for the response
message Detailed status message for the response

Fetch IP Subnet

v1/ipsubnet

http
CopyGET https://{CER-IP}/cerappservices/service/v1/ipsubnet

Retrieve the IP Subnet in CER. The request should be made using the GET method. On successful addition, a 200 OK response will be sent along with the direct url for the user in response. In case of failures, an appropriate message will be present in the status field with relevant HTTP return code.

Response example

xml
Copy<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<IpSubnetDetailsResponse>
    <subnetDetails>
        <ipv4Subnets>
            <subnet>
                <subnetID>10.61.99.223</subnetID>
                <subnetMask>255.255.255.255</subnetMask>
                <erlName>erl1</erlName>
                <location>loc1</location>
                <isnontrackable>false</isnontrackable>
                <phones>
                    <phone>
                        <phoneMACAddress>74-e5-f9-e7-6e-4f</phoneMACAddress>
                        <phoneIpv4Address>10.61.99.223 </phoneIpv4Address>
                        <phoneIpv6Address>None</phoneIpv6Address>
                        <phoneExt>1000</phoneExt>
                        <phoneType>Cisco IP Communicator </phoneType>
                    </phone>
                </phones>
            </subnet>
            <subnet>
                <subnetID>10.110.220.182</subnetID>
                <subnetMask>255.255.255.255</subnetMask>
                <erlName>offERL</erlName>
                <location></location>
                <isnontrackable>false</isnontrackable>
            </subnet>
        </ipv4Subnets>
        <ipv6Subnets>
            <subnet>
                <subnetID>2001:0:130f:0:0:9c0:876a:130b</subnetID>
                <prefix>128</prefix>
                <erlName>erl1</erlName>
                <location>loc2</location>
                <isnontrackable>false</isnontrackable>
            </subnet>
        </ipv6Subnets>
    </subnetDetails>
    <paging>
        <offset>0</offset>
        <limit>500</limit>
        <count>3</count>
    </paging>
    <TrackingID>CERAPP_ab3e6aa3-e7ca-4119-90ad-8651476593fe</TrackingID>
</IpSubnetDetailsResponse>

Request URI Param

Key Type Mandatory/Optional Input Method Default Value Allowed Value Description
erlname String O Path variable Null/Empty ERL Name present in the server Display results with the erlname 'Contains' filter.
offset Integer O Path variable 0 Positive Integer The number of subnets after which the current response should list subnets.
limit Integer O Path variable 500 Positive Integer to maximum of 2000 Total number of subnets to be provided on response.

Request Header

Key Type Mandatory/Optional Input Method Default Value Allowed Value Description
TrackingID String O Path variable Empty Random UUID A valid Random UUID generated from client side as path variable or will be generated one as part of server side reference
Fields Description
subnetID SubnetId value
subnetMask SubnetMask value a standard IPv4 address range
prefix IPv6 Subnet prefix ranges from 1 to 128
location Location details
phoneMACAddress Mac address of the phone
phoneIpv4Address IPv4 Address of the Phone
phoneIpv6Address IPv6 address of the Phone
phoneExt Phone's Extension
phoneType Phone's Type
isnontrackable False shows 'Do Not Track' checkbox Enable, True shows 'Do Not Track' checkbox Disable
paging.next URL of the next page of Subnets
paging.prev URL of the previous page of Subnets
paging.offset The starting value of the index for every page for List of Subnets
paging.limit The number of entries for the requested page of the list of Subnets
paging.count Total number of Available Subnets basis on query
TrackingID random UUID value
Next