CDSM Restful APIsCHAPTER 2-1 Cisco VDS Internet Streamer 3.3 API Guide OL-31208-02 2 CDSM RESTful APIs This chapter describes the CDSM RESTful APIs for Device and Device Group, which

OL-31208-02

C H A P T E R 2
CDSM RESTful APIs
This chapter describes the CDSM RESTful APIs for Device and Device Group, which consist of the following:

• Device APIs

• Service APIs

• Other APIs

Device APIs The CDSM provides the following Device APIs:

• Device Groups

• Device Group Assignment

• Replication

• Service Control

• Application Control

• General SettingsTransaction Log

• Notification and Tracking

• Troubleshooting

• Transaction Log

• DNS Redirection

• Content Management

• Content Deletion

• Message Of The Day

Each API provides parity with the CDSM GUI.

Device GroupsThe Device Group List and Definition part of the Devices API provides parity for the following CDSM GUI pages:

2-1Cisco VDS Internet Streamer 3.3 API Guide

Chapter 2 CDSM RESTful APIs Device APIs

Table 2-1 Device Group List and Definition API Calls

Resource URL Method Function Description

POST or PUT Definition Response Example

Following is an example of a response to get Groups with the ID 3185.

<groups uri="/api/groups"> <group id="3185" uri="/api/groups/3185"> <name>dg1</name> <autoAssign>false</autoAssign> <description>Device Group 1</description> </group>

<group id="3186" name="dg2" uri="/api/groups/3186" /> <group id="3187" name="dg3" uri="/api/groups/3187" /></groups>

Device Group AssignmentThe General Settings part of the Device Group API provides parity for the following CDSM GUI page.

Table 2-2 Device Group Assignment API Call


POST Definition Request Example

Following is an example of a request to assign or unassign the definition of Group Assignment Policy.

<groups><assignIds>207</assignIds><removeIds>202</removeIds></groups>

/api/groups GET Gets the list of all device groups.

POST Creates a new device groups.

/api/groups/{id} GET Gets the definition settings of an device group identified by {id}.

PUT Modifies the definition settings of an device group identified by {id}.

DELETE Deletes an device group identified by {id}.

/api/groups/{id}/SEs GET Gets all service engines assigned to a device group.

POST Assigns or Unassigns service engines to a device group.


OL-31208-02

Chapter 2 CDSM RESTful APIsDevice APIs

ReplicationThe following URLs are relative to /api/SEs/{id} or /api/group/{id} when device group is supported. The {id} identifies an SE or a device group:

Table 2-3 Replication API Calls


PUT Bandwidth Response Example<!-Data Model for modification--><defaultRepBw> <AcquisitionIn>100000</AcquisitionIn> <DistributionIn>100000</DistributionIn> <DistributionOut>100000</DistributionOut></defaultRepBw> </urlSignatures-row>

PUT Multicast Distribution Response Example<!-Data Model for modification--><mcastDistribution> <System_mcast_receiver_enable>true</System_mcast_receiver_enable> <System_mcast_sender_enable>false</System_mcast_sender_enable></mcastDistribution>

PUT Distribution Setting Request Example<!-Data Model for modification--><distributionSetting><System_AdMul_NextNACKIntervalMultiplier>10</System_AdMul_NextNACKIntervalMultiplier></distributionSetting>

Service ControlThe following URLs are relative to /api/SEs/{id} or /api/group/{id} when device group is supported. The {id} identifies an SE or a device group:

/defaultRepBw GET Gets the Acquisition and Distribution bandwidth.

PUT Modifies the Acquisition and Distribution bandwidth.

DELETE Deletes the Acquisition and Distribution bandwidth.

/mcastDistribution GET Gets Multicast Distribution settings.

PUT Modifies Multicast Distribution settings.

DELETE Deletes Multicast Distribution settings.

/distributionSettings GET Gets Distribution settings.

PUT Modifies Distribution settings.

DELETE Deletes Distribution settings.


OL-31208-02


Table 2-4 Service Control API Calls


PUT Service Rule Response Example<!-Data Model for modification--><ruleEnable uri="groups/204/ruleEnable"> <System_servicerule_enable>true</System_servicerule_enable></ruleEnable>

PUT Authorization Service Response Example<!-Data Model for modification--><authService uri="groups/204/authService"> <System_authserv_enable>true</System_authserv_enable><System_authserv_locationserver_enable>true</System_authserv_locationserver_enable><System_authserv_locationserver_primary_host>1.1.1.1</System_authserv_locationserver_primary_host><System_authserv_locationserver_primary_port>4333</System_authserv_locationserver_primary_port> <System_authserv_locationserver_secondary_host></System_authserv_locationserver_secondary_host><System_authserv_locationserver_secondary_port></System_authserv_locationserver_secondary_port><System_authserv_unknowndomainproxy_enable>false</System_authserv_unknowndomainproxy_enable></authService>

Application ControlThe following URLs are relative to /api/SEs/{id} or /api/group/{id} when device group is supported.

/ruleEnable GET Gets Service rule settings.

PUT Modifies Service rule settings.

DELETE Removes Service rule settings and sets it to false.

/authService GET Gets Authorization Service settings.

PUT Modifies Authorization Service settings.

DELETE Removes Authorization Service settings.

Table 2-5 Application Control API Calls


/appBw GET Gets default and maximum bandwidth settings.

PUT Modifies default and maximum bandwidth settings.

DELETE Removes default and maximum bandwidth settings.

/msGenSetting GET Gets movie streamer settings.

PUT Modifies movie streamer settings.

DELETE Removes a movie streamer settings.


OL-31208-02


