CUCM Cluster Management (Robotic Account)

CUCM Cluster Management(Robotic Account Management)

This section of API document provides all the operations that can be performed as part of CUCM Cluster management(Robotic account management) API in CER.

Add New CUCM Cluster

`/cluster`

http

CopyPOST https://{CER-IP}/cerappservices/service/cluster

This URL adds new CUCM Cluster in CER. The request should be made using HTTP POST method with a body in below mentioned format. On successful insertion, a 200 OK response will be sent along with the direct url for the user in response. In case of failures appropriate message will be present in the status field with relevant HTTP return code.

Request examples

XML request

xml

Copy<insertCCMClusterRequest>
    <CUCM>10.77.23.24</CUCM>
    <CTIManger>10.77.23.24</CTIManger>
    <CTIUser>CerVarun</CTIUser>
    <CTIPassword>cisco</CTIPassword>
    <BackupCTIMngr1>cercucm244.cisco.com</BackupCTIMngr1>
    <BackupCTIMngr2></BackupCTIMngr2>
    <TelePortAddr>+12</TelePortAddr>
    <NumbrOfTelePorts></NumbrOfTelePorts>
    <SecureConnection>
        <EnableSecureConn>false</EnableSecureConn>
        <TFTPIpAddr>10.77.34.224</TFTPIpAddr>
        <TFTPPort>69</TFTPPort>
        <BackupTFTPIp>10.77.34.225</BackupTFTPIp>
        <CAPFIpAddr>10.77.34.233</CAPFIpAddr>
        <CAPFPort>3804</CAPFPort>
        <InstanceIdPub>10.77.34.230</InstanceIdPub>
        <AuthStringPub>test</AuthStringPub>
        <InstanceIdSub>10.77.34.207</InstanceIdSub>
        <AuthStringSub>FDFDFD</AuthStringSub>
    </SecureConnection>
    <AXLSettings>
        <AXLUser>tyuuy</AXLUser>
        <AXLPassword>cisco</AXLPassword>
        <AXLPort>2500</AXLPort>
    </AXLSettings>
    <UseSnmpV3>true</UseSnmpV3>
</insertCCMClusterRequest>

JSON request

JSON

Copy{
    "CUCM": "10.77.23.24",
    "CTIManger": "10.77.23.24",
    "CTIUser": "CerVarun",
    "CTIPassword": "cisco",
    "BackupCTIMngr1": "cercucm244.cisco.com",
    "BackupCTIMngr2": "",
    "TelePortAddr": "+12",
    "NumbrOfTelePorts": "",
    "SecureConnection": {
        "EnableSecureConn": "false",
        "TFTPIpAddr": "10.77.34.224",
        "TFTPPort": "69",
        "BackupTFTPIp": "10.77.34.225",
        "CAPFIpAddr": "10.77.34.233",
        "CAPFPort": "3804",
        "InstanceIdPub": "10.77.34.230",
        "AuthStringPub": "test",
        "InstanceIdSub": "10.77.34.207",
        "AuthStringSub": "FDFDFD"
    },
    "AXLSettings": {
        "AXLUser": "tyuuy",
        "AXLPassword": "cisco",
        "AXLPort": "2500"
    },
    "UseSnmpV3": "true"
}

Fields	Description
CUCM	CUCM IP address or hostname
CTIManager	CTI Manager IP address
CTIUser	CTI Manager user name
CTIPassword	CTI Manager Pasword
BackupCTIManager1	Backup CTI Manager 1 IP address
BackupCTIManager2	Backup CTI Manager 2 IP address
TeleportAddress	Teleport address
NumberofTeleports	Number of Teleports
SecureConnection	Secure Connection attributes which includes TFTP IPaddresses and Port, CAPF IP addresses and Port.
AXLSetting	AXLSettings which consists of username, password and port
UseSnmpV3	Specify whether to use SNMPV3 or not

Response examples

XML response

xml

Copy<insertCCMClusterResponse>
    <status>Success</status>
    <message>CUCM cluster added successfully</message>
</insertCCMClusterResponse>

JSON response

JSON

Copy{
    "status": "Success",
    "message": "CUCM cluster added successfully"
}

Fields	Description
status	Overall status message for the response
message	Detailed message for the response

Delete CUCM Cluster

`/cluster`

http

CopyDELETE https://{CER-IP}/cerappservices/service/cluster

This URL deletes a CUCM Cluster in CER. The request should be made using HTTP DELETE method with a body in below mentioned format. On successful deletion, a 200 OK response will be sent along with appropriate status, message for the respective cluster in response. In case of failures appropriate message will be present in the status field with relevant HTTP return code.

Request example

