Overview
Please
update the file: WEB-INF/classes/com/cisco/cpm/ers/sdk-resources.properties
with the following key: sxp.sxplocalbindings.description
Please note that these examples are not meant to
be used as is because they have references to DB data.
You should treat it as a basic template and edit it before sending to server.
Resource definition
|
Attribute |
Type |
Required |
Default
value |
Description |
|
name |
String |
Yes |
Resource name |
|
|
id |
String |
Yes |
Resourse UUID |
|
|
description |
String |
No |
||
|
bindingName |
String |
Yes |
||
|
ipAddressOrHost |
String |
Yes |
||
|
sgt |
String |
Yes |
||
|
sxpVpn |
String |
Yes |
XML example:
1. XML
2.
<?xml version="1.0" encoding="UTF-8"?>
3. <ns0:sxplocalbindings
xmlns:ns0="sxp.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="Description(Optional)">
4.
<bindingName>SXP Local Binding Name(Optional)</bindingName>
5. <ipAddressOrHost>ipAddressOrHost</ipAddressOrHost>
6.
<sgt>sgt_id</sgt>
7. <sxpVpn>Sxp Vpn Name</sxpVpn>
8.
</ns0:sxplocalbindings>
9.
10.JSON
11.{
12. "ERSSxpLocalBindings" : {
13. "description" : "Description(Optional)",
14. "bindingName" : "SXP
Local Binding Name(Optional)",
15. "ipAddressOrHost" : "ipAddressOrHost",
16. "sxpVpn" : "Sxp Vpn
Name",
17. "sgt" : "sgt_id"
18. }
19.}
Revision History
|
Revision
0 |
|
|
Resource Version |
1.0 |
|
ISE Version |
2.0 |
|
Description |
Initial Ise Version |
Api Reference
Get-By-Id
Request:
|
Method: |
GET |
|
URI: |
https://10.56.60.175:9060/ers/config/sxplocalbindings/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
sxp.sxplocalbindings.1.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
fetch |
Request Content:
N/A
Response: (ERSSxpLocalBindings)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:sxplocalbindings xmlns:ns0="sxp.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="Description(Optional)">
<bindingName>SXP Local Binding Name(Optional)</bindingName>
<ipAddressOrHost>ipAddressOrHost</ipAddressOrHost>
<sgt>sgt_id</sgt>
<sxpVpn>Sxp Vpn Name</sxpVpn>
</ns0:sxplocalbindings>
JSON
{
"ERSSxpLocalBindings" : {
"description" : "Description(Optional)",
"bindingName" : "SXP
Local Binding Name(Optional)",
"ipAddressOrHost" : "ipAddressOrHost",
"sxpVpn" : "Sxp Vpn
Name",
"sgt" : "sgt_id"
}
}
Update
Request:
|
Method: |
PUT |
|
URI: |
https://10.56.60.175:9060/ers/config/sxplocalbindings/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
sxp.sxplocalbindings.1.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
The Token value from
the GET X-CSRF-TOKEN fetch request |
|
Bulk Support: |
Operation 'Update' can be used
within Bulk Request. |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:sxplocalbindings xmlns:ns0="sxp.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="Description(Optional)">
<bindingName>SXP Local Binding Name(Optional)</bindingName>
<ipAddressOrHost>ipAddressOrHost</ipAddressOrHost>
<sgt>sgt_id</sgt>
<sxpVpn>Sxp Vpn Name</sxpVpn>
</ns0:sxplocalbindings>
JSON
{
"ERSSxpLocalBindings" : {
"description" : "Description(Optional)",
"bindingName" : "SXP
Local Binding Name(Optional)",
"ipAddressOrHost" : "ipAddressOrHost",
"sxpVpn" : "Sxp Vpn
Name",
"sgt" : "sgt_id"
}
}
Response: (UpdatedFieldsList)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:updatedFields xmlns:ns0="ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<updatedField
field="field1">
<newValue>val_new</newValue>
<oldValue>val_old</oldValue>
</updatedField>
<updatedField
field="some
other field">
<newValue>val_new</newValue>
<oldValue>val_old</oldValue>
</updatedField>
</ns0:updatedFields>
JSON
{
"UpdatedFieldsList" : {
"updatedField" : [ {
"field" : "field1",
"oldValue" : "val_old",
"newValue" : "val_new"
}, {
"field" : "some other field",
"oldValue" : "val_old",
"newValue" : "val_new"
} ]
}
}
Delete
Request:
|
Method: |
DELETE |
|
URI: |
https://10.56.60.175:9060/ers/config/sxplocalbindings/{id} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
sxp.sxplocalbindings.1.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
The Token value from
the GET X-CSRF-TOKEN fetch request |
|
Bulk Support: |
Operation 'Delete' can be used
within Bulk Request. |
Request Content:
N/A
Response: (N/A)
|
HTTP Status: |
204 (No Content) |
Content:
N/A
Create
Request:
|
Method: |
POST |
|
URI: |
https://10.56.60.175:9060/ers/config/sxplocalbindings |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
sxp.sxplocalbindings.1.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
The Token value from
the GET X-CSRF-TOKEN fetch request |
|
Bulk Support: |
Operation 'Create' can be used
within Bulk Request. |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:sxplocalbindings xmlns:ns0="sxp.ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns1="ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" description="Description(Optional)">
<bindingName>SXP Local Binding Name(Optional)</bindingName>
<ipAddressOrHost>ipAddressOrHost</ipAddressOrHost>
<sgt>sgt_id</sgt>
<sxpVpn>Sxp Vpn Name</sxpVpn>
</ns0:sxplocalbindings>
JSON
{
"ERSSxpLocalBindings" : {
"description" : "Description(Optional)",
"bindingName" : "SXP
Local Binding Name(Optional)",
"ipAddressOrHost" : "ipAddressOrHost",
"sxpVpn" : "Sxp Vpn
Name",
"sgt" : "sgt_id"
}
}
Response: (N/A)
|
HTTP Status: |
201 (Created) |
Content:
N/A
Get-All
Request:
|
Method: |
GET |
|
URI: |
https://10.56.60.175:9060/ers/config/sxplocalbindings |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
|
HTTP 'Accept' Header: |
application/xml | application/json |
|
HTTP 'ERS-Media-Type' Header (Not
Mandatory): |
sxp.sxplocalbindings.1.0 |
|
HTTP 'X-CSRF-TOKEN' Header
(Required Only if Enabled from GUI): |
fetch |
Request Content:
N/A
Response: (SearchResult)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:searchResult xmlns:ns0="v2.ers.ise.cisco.com" xmlns:ns1="ers.ise.cisco.com" xmlns:ers-v2="ers-v2" total="2">
<ns0:nextPage rel="next" href="link-to-next-page" type="application/xml"/>
<ns0:previousPage rel="previous" href="link-to-previous-page" type="application/xml"/>
<ns0:resources>
<ns1:resource description="description1" id="id1" name="name1"/>
<ns1:resource description="description2" id="id2" name="name2"/>
</ns0:resources>
</ns0:searchResult>
JSON
{
"SearchResult" : {
"total" : 2,
"resources" : [ {
"id" : "id1",
"name" : "name1",
"description" : "description1"
}, {
"id" : "id2",
"name" : "name2",
"description" : "description2"
} ],
"nextPage" : {
"rel" : "next",
"href" : "link-to-next-page",
"type" : "application/xml"
},
"previousPage" : {
"rel" : "previous",
"href" : "link-to-previous-page",
"type" : "application/xml"
}
}
}
Get Version
Request:
|
Method: |
GET |
|
URI: |
https://10.56.60.175:9060/ers/config/sxplocalbindings/versioninfo |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
Response: (Version Info)
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:versionInfo xmlns:ns0="ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema">
<currentServerVersion>1.0</currentServerVersion>
<link rel="self" href="link" type="application/xml"/>
<supportedVersions>0.9,0.8</supportedVersions>
</ns0:versionInfo>
JSON
{
"VersionInfo" : {
"currentServerVersion" : "1.0",
"supportedVersions" : "0.9,0.8",
"link" : {
"rel" : "self",
"href" : "link",
"type" : "application/xml"
}
}
}
Bulk Request
Request:
|
Method: |
PUT |
|
URI: |
https://10.56.60.175:9060/ers/config/sxplocalbindings/bulk/submit |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
Request Content:
XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns6:localbindingBulkrequest operationType="create"
resourceMediaType="vnd.com.cisco.ise.sxp.sxplocalbindings.1.0+xml" xmlns:ns6="sxp.ers.ise.cisco.com" xmlns:ns5="trustsec.ers.ise.cisco.com" xmlns:ns8="network.ers.ise.cisco.com" xmlns:ns7="anc.ers.ise.cisco.com" xmlns:ers="ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:ns4="identity.ers.ise.cisco.com">
<ns6:resourcesList>
<ns6:sxplocalbindings
description="Bulk demo local binding (Optional)">
<bindingName>LocalBinding1(Optional)</bindingName>
<ipAddressOrHost>Ip Address or Host</ipAddressOrHost>
<sgt>sgt_id</sgt>
<sxpVpn>Sxp Vpn Name</sxpVpn>
</ns6:sxplocalbindings>
<ns6:sxplocalbindings
description="Bulk demo local binding (Optional)">
<bindingName>LocalBinding2(Optional)</bindingName>
<ipAddressOrHost>Ip Address or Host</ipAddressOrHost>
<sgt>sgt_id</sgt>
<sxpVpn>Sxp Vpn Name</sxpVpn>
</ns6:sxplocalbindings>
</ns6:resourcesList>
</ns6:localbindingBulkrequest>
JSON
{
"LocalBindingBulkRequest" : {
"operationType" : "create",
"resourceMediaType" : "vnd.com.cisco.ise.sxp.sxplocalbindings.1.0+xml"
}
}
Response:
|
HTTP Status: |
202 (Accepted) |
Content:
N/A
Monitor Bulk Status
Request:
|
Method: |
GET |
|
URI: |
https://10.56.60.175:9060/ers/config/sxplocalbindings/bulk/{bulkid} |
|
HTTP 'Content-Type' Header: |
application/xml | application/json |
Request Content:
N/A
Response:
|
HTTP Status: |
200 (OK) |
Content:
XML
<?xml version="1.0" encoding="UTF-8"?>
<ns0:bulkStatus xmlns:ns0="ers.ise.cisco.com" xmlns:xs="http://www.w3.org/2001/XMLSchema" bulkId="1546946061059" executionStatus="COMPLETED" failCount="0" mediaType="" operationType="create" resourcesCount="5" startTime="Tue Jan
08 11:14:21 UTC 2019" successCount="5">
<ns0:resourcesStatus>
<ns0:resourceStatus description="description..." id="1234454324" name="resource1" status="PENDING">
<resourceExecutionStatus>PENDING</resourceExecutionStatus>
</ns0:resourceStatus>
<ns0:resourceStatus description="description..." id="2343242342" name="resource2" status="PENDING">
<resourceExecutionStatus>PENDING</resourceExecutionStatus>
</ns0:resourceStatus>
<ns0:resourceStatus description="description..." id="4564566456" name="resource3" status="PENDING">
<resourceExecutionStatus>PENDING</resourceExecutionStatus>
</ns0:resourceStatus>
<ns0:resourceStatus
description="description..." id="6544566455" name="resource4" status="PENDING">
<resourceExecutionStatus>PENDING</resourceExecutionStatus>
</ns0:resourceStatus>
</ns0:resourcesStatus>
</ns0:bulkStatus>
JSON
{
"BulkStatus" : {
"bulkId" : "1546946061059",
"mediaType" : "",
"executionStatus" : "COMPLETED",
"operationType" : "create",
"startTime" : "Tue Jan
08 11:14:21 UTC 2019",
"resourcesCount" : 5,
"successCount" : 5,
"failCount" : 0,
"resourcesStatus" : [ {
"id" : "1234454324",
"name" : "resource1",
"description" : "description...",
"resourceExecutionStatus" : "PENDING",
"status" : "PENDING"
}, {
"id" : "2343242342",
"name" : "resource2",
"description" : "description...",
"resourceExecutionStatus" : "PENDING",
"status" : "PENDING"
}, {
"id" : "4564566456",
"name" : "resource3",
"description" : "description...",
"resourceExecutionStatus" : "PENDING",
"status" : "PENDING"
}, {
"id" : "6544566455",
"name" : "resource4",
"description" : "description...",
"resourceExecutionStatus" : "PENDING",
"status" : "PENDING"
} ]
}
}