PUT Bandwidth Response Example<!-Data Model for modification--><appBw id="204" uri="/api/groups/204/appBw"> <dWmtIn>200000</dWmtIn> <dWmtOut>200000</dWmtOut> <dIptvIn>200000</dIptvIn> <dIptvOut>200000</dIptvOut> <mWmtIn>200000</mWmtIn> <mWmtOut>200000</mWmtOut> <mIptvIn>200000</mIptvIn> <mIptvOut>200000</mIptvOut></appBw>

PUT Movie Streamer Request Example<!-Data Model for modification--><msGenSetting uri="groups/204/msGenSetting"> <System_iptv_maxConnectionsEnable>false</System_iptv_maxConnectionsEnable> <System_iptv_maxConnections></System_iptv_maxConnections> <System_iptv_enforceMaxBitrate>false</System_iptv_enforceMaxBitrate> <System_iptv_maxBitrate></System_iptv_maxBitrate> <System_iptv_enforceIncomingMaxBitrate>false</System_iptv_enforceIncomingMaxBitrate> <System_iptv_maxIncomingBitrate></System_iptv_maxIncomingBitrate> <System_darwin_license_enable>false</System_darwin_license_enable> <System_iptv_proxyOutgoingRtspHost_hostname>0.0.0.0</System_iptv_proxyOutgoingRtspHost_hostname> <System_iptv_proxyOutgoingRtspHost_port>554</System_iptv_proxyOutgoingRtspHost_port> <System_iptv_vodEnable>true</System_iptv_vodEnable> <System_iptv_advancedClientIdleTimeout>300</System_iptv_advancedClientIdleTimeout> <System_iptv_advancedClientRtpTimeout>180</System_iptv_advancedClientRtpTimeout> <System_iptv_cacheEnable>true</System_iptv_cacheEnable>

/rtspGateway GET Gets the gateway settings.

PUT Modifies the gateway settings.

DELETE Removes the gateway settings.

/fmsAllowHosts GET Gets FMS admin to allow hosts.

PUT Modifies FMS admin to allow hosts.

DELETE Removes FMS admin to allow hosts.

/fmsGenSetting GET Gets FMS general settings.

PUT Modifies FMS general settings.

DELETE Removes FMS general settings.

/fmsServMonitor GET Get Service monitor settings.

PUT Modifies monitor settings.

DELETE Removes monitor settings.

/httpCacheFreshness GET Gets HTTP cache freshness settings.

PUT Modifies HTTP cache freshness settings.

DELETE Removes HTTP cache freshness settings.

Table 2-5 Application Control API Calls



OL-31208-02


<System_iptv_cacheAgeMultiplier>30</System_iptv_cacheAgeMultiplier> <System_iptv_cacheMaxTtl_time>1</System_iptv_cacheMaxTtl_time> <System_iptv_cacheMaxTtl_scale>days</System_iptv_cacheMaxTtl_scale> <System_iptv_cacheReEvalRequest>true</System_iptv_cacheReEvalRequest></msGenSetting>

PUT Gateway Response Example<!-Data Model for modification--><rtspGateway uri="groups/204/rtspGateway"> <System_rtspproxy_maxRequestsPerSecond>40</System_rtspproxy_maxRequestsPerSecond> <System_rtspproxy_maxInitialSetupDelay>10</System_rtspproxy_maxInitialSetupDelay></rtspGateway>

PUT FMS Allow Hosts Response Example<!-Data Model for modification--><fmsAllowHosts uri="groups/204/fmsAllowHosts"> <System_fmsAdminIp_enable>false</System_fmsAdminIp_enable> <System_fmsAdminIp_ipList></System_fmsAdminIp_ipList></fmsAllowHosts>

PUT FMS General Response Example<!-Data Model for modification--><fmsGenSetting uri="groups/204/fmsGenSetting"> <System_fms_serviceEnable>false</System_fms_serviceEnable> <System_fms_maxSessions>200</System_fms_maxSessions> <System_fms_maxBandwidth>200000</System_fms_maxBandwidth></fmsGenSetting>

PUT Service Monitor Response Example<!-Data Model for modification--><fmsServMonitor uri="groups/204/fmsServMonitor"> <System_fms_monitoring_enable>true</System_fms_monitoring_enable></fmsServMonitor>

PUT HTTP Cache Freshness Settings Response Example<!-Data Model for modification--><httpCacheFreshness uri="groups/204/httpCacheFreshness"> <System_http_freshnessEnable>false</System_http_freshnessEnable> <System_http_ageMultiplier>30</System_http_ageMultiplier> <System_http_maxTtl_scale>days</System_http_maxTtl_scale> <System_http_maxTtl_object>61</System_http_maxTtl_object> <System_http_minTtl>60</System_http_minTtl></httpCacheFreshness>


OL-31208-02


General SettingsThe General settings List and Definition part of the Device feature API provides parity for the following CDSM GUI pages:

• Application Control> Windows Media Streaming> General Settings

Table 2-6 General Settings and Definition API Calls


GET List of General Settings Response Example

Following is an example of a response to get the list of General settings.

<wmtGenSetting uri="/api/devices/193/wmtGenSetting"> <serviceEnable>true</serviceEnable>

<proxyOutgoingHttpEnable>true</proxyOutgoingHttpEnable> <proxyOutgoingHttpHost_hostname>192.168.0.1</proxyOutgoingHttpHost_hostname> <proxyOutgoingHttpHost_port>80</proxyOutgoingHttpHost_port>

<proxyOutgoingRtspEnable>true</proxyOutgoingRtspEnable> <proxyOutgoingRtspHost_hostname>192.168.0.2</proxyOutgoingRtspHost_hostname> <proxyOutgoingRtspHost_port>554</proxyOutgoingRtspHost_port>



