Cisco Unity Connection Provisioning Interface (CUPI) API -- Port Group Server Settings

From DocWiki

Revision as of 11:01, 1 November 2013 by Deeptija (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


Port Group Server Settings

Administrator can use this API to create/update/fetch/delete the port group server settings API. Creation/Modification/Deletion of port group servers for PIMG is not supported.


Adding a SIP Proxy Server to Existing Port Group with SIP Phone Integration

The following are the mandatory fields:

  • MediaPortGroupObjectId
  • MediaRemoteServiceEnum

If you do not specify the IP address, default value is the loop back IP address.

POST https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/portgroupservers
Request Body:
<PortGroupServer>
     <MediaRemoteServiceEnum>102</MediaRemoteServiceEnum>
     <MediaPortGroupObjectId>42ef5946-c5f2-4556-9897-
   6a4b6e116dfa</MediaPortGroupObjectId>
     <HostOrIPAddress>12.12.12.12</HostOrIPAddress>
     <Port>5060</Port>
     <TlsPort>5061</TlsPort>
     <Precedence>0</Precedence>
</PortGroupServer>

The following is the response from the above *POST* request and the actual response will depend upon the information given by you:

Response Code: 201
/vmrest/portgroupservers/8a009b99-22cf-4305-822d-f5e449a42263

JSON Example:

Request URI:
POST https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/portgroupservers
Accept: application/json
Content-Type: application/json
Connection: keep-alive
{
     "MediaRemoteServiceEnum":"102",
     "MediaPortGroupObjectId":"42ef5946-c5f2-4556-9897-6a4b6e116dfa",
     "HostOrIPAddress":"12.12.12.12",
     "Port":"5060",
     "TlsPort":"5061",
     "Precedence":0"
}

The following is the response from the above *POST* request and the actual response will depend upon the information given by you:

Response Code: 201
/vmrest/portgroupservers/8a009b99-22cf-4305-822d-f5e449a42263


Adding a TFTP Server to Existing Port Group with SIP Phone Integration

POST https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/portgroupservers
Request Body:
<PortGroupServer>
     <MediaRemoteServiceEnum>101</MediaRemoteServiceEnum>
     <MediaPortGroupObjectId>42ef5946-c5f2-4556-9897-
   6a4b6e116dfa</MediaPortGroupObjectId>
     <HostOrIPAddress>110.110.110.110</HostOrIPAddress>
     <Precedence>0</Precedence>
</PortGroupServer>

The following is the response from the above *POST* request and the actual response will depend upon the information given by you:

Response Code: 204
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263

JSON Example:

POST https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/portgroupservers
Accept: application/json
Content-Type: application/json
Connection: keep-alive
Request Body:
{
     "MediaRemoteServiceEnum":"101", "MediaPortGroupObjectId":"42ef5946-c5f2-4556-9897-
     6a4b6e116dfa", "HostOrIPAddress":"110.110.110.110",
     "Precedence":0"
}

The following is the response from the above *POST* request and the actual response will depend upon the information given by you:

Response Code: 201
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263


Adding a CCM Server to Existing Port Group with SCCP Phone Integration

Request URI:
POST https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/portgroupservers
<PortGroupServer>
     <MediaRemoteServiceEnum>100</MediaRemoteServiceEnum>
     <MediaPortGroupObjectId>42ef5946-c5f2-4556-9897-
   6a4b6e116dfa</MediaPortGroupObjectId>
     <HostOrIPAddress>12.12.12.12</HostOrIPAddress>
     <Port>5060</Port>
     <TlsPort>5061</TlsPort>
     <Precedence>0</Precedence>
</PortGroupServer>

The following is the response from the above *POST* request and the actual response will depend upon the information given by you:

Response Code: 201
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263

JSON Example:

Request URI:
POST https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/portgroupservers
Accept: application/json
Content-Type: application/json
Connection: keep-alive
Request Body:
{
     "MediaRemoteServiceEnum":"100", "MediaPortGroupObjectId":"42ef5946-c5f2-4556-9897-
     6a4b6e116dfa", "HostOrIPAddress":"12.12.12.12",
     "Port":"5060",
     "TlsPort":"5061",
     "Precedence":0"
}

The following is the response from the above *POST* request and the actual response will depend upon the information given by you:

Response Code: 201
/vmrest/portgroups/8a009b99-22cf-4305-822d-f5e449a42263


Listing of Servers Configuration for a Port Group

The following is an example of the GET request that will list all the servers’ configuration for a port group:

  GET https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/portgroupservers

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

<PortGroupServers total="1">
  <PortGroupServer>
     <URI>/vmrest/portgroups/0a7f3c85-e1bd-405e-a0e2-
   9926fcdc5a37/portgroupservers/e3e412c3-16fc-4922-b863-c2e365c08350</URI>
     <ObjectId>e3e412c3-16fc-4922-b863-c2e365c08350</ObjectId>
     <MediaRemoteServiceEnum>102</MediaRemoteServiceEnum>
     <MediaPortGroupObjectId>0a7f3c85-e1bd-405e-a0e2-
   9926fcdc5a37</MediaPortGroupObjectId>
     <PortGroupURI>/vmrest/portgroups/0a7f3c85-e1bd-405e-a0e2-
   9926fcdc5a37</PortGroupURI>
     <HostOrIPAddress>10.76.214.56</HostOrIPAddress>
     <Port>5060</Port>
     <TlsPort>5061</TlsPort>
     <Precedence>0</Precedence>
     <HostOrIPAddressV6/>
  </PortGroupServer>
</PortGroupServers>
Response Code: 200

JSON Example:

Request URI:
GET https://<connection-server>/vmrest/portgroups/<PortGroupObjectId>/portgroupservers
Accept: application/json
Connection: keep-alive

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

{
  "@total": "1",
  "PortGroupServer":
  {
     "URI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-
     8a220a081990/portgroupservers/a05577f7-9769-4216-96d2-f9ea2f1721f7",
     "ObjectId": "a05577f7-9769-4216-96d2-f9ea2f1721f7",
     "MediaRemoteServiceEnum": "102",
     "MediaPortGroupObjectId": "74a008c0-bdc6-4e4b-a304-8a220a081990",
     "PortGroupURI": "/vmrest/portgroups/74a008c0-bdc6-4e4b-a304-8a220a081990",
     "HostOrIPAddress": "10.78.171.145",
     "Port": "5060",
     "TlsPort": "5061",
     "Precedence": "0",
     "HostOrIPAddressV6": ""
  }
}
Response Code: 200


Delete a Port Group Server

The following is an example of the Delete request that will delete the port group server specified by an object ID:

DELETE https://<connectionserver>/
vmrest/portgroups/<PortGroupObjectId>/portgroupservers/<PortGroupServerObjectId>
Response Code: 204

JSON Example:

DELETE https://<connectionserver>/
vmrest/portgroups/<PortGroupObjectId>/portgroupservers/<PortGroupServerObjectId
Accept: application/json
Connection: keep-alive
Response Code: 204

When a port group is deleted, all ports associated to the port group are also deleted.


Explanation of Data Fields

Parameter Operations Data Type Comments
ObjectId Read Only String Object Id of the port group server.
MediaRemoteServiceEnum Read only Enum Values can be:
  • 100 - Cisco Unified Communications Manager server.
  • 101 - Cisco Unified Communications Manager Trivial File Transfer Protocol service.
  • 102 - SIP proxy server.
  • 103 - CCMAXL
  • 104 - PIMG.
Precedence Read/Write Integer Specifies order of the servers. The range can be from 0 to 9999.
Port Read/Write Integer Specifies port to be used. The range can vary from 0 to 9999.
TlsPort Read/Write Integer Specifies the Tls port to be used. The range can vary from 0 to 9999.
HostOrIPAddress Read/Read String Specifies the IPV4 address or hostname of the CUCM/ SIP Proxy/ TFTP server.
HostOrIPAddressV6 Read/Write String Specifies the IPV6 address or hostname of the CUCM/ SIP Proxy/ TFTP server.
SkinnyStateMachineEnum Read/Write Enum Values can be:
  • 10 - Cisco Unified Communications Manager
  • 20 - Cisco CallManager Express

This field is valid only for SCCP Integration.

Rating: 0.0/5 (0 votes cast)

Personal tools