XML request

xml

Copy<deleteCCMClusterRequest>
    <cucm>10.77.34.169</cucm>
</deleteCCMClusterRequest>

JSON request

JSON

Copy{
    "cucm": "10.77.34.169"
}

Fields	Description
cucm	IP address of CUCM node that needs to be deleted

Response examples

XML response

xml

Copy<deleteCCMClusterResponse>
   <status>SUCESS</status>
   <message>CCM_Deleted_Successfully</message>
</deleteCCMClusterResponse>

JSON response

JSON

Copy{
    "status": "SUCESS",
    "message": "CCM_Deleted_Successfully"
}

Fields	Description
status	Overall status message for the response
message	Message related to the delete operation on the CUCM Cluster

Update CUCM Cluster

`/cluster`

http

CopyPUT https://{CER-IP}/cerappservices/service/cluster

This URL updates an existing CUCM Cluster in CER. The request should be made using HTTP PUT method with a body in below mentioned format. On successful insertion, a 200 OK response will be sent in response. In case of failures appropriate message will be present in the status field with relevant HTTP return code.

Request examples

XML request

xml

Copy<updateCCMClusterRequest>
    <CUCM>10.77.34.167</CUCM>
    <CTIManger>10.77.34.167</CTIManger>
    <CTIUser>CerVarun</CTIUser>
    <CTIPassword>cisco</CTIPassword>
    <BackupCTIMngr1></BackupCTIMngr1>
    <BackupCTIMngr2></BackupCTIMngr2>
    <TelePortAddr></TelePortAddr>
    <NumbrOfTelePorts></NumbrOfTelePorts>
    <SecureConnection>
        <EnableSecureConn>false</EnableSecureConn>
        <TFTPIpAddr>10.77.34.224</TFTPIpAddr>
        <TFTPPort>6327</TFTPPort>
        <BackupTFTPIp>10.77.34.225</BackupTFTPIp>
        <CAPFIpAddr>10.77.34.233</CAPFIpAddr>
        <CAPFPort>380</CAPFPort>
        <InstanceIdPub>10.77.34.230</InstanceIdPub>
        <AuthStringPub>test</AuthStringPub>
        <InstanceIdSub>1</InstanceIdSub>
        <AuthStringSub>1</AuthStringSub>
    </SecureConnection>
    <AXLSettings>
        <AXLUser>dsdfdsf</AXLUser>
        <AXLPassword>dsfsdfsdf</AXLPassword>
        <AXLPort>7000</AXLPort>
    </AXLSettings>
    <UseSnmpV3>true</UseSnmpV3>
</updateCCMClusterRequest>

JSON request

JSON

Copy{
    "CUCM": "10.77.34.167",
    "CTIManger": "10.77.34.167",
    "CTIUser": "CerVarun",
    "CTIPassword": "cisco",
    "BackupCTIMngr1": "",
    "BackupCTIMngr2": "",
    "TelePortAddr": "",
    "NumbrOfTelePorts": "",
    "SecureConnection": {
        "EnableSecureConn": "false",
        "TFTPIpAddr": "10.77.34.224",
        "TFTPPort": "6327",
        "BackupTFTPIp": "10.77.34.225",
        "CAPFIpAddr": "10.77.34.233",
        "CAPFPort": "380",
        "InstanceIdPub": "10.77.34.230",
        "AuthStringPub": "test",
        "InstanceIdSub": "1",
        "AuthStringSub": "1"
    },
    "AXLSettings": {
        "AXLUser": "dsdfdsf",
        "AXLPassword": "dsfsdfsdf",
        "AXLPort": "7000"
    },
    "UseSnmpV3": "true"
}

Fields	Description
CUCM	CUCM IP address or hostname
CTIManager	CTI Manager IP address
CTIUser	CTI Manager user name
CTIPassword	CTI Manager Pasword
BackupCTIManager1	Backup CTI Manager 1 IP address
BackupCTIManager2	Backup CTI Manager 2 IP address
TeleportAddress	Teleport address
NumberofTeleports	Number of Teleports
SecureConnection	Secure Connection attributes which includes TFTP IPaddresses and Port, CAPF IP addresses and Port.
AXLSetting	AXLSettings which consists of username, password and port
UseSnmpV3	Specify whether to use SNMPV3 or not

Response examples

XML response

xml

Copy<updateCCMClusterResponse>
   <status>Success</status>
   <message>CUCM cluster updated successfully</message>
</updateCCMClusterResponse>

JSON response

JSON

Copy{
    "status": "Success",
    "message": "CUCM cluster updated successfully"
}

Fields	Description
status	Overall status message for the response
message	Detailed status message for the response