</wmtGenSetting>

The General Setting of the Device and has the following API calls:

• Login Access Control

• Authentication

• Storage

• Network

The following URLs are relative to /api/SEs/{id} or /api/group/{id} when device group is supported.

/api/groups/{id}/wmtGenSetting GET Gets the general settings of a SE or a device group.

PUT Modifies the general settings of a SE or a device group.

DELETE Deletes the general settings of a SE or a device group.

/api/groups/{id}/wmtGenSetting/applyDefault

POST Applies default settings.

/api/groups/{id}/wmtGenSetting/forceSEs

POST Forces a device groups setting to all its SEs.

Table 2-7 General Settings API Calls


/contentMgmt GET Gets content management settings.

PUT Modifies content management settings.

DELETE Removes content management settings.


OL-31208-02


PUT Content Management Response Example<!-Data Model for modification--><contentMgmt uri="groups/204/contentMgmt"> <System_contentMgmt_cacheMaxEntries>20000000</System_contentMgmt_cacheMaxEntries> <System_contentMgmt_evictionprotection_size>min-size-100MB</System_contentMgmt_evictionprotection_size> <System_contentMgmt_evictionprotection_duration>min-duration-1hr</System_contentMgmt_evictionprotection_duration> <System_contentMgmt_smallFileEvictionProtection_size>max-size-500KB</System_contentMgmt_smallFileEvictionProtection_size> <System_contentMgmt_smallFileEvictionProtection_duration>min-duration-5min</System_contentMgmt_smallFileEvictionProtection_duration> <System_contentMgmt_evictionsize>large</System_contentMgmt_evictionsize> <System_contentMgmt_hitcntDecayHalfLife>14</System_contentMgmt_hitcntDecayHalfLife> <System_contentMgmt_diskbktFailThreshold>30</System_contentMgmt_diskbktFailThreshold></contentMgmt>

GET Database Management Response Example<!-Data Model when you use GET--><dbMaintenance uri="groups/204/dbMaintenance"> <System_dbMaintenance_fullEnable>true</System_dbMaintenance_fullEnable><!-Sum of the days values is givenSUN = 1, Mon = 2, Tue = 4, Wed = 8, Thu = 16, Fri = 32, Sat = 64, ALL DAYS = 127 -->

<System_dbMaintenance_fullSchedule_days>9</System_dbMaintenance_fullSchedule_days> <!-Time is given in minutes--> <System_dbMaintenance_fullSchedule_minute>240</System_dbMaintenance_fullSchedule_minute> <System_dbMaintenance_regularEnable>true</System_dbMaintenance_regularEnable> <!-Sum of the days values is givenSUN = 1, Mon = 2, Tue = 4, Wed = 8, Thu = 16, Fri = 32, Sat = 64, ALL DAYS = 127 --><System_dbMaintenance_regularSchedule_days>126</System_dbMaintenance_regularSchedule_days> <!-Time is given in minutes--> <System_dbMaintenance_regularSchedule_minute>0</System_dbMaintenance_regularSchedule_minute></dbMaintenance>

PUT Database Management Response Example<!-Data Model for modification--><dbMaintenance uri="groups/204/dbMaintenance"> <System_dbMaintenance_fullEnable>true</System_dbMaintenance_fullEnable>

/dbMaintenance GET Gets database maintenance settings.

PUT Gets database maintenance settings.

DELETE Gets database maintenance settings.

/srSettings GET Gets Service Router settings.

PUT Modifies Service Router settings.

DELETE Removes Service Router settings.

Table 2-7 General Settings API Calls (continued)



OL-31208-02


<FullDbMaintenanceEveryDay>1</FullDbMaintenanceEveryDay> <FullDbMaintenanceMon>1</FullDbMaintenanceMon> <FullDbMaintenanceTue>1</FullDbMaintenanceTue> <FullDbMaintenanceWed>1</FullDbMaintenanceWed> <FullDbMaintenanceThu>1</FullDbMaintenanceThu> <FullDbMaintenanceFri>1</FullDbMaintenanceFri> <FullDbMaintenanceSat>1</FullDbMaintenanceSat> <FullDbMaintenanceSun>1</FullDbMaintenanceSun> <FullHourKey>4</FullHourKey><System_dbMaintenance_fullSchedule_minute>30</System_dbMaintenance_fullSchedule_minute>

<System_dbMaintenance_regularEnable>true</System_dbMaintenance_regularEnable><RegularDbMaintenanceEveryDay>1</RegularDbMaintenanceEveryDay><RegularDbMaintenanceMon>1</RegularDbMaintenanceMon><RegularDbMaintenanceTue>1</RegularDbMaintenanceTue><RegularDbMaintenanceWed>1</RegularDbMaintenanceWed><RegularDbMaintenanceThu>1</RegularDbMaintenanceThu><RegularDbMaintenanceFri>1</RegularDbMaintenanceFri><RegularDbMaintenanceSat>1</RegularDbMaintenanceSat><RegularDbMaintenanceSun>1</RegularDbMaintenanceSun><RegularHourKey>2</RegularHourKey><System_dbMaintenance_regularSchedule_minute>0</System_dbMaintenance_regularSchedule_minute></dbMaintenance>

Note Remove the day parameter from the xml script to unselect a day. For example, to unselect Monday, remove the parameter "<FullDbMaintenanceMon>1</FullDbMaintenanceMon>" from the xml script.

PUT Service Router Request Example<!-Data Model for modification--><srSetting uri="groups/204/srSetting"> <System_keepAlive_interval>2</System_keepAlive_interval> <System_keepAlive_snapshotCounterReportInterval>10</System_keepAlive_snapshotCounterReportInterval></srSetting>

Login Access Control


Table 2-8 Login Access Control API Calls


/loginAuth GET Gets login Authentication Settings.

PUT Modifies login Authentication Settings.

DELETE Deletes login Authentication Settings.


OL-31208-02


PUT Login Authentication Response Example<!-Data Model for modification--><loginAuth id="204" uri="/api/groups/204/loginAuth"> <LoginEnable>false</LoginEnable> <LoginConfigFailoverServerUnreach>false</LoginConfigFailoverServerUnreach> <EnablePassword></EnablePassword><!-Value for serversLocal = 1, Radius - 2, Tacacs = 3, Do Not Set = 0--> <LoginPrimary>1</LoginPrimary> <LoginSecondary>0</LoginSecondary> <LoginTertiary>0</LoginTertiary> <EnablePrimary>0</EnablePrimary> <EnableSecondary>0</EnableSecondary> <EnableTertiary>0</EnableTertiary></loginAuth>

PUT Admin Password Response Example<!-Data Model for modification for adminPwd--><adminPwd uri="groups/204/adminPwd"> <System_adminPassword_password>new1)</System_adminPassword_password> <confirmPassowrd>new1)</confirmPassowrd></adminPwd>

Authentication


Table 2-9 Authentication API Calls

Resource URL Method Usable

Storage


/execAuth GET,PUT,DELETE

/ssh GET,PUT,DELETE

/telnet GET,PUT,DELETE

/motd GET,PUT,DELETE

/cliSessionTime GET,PUT,DELETE

/adminPwd GET,PUT,DELETE

Table 2-8 Login Access Control API Calls (continued)


/radius GET,PUT,DELETE

/tacacs GET,PUT,DELETE

/aaaAccounting GET,PUT,DELETE

/enableAcl GET,PUT,DELETE

/acl GET,PUT,DELETE


OL-31208-02


Table 2-10 Storage API Calls


Network




PUT Standard Timezone Example<!-Data Model for modification of Standard TimeZone--><timeZone-row id="572" uri="/api/groups/204/timeZone/572"> <!-For subtimezone the value must be like "Europe/Amsterdam" --> <timeZoneName>MST</timeZoneName><!-For isCustomTz value must be "standard" or "custom" --> <isCustomTz>standard</isCustomTz></timeZone-row>

PUT Custom Timezone Example<!-Data Model for modification of Custom TimeZone--><timeZone-row id="572" uri="/api/groups/204/timeZone/572"> <timeZoneName>newTimeZone</timeZoneName> <timeZoneUtcOffset>-150</timeZoneUtcOffset><!-Value is given in hours --><!-Summer Time Type No Value for no summer time 2 = Absolute Dates 3 = Recurring Dates--> <summerTimeType>2</summerTimeType> <summerTimeOffset>12</summerTimeOffset><!-Date format is MM/DD/YYYY -- > <summerTimeStartTime>10/16/2013</summerTimeStartTime> <summerTimeEndTime>11/16/2013</summerTimeEndTime><!-Day value will be 1=MON,2=TUE etc. till 7=SUN -- > <recStartDay></recStartDay> <!-Week value will be 1=1st Week,2=2nd Week etc. till 4=last Week -- > <recStartWeek></recStartWeek>

/diskError GET,PUT,DELETE

/ftp GET,PUT,DELETE

/dns GET,PUT,DELETE

/rcp GET,PUT,DELETE

/ntp GET,PUT,DELETE

/tcp GET,PUT,DELETE

/portChannelSetting GET,PUT,DELETE

/ipGenSetting GET,PUT,DELETE

/dsrVIP GET,PUT,DELETE

/timeZone GET,POST

/timeZone/{id} PUT,DELETE


OL-31208-02


<!-Month value must be specified in number-- > <recStartMonth></recStartMonth> <recStartMin></recStartMin> <recEndDay></recEndDay> <recEndWeek></recEndWeek> <recEndMonth></recEndMonth> <recEndMin></recEndMin><!-For isCustomTz value must be "standard" or "custom" --> <isCustomTz>custom</isCustomTz></timeZone-row>

POST Standard Timezone Example<timeZone-row id=""572"" uri=""/api/groups/204/timeZone/572""> <timeZoneName>MST</timeZoneName> <isCustomTz>standard</isCustomTz></timeZone-row>

POST Custom Timezone Example<timeZone-row id="572" uri="/api/groups/204/timeZone/572"><timeZoneName>newTimeZone</timeZoneName><timeZoneUtcOffset>-150</timeZoneUtcOffset><summerTimeType>2</summerTimeType><summerTimeOffset>12</summerTimeOffset><summerTimeStartTime>10/16/2013</summerTimeStartTime><summerTimeEndTime>11/16/2013</summerTimeEndTime><recStartDay>1</recStartDay><recStartWeek>1</recStartWeek><recStartMonth>1</recStartMonth><recStartMin>1</recStartMin><recEndDay>2</recEndDay><recEndWeek>2</recEndWeek><recEndMonth>2</recEndMonth><recEndMin>2</recEndMin><isCustomTz>custom</isCustomTz></timeZone-row>

Notification and TrackingThe following URLs are relative to /api/SEs/{id} or /api/group/{id} when device group is supported.



/alarmSetting GET,PUT,DELETE

/serviceMon GET,PUT,DELETE

/snmpAsset GET,PUT,DELETE

/snmpContact GET,PUT,DELETE

/syslog GET,PUT,DELETE

/snmpGenSetting GET,PUT,DELETE

/snmpGenSetting/{id} GET,PUT,DELETE


OL-31208-02


PUT SNMP General Response Example<!-Data Model for modification for SNMP General Settings--><snmpGenSetting-row id="213" uri="/api/groups/204/snmpGenSetting/213"> <contact></contact> <location></location> <ceTrapFlag>0</ceTrapFlag> <entity></entity> <event></event> <config></config> <authentication>1</authentication> <coldStart></coldStart> <alarmTrapFlag></alarmTrapFlag> <enableTraps></enableTraps> <mibPersistentEvent></mibPersistentEvent> <notifyInform></notifyInform> <writeMib></writeMib> </snmpGenSetting-row>

The following URLs are relative to /api/snmp/{id} after the snmpGenSettings are configured. The {id} identifies a SNMP General Settings record id:

Table 2-13 SNMP General Settings API Calls


GET or PUT SNMP Community Response Example<!-Data Model for creation/modification --><snmpCommunity-row id="537" uri="/api/snmp/213/snmpCommunity/537"> <community>(New1</community> <type>Group</type> <groupName>publicly</groupName></snmpCommunity-row>

GET or PUT SNMP Group Response Example<!-Data Model for creation/modification --><snmpGroup-row id="491" uri="/api/snmp/213/snmpGroup/491"> <name>NewGroup</name> <secModel>v2c</secModel> <readView></readView> <writeView></writeView> <notifyView></notifyView></snmpGroup-row>

/snmpCommunity GET(Get all),POST

/snmpCommunity/{id} GET,PUT,DELETE

/snmpGroup GET(Get all),POST

/snmpGroup/{id} GET,PUT,DELETE

/snmpUser GET(Get all),POST

/snmpUser/{id} GET,PUT,DELETE

/snmpView GET(Get all),POST

/snmpView/{id} GET,PUT,DELETE

/snmpHost GET(Get all),POST

/snmpHost/{id} GET,PUT,DELETE


OL-31208-02


GET or PUT SNMP User Response Example<!-Data Model for creation/modification --><snmpUser-row id="579" uri="/api/snmp/213/snmpUser/579"> <name>NewUser</name><!-Belwo parameter key is case sensitive "Group" --> <Group>NewGroup</Group> <authAlgorithm>md5</authAlgorithm> <authPassword>(New3</authPassword> <privPassword>(New1</privPassword></snmpUser-row>

GET or PUT SNMP View Response Example<!-Data Model for creation/modification --><snmpView-row id="545" uri="/api/snmp/213/snmpView/545"> <name>NewView</name> <family>sysContact</family> <viewType>included</viewType></snmpView-row>

GET or PUT SNMP Host Response Example<!-Data Model for creation/modification --><snmpHost-row id="546" uri="/api/snmp/213/snmpHost/546"> <host>2.2.2.1</host> <communityUser>NewUser</communityUser> <authentication>no-auth</authentication> <retry>2</retry> <timeout>15</timeout></snmpHost-row>

TroubleshootingThe following URLs are relative to /api/SEs/{id} or /api/group/{id} when device group is supported:

Table 2-14 Troubleshooting API Calls


/kernelDebugger GET,PUT,DELETE


OL-31208-02


Transaction Log

Table 2-15 Transaction Log API Calls


GET Transaction Log Response Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?><transacLog uri="SEs/217/transacLog"> <System_transacLog_enable>false</System_transacLog_enable> <System_transacLog_dsSnapCounter>false</System_transacLog_dsSnapCounter> <System_transacLog_logWindowsDomain>false</System_transacLog_logWindowsDomain> <System_transacLog_compressEnable>false</System_transacLog_compressEnable> <System_transacLog_archiveFileSize>500000</System_transacLog_archiveFileSize> <System_transacLog_maxArchiveFileNumber>10</System_transacLog_maxArchiveFileNumber> <System_transacLog_format>apache</System_transacLog_format> <System_transacLog_archiveStr>every-day every 1</System_transacLog_archiveStr> <System_transacLog_hostEnable>false</System_transacLog_hostEnable> <System_transacLog_host_port>514</System_transacLog_host_port> <System_transacLog_host_ratelimit>0</System_transacLog_host_ratelimit> <System_transacLog_splunkUF_exportEnable>false</System_transacLog_splunkUF_exportEnable> <System_transacLog_exportEnable>true</System_transacLog_exportEnable> <System_transacLog_exportStr>every-day every 3</System_transacLog_exportStr> <System_transacLog_wmtEnable>true</System_transacLog_wmtEnable> <System_transacLog_wmtFormat>wms-41</System_transacLog_wmtFormat> <System_transacLog_weABRSession>disable</System_transacLog_weABRSession><System_transacLog_export_skipLogTypes_serviceMonitor>true</System_transacLog_export_skipLogTypes_serviceMonitor><System_transacLog_export_skipLogTypes_snapshotCounter>true</System_transacLog_export_skipLogTypes_snapshotCounter><System_transacLog_export_skipLogTypes_ad>true</System_transacLog_export_skipLogTypes_ad><System_transacLog_export_skipLogTypes_authSvr>true</System_transacLog_export_skipLogTypes_authSvr> <System_transacLog_export_skipLogTypes_contentMgr>false</System_transacLog_export_skipLogTypes_contentMgr><System_transacLog_export_skipLogTypes_fmsAccess>true</System_transacLog_export_skipLogTypes_fmsAccess>

/api/SEs|SRs|groups/{id}/transcLog GET Gets the transaction log settings for SEs, SRs or Device groups identified by {id}.

PUT Modifies the transaction log settings for SEs, SRs or Device groups identified by {id}.

POST Creates the transaction log settings for SEs, SRs or Device groups identified by {id}.

DELETE Removes the transaction log settings for SEs, SRs or Device groups identified by {id}.

/api/SEs|SRs|groups/{id}/transcLog/applyDefault

POST Applies default values to the transaction log settings for SEs, SRs or Device groups identified by {id}.

/api/SEs|SRs|groups/{id}/transcLog/applyDG/{dgId}

POST Applies device groups transaction log settings(identified by {dgId})on the transaction log settings of the SE identified by {id}.

/api/SEs|SRs|groups/{id}/transcLog/forceSEs

POST Force transaction settings on SEs in the group Identified by {id}


OL-31208-02


<System_transacLog_export_skipLogTypes_fmsAuth>true</System_transacLog_export_skipLogTypes_fmsAuth><System_transacLog_export_skipLogTypes_movieStreamer>true</System_transacLog_export_skipLogTypes_movieStreamer><System_transacLog_export_skipLogTypes_weABR>true</System_transacLog_export_skipLogTypes_weABR><System_transacLog_export_skipLogTypes_weApache>true</System_transacLog_export_skipLogTypes_weApache><System_transacLog_export_skipLogTypes_weCLF>true</System_transacLog_export_skipLogTypes_weCLF><System_transacLog_export_skipLogTypes_weIngest>true</System_transacLog_export_skipLogTypes_weIngest><System_transacLog_export_skipLogTypes_weKCM>true</System_transacLog_export_skipLogTypes_weKCM><System_transacLog_export_skipLogTypes_weSquid>true</System_transacLog_export_skipLogTypes_weSquid><System_transacLog_export_skipLogTypes_weUrlStats>false</System_transacLog_export_skipLogTypes_weUrlStats><System_transacLog_export_skipLogTypes_wms41>true</System_transacLog_export_skipLogTypes_wms41><System_transacLog_export_skipLogTypes_wms41Ext>true</System_transacLog_export_skipLogTypes_wms41Ext><System_transacLog_export_skipLogTypes_wms90>true</System_transacLog_export_skipLogTypes_wms90><System_transacLog_export_skipLogTypes_wms90Ext>true</System_transacLog_export_skipLogTypes_wms90Ext><System_transacLog_export_skipLogTypes_wmtIngest>true</System_transacLog_export_skipLogTypes_wmtIngest></transacLog>

PUT or POST Transaction Log Response Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?><transacLog uri="SEs/217/transacLog"> <System_transacLog_enable>false</System_transacLog_enable> <System_transacLog_dsSnapCounter>false</System_transacLog_dsSnapCounter> <System_transacLog_logWindowsDomain>false</System_transacLog_logWindowsDomain> <System_transacLog_compressEnable>false</System_transacLog_compressEnable> <System_transacLog_archiveFileSize>500000</System_transacLog_archiveFileSize> <System_transacLog_maxArchiveFileNumber>10</System_transacLog_maxArchiveFileNumber> <System_transacLog_format>apache</System_transacLog_format> <System_transacLog_archiveStr>every-day every 1</System_transacLog_archiveStr> <System_transacLog_hostEnable>false</System_transacLog_hostEnable> <System_transacLog_host_port>514</System_transacLog_host_port> <System_transacLog_host_ratelimit>0</System_transacLog_host_ratelimit> <System_transacLog_splunkUF_exportEnable>false</System_transacLog_splunkUF_exportEnable> <System_transacLog_exportEnable>true</System_transacLog_exportEnable> <System_transacLog_exportStr>every-day every 3</System_transacLog_exportStr> <System_transacLog_wmtEnable>true</System_transacLog_wmtEnable> <System_transacLog_wmtFormat>wms-41</System_transacLog_wmtFormat> <System_transacLog_weABRSession>disable</System_transacLog_weABRSession><System_transacLog_export_ftp1_server>1.1.1.1</System_transacLog_export_ftp1_server><System_transacLog_export_ftp1_name>aaa</System_transacLog_export_ftp1_name><System_transacLog_export_ftp1_password>aaa</System_transacLog_export_ftp1_password><System_transacLog_export_ftp1_dirpath>aaa</System_transacLog_export_ftp1_dirpath><System_transacLog_export_ftp1_option>ftp-server</System_transacLog_export_ftp1_option><System_transacLog_export_ipv6_ftp1_server>fec0::1</System_transacLog_export_ipv6_ftp1_server><System_transacLog_export_ipv6_ftp1_name>bbb</System_transacLog_export_ipv6_ftp1_name><System_transacLog_export_ipv6_ftp1_password>bbb</System_transacLog_export_ipv6_ftp1_password><System_transacLog_export_ipv6_ftp1_dirpath>bbb</System_transacLog_export_ipv6_ftp1_dirpath>


OL-31208-02


<System_transacLog_export_ipv6_ftp1_option>ftp-server</System_transacLog_export_ipv6_ftp1_option><System_transacLog_export_skipLogTypes_serviceMonitor>true</System_transacLog_export_skipLogTypes_serviceMonitor><System_transacLog_export_skipLogTypes_snapshotCounter>true</System_transacLog_export_skipLogTypes_snapshotCounter><System_transacLog_export_skipLogTypes_ad>true</System_transacLog_export_skipLogTypes_ad><System_transacLog_export_skipLogTypes_authSvr>true</System_transacLog_export_skipLogTypes_authSvr><System_transacLog_export_skipLogTypes_contentMgr>false</System_transacLog_export_skipLogTypes_contentMgr><System_transacLog_export_skipLogTypes_fmsAccess>true</System_transacLog_export_skipLogTypes_fmsAccess><System_transacLog_export_skipLogTypes_fmsAuth>true</System_transacLog_export_skipLogTypes_fmsAuth><System_transacLog_export_skipLogTypes_movieStreamer>true</System_transacLog_export_skipLogTypes_movieStreamer><System_transacLog_export_skipLogTypes_weABR>true</System_transacLog_export_skipLogTypes_weABR><System_transacLog_export_skipLogTypes_weApache>true</System_transacLog_export_skipLogTypes_weApache><System_transacLog_export_skipLogTypes_weCLF>true</System_transacLog_export_skipLogTypes_weCLF><System_transacLog_export_skipLogTypes_weIngest>true</System_transacLog_export_skipLogTypes_weIngest><System_transacLog_export_skipLogTypes_weKCM>true</System_transacLog_export_skipLogTypes_weKCM><System_transacLog_export_skipLogTypes_weSquid>true</System_transacLog_export_skipLogTypes_weSquid><System_transacLog_export_skipLogTypes_weUrlStats>false</System_transacLog_export_skipLogTypes_weUrlStats><System_transacLog_export_skipLogTypes_wms41>true</System_transacLog_export_skipLogTypes_wms41><System_transacLog_export_skipLogTypes_wms41Ext>true</System_transacLog_export_skipLogTypes_wms41Ext><System_transacLog_export_skipLogTypes_wms90>true</System_transacLog_export_skipLogTypes_wms90><System_transacLog_export_skipLogTypes_wms90Ext>true</System_transacLog_export_skipLogTypes_wms90Ext><System_transacLog_export_skipLogTypes_wmtIngest>true</System_transacLog_export_skipLogTypes_wmtIngest></transacLog>

DNS RedirectionThe CDSM provides REST APIs for the following settings:


OL-31208-02


Table 2-16 DNS Redirection API Calls


GET DNS Redirection Response Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?><dnsRedirection uri="devices/199/dnsRedirection"> <System_dnsRedirect_basedOnWE_enable>false</System_dnsRedirect_basedOnWE_enable> <System_dnsRedirect_domain_all_enable>false</System_dnsRedirect_domain_all_enable> <domain_list> <domain>aaa.com</domain> <domain>bbb.com</domain> <domain>ccc.com</domain> </domain_list> </dnsRedirection>

PUT or POST DNS Redirection Response Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?><dnsRedirection uri="devices/199/dnsRedirection"> <System_dnsRedirect_basedOnWE_enable>false</System_dnsRedirect_basedOnWE_enable> <System_dnsRedirect_domain_all_enable>false</System_dnsRedirect_domain_all_enable> <domain_list> <domain>aaa.com</domain> <domain>bbb.com</domain> <domain>ccc.com</domain> </domain_list></dnsRedirection>

/api/devices/{id}/dnsRedirection GET Gets the list of all domains of DNS Based Redirection settings for the SR.

PUT Modifies existing list of all domains of DNS Based Redirection settings for the SR.

POST Creates new list of all domains of DNS Based Redirection settings for the SR.

DELETE Removes existing setting for DNS Based Redirection settings for the SR


OL-31208-02


Content Management

Table 2-17 Content Management API Calls


The CDSM provides REST APIs for the following settings:

GET Content Management Response Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?><dnsRedirection uri="devices/199/dnsRedirection"> <System_dnsRedirect_basedOnWE_enable>false</System_dnsRedirect_basedOnWE_enable> <System_dnsRedirect_domain_all_enable>false</System_dnsRedirect_domain_all_enable> <domain_list> <domain>aaa.com</domain> <domain>bbb.com</domain> <domain>ccc.com</domain> </domain_list> </dnsRedirection>

PUT or POST Content Management Response Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?><contentMgmt uri="SEs/217/contentMgmt"><System_contentMgmt_cacheMaxEntries>20000000</System_contentMgmt_cacheMaxEntries><System_contentMgmt_evictionsize>1</System_contentMgmt_evictionsize><System_contentMgmt_evictionprotection>false</System_contentMgmt_evictionprotection><System_contentMgmt_evictionprotection_size>0</System_contentMgmt_evictionprotection_size><System_contentMgmt_evictionprotection_duration>0</System_contentMgmt_evictionprotection_duration><System_contentMgmt_hitcntDecayHalfLife>14</System_contentMgmt_hitcntDecayHalfLife><System_contentMgmt_diskbktFailThreshold>30</System_contentMgmt_diskbktFailThreshold><System_contentMgmt_slowscan_starttime_primary>00:00</System_contentMgmt_slowscan_starttime_primary><System_contentMgmt_slowscan_starttime_secondary></System_contentMgmt_slowscan_starttime_secondary></contentMgmt>

/api/SEs|groups/{id}/contentMgmt GET Gets the Content Management settings for the SE or Device Group identified with {id}.

PUT Modifies the Content Management settings for the SE or Device Group identified with {id}.

POST Creates the Content Management settings for the SE or Device Group identified with {id}.

DELETE Removes the Content Management settings for the SE or Device Group identified with {id}.

/api/SEs|groups/{id}/contentMgmt/applyDefault

POST Applies default values to the Content Management settings for the SE or Device Group identified with {id}.

/api/SEs|groups/{id}/contentMgmt/applyDG/{dgId}

POST Applies Device Group's Content Management settings (identified with {dgId}) on the Content Management settings of the SE identified with {id}.

/api/SEs|groups/{id}/contentMgmt/forceSEs

POST Forces Content Management setting on SEs in the group identified with {id}.


OL-31208-02


Content Deletion

Table 2-18 Content Deletion API Calls



GET Content Deletion Response Example

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><DeletionTasks> <DeletionTask id="6024" type="API" ctime="2013.12.06 04:06:28" status="2" /> <DeletionTask id="6018" type="GUI" ctime="2013.12.03 10:22:00" status="2" comments="Deletion Task Comments" /> <DeletionTask id="5991" type="GUI" ctime="2013.12.03 09:27:24" status="2" /> <DeletionTask id="5976" type="API" ctime="2013.12.02 10:15:32" status="5" comments="xxx comment here" /></DeletionTasks>

POST Content Deletion Response Example

<?xml version="1.0" encoding="UTF-8"?><DeletionRequest sync='true' comments='my comments' rate='20'> <Content url="http://10.11.11.1/1000.*" > <ServiceEngine id="543"/> </Content> <Content url="http://10.11.11.1/abc.*" > </Content></DeletionRequest>

GET Content Deletion Response Example

Following is as example of a response with the ID 4018.

<?xml version="1.0" encoding="UTF-8" standalone="yes" ?><DeletionTask id="4018" type="GUI" sync="false" rate="200" ctime="2013.11.01 01:50:53" status="2" comments="sffasdf"> <ContentDeletions> <ContentDeletion url="rtsp://128.0.0.1/a/*"> <URLDeletion seid="3866" status="17" count="10" /> </ContentDeletion> </ContentDeletions> <SEDeletions> <SEDeletion seid="3866" sename="49-84" seip="10.79.49.84" status="2" message="" /> </SEDeletions></DeletionTask>

/api/contentDeletion/Tasks GET Gets list of all deletion tasks.

POST Creates a content deletion task in the system.

DELETE Deletes all completed tasks.

/api/contentDeletion/task/:id GET Gets the details of a specific deletion task.

DELETE Deletes the specific deletion task.

/api/contentDeletion/task/:id/cancel POST Cancels the specific deletion task.


OL-31208-02

Chapter 2 CDSM RESTful APIsService APIs

Message Of The Day

Table 2-19 MOTD API Calls



GET MOTD Response Example<?xml version="1.0" encoding="UTF-8" standalone="yes"?><MOTD uri="SEs/217/MOTD"> <System_motd_enable>false</System_motd_enable> <System_motd_motdMessage></System_motd_motdMessage> <System_motd_loginMessage>Hello, Welcome to login device.</System_motd_loginMessage> <System_motd_execMessage></System_motd_execMessage> <System_motd_login_banner_enable>true</System_motd_login_banner_enable></MOTD>

Service APIs

Delivery ServiceThe CDSM provides REST APIs for the following settings:

/api/CDMs|SEs|SRs|device|groups/{id}/MOTD

GET Gets the Message of the day settings for the Devices or Device Group identified with {id}.

PUT Modifies the Message of the day settings for the Devices or Device Group identified with {id}.

POST Creates the Message of the day settings for the Devices or Device Group identified with {id}.

DELETE Removes the Message of the day settings for the Devices or Device Group identified with {id}.

/api/CDMs|SEs|SRs|device|groups/{id}/MOTD/applyDefault

POST Applies default values to the Message of the day settings for Devices or Device Group identified with {id}.

/api/SEs/{id}/MOTD/applyDG/{dgId}

POST Applies Device Group's Message of the day settings (identified with {dgId}) on the Message of the day settings of the SE identified with {id}.

/api/groups/{id}/MOTD/forceSEs POST Forces Message of the day setting on SEs in the group identified with {id}.


OL-31208-02

Chapter 2 CDSM RESTful APIs Other APIs

Table 2-20 Delivery Service


GET Delivery Service Example

<DsvcSeSettingsList> <DsvcSeSettings seid="4026" id="9094" dsid="8830"> <EnableAbrLive>false</EnableAbrLive> </DsvcSeSettings> <DsvcSeSettings seid="5984" id="9093" dsid="8830"> <EnableAbrLive>true</EnableAbrLive> <TmpfsDuration>4</TmpfsDuration> </DsvcSeSettings></DsvcSeSettingsList>

PUT Delivery Service Example

<?xml version="1.0" encoding="UTF-8"?><DsvcSeSettingsInfo> <EnableAbrLive>true</EnableAbrLive> <TmpfsDuration>5</TmpfsDuration></DsvcSeSettingsInfo>

Other APIs

Show API

Table 2-21 Show API Calls



POST Show Response Example

<CliExecResponse cli="show alarms"><device id="165" status="1" message="CLI executed."> ---- the output of the cli command ----</device><device id="215" status="2" message="CLI not executed, device offline."/>

/api/deliveryService/{dsid}/dsvcSeSettings/SEs/{seid }

GET Gets the service engine settings of the SE identified with {seid} for a delivery service identified with {dsid}.

PUT Modifies the service engine settings of the SE identified with {seid} for a delivery service identified with {dsid}.

DELETE Removes the service engine settings of the SE identified with {seid} for a delivery service identified with {dsid}.

/api/deliveryServices/{dsid}/dsvcSeSettings

GET Gets all the service engine settings for a delivery service indentified with {dsid}.

/api/cli/show POST Applies show command on a specified device.


OL-31208-02

Chapter 2 CDSM RESTful APIsOther APIs

</CliExecResponse>


OL-31208-02

Chapter 2 CDSM RESTful APIs Other APIs


OL-31208-02

Documents

CDSM Restful APIsCHAPTER 2-1 Cisco VDS Internet Streamer 3.3 API Guide OL-31208-02 2 CDSM RESTful APIs This chapter describes the CDSM RESTful APIs for Device and Device Group, which