{"id":9589,"date":"2022-06-21T13:52:51","date_gmt":"2022-06-21T13:52:51","guid":{"rendered":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/"},"modified":"2025-03-25T05:18:32","modified_gmt":"2025-03-25T05:18:32","slug":"ccspdmcli","status":"publish","type":"page","link":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/","title":{"rendered":"CcspDmCli"},"content":{"rendered":"\n <h2 class=\"wp-main-header wp-block-heading\">Overview<\/h2><p>DmCli is a CCSP component that provides the Command Line Interface to the device. It helps to&nbsp;&nbsp;interact with data objects in the RDKB setup and query their values or set\/change them.<\/p><p>Dmcli is used to send and receive DBUS messages via CLI (Command Line Interface) over Telnet and SSH protocols.<\/p><p>Its primary role is to allow an individual to perform Data base related operations on the Data Model.&nbsp;<\/p><p>Some of the primary functionalities supported by it are:<\/p><ul><li>Get the value of a parameter<\/li><li>Set the value of a parameter<\/li><li>Add an entry to the table<\/li><li>Delete an entry to the table<\/li><\/ul><p>One very crucial and important functionality is that it extends the operations of parameters in common library through command line. It is very useful for developing a new component and debugging purpose.<\/p><p>A sample dmcli command looks as follows with the expected output. In the output , the component name will be displayed based on the parameter queried .<\/p><div class=\"preformatted panel conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"noformat\"><div class=\"preformattedContent panelContent\">\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\">root@RaspberryPi-Gateway:~# dmcli eRT getv Device.WiFi.RadioNumberOfEntries\nCR component name is: eRT.com.cisco.spvtg.ccsp.CR\nsubsystem_prefix eRT.\ngetv from\/to component(eRT.com.cisco.spvtg.ccsp.wifi): Device.WiFi.RadioNumberOfEntries\nExecution succeed.\nParameter    1 name: Device.WiFi.RadioNumberOfEntries\n               type:       uint,    value: 2 \n\n<\/pre>\n<\/div><\/div><div class=\"preformatted panel conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"noformat\"><div class=\"preformattedContent panelContent\">\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\">root@RaspberryPi-Gateway:~# dmcli eRT getv Device.WiFi.X_RDKCENTRAL-COM_PreferPrivate\nCR component name is: eRT.com.cisco.spvtg.ccsp.CR\nsubsystem_prefix eRT.\ngetv from\/to component(eRT.com.cisco.spvtg.ccsp.wifi): Device.WiFi.X_RDKCENTRAL-COM_PreferPrivate\nExecution succeed.\nParameter    1 name: Device.WiFi.X_RDKCENTRAL-COM_PreferPrivate\n               type:       bool,    value: true \n\n<\/pre>\n<\/div><\/div><p><br><\/p><h2 class=\"wp-main-header wp-block-heading\">DmCli usage<\/h2><ul><li>Invoking Multiple DMs from single dmcli command<\/li><\/ul><div class=\"code panel pdl conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"code\"><div class=\"codeContent panelContent pdl\">\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\">~ # dmcli eRT getv Device.WiFi.SSID.1.Status Device.WiFi.SSID.9.Enable\nCR component name is: eRT.com.cisco.spvtg.ccsp.CR\nsubsystem_prefix eRT.\ngetv from\/to component(eRT.com.cisco.spvtg.ccsp.wifi): Device.WiFi.SSID.1.Status\nExecution succeed.\nParameter    1 name: Device.WiFi.SSID.1.Status\n               type:     string,    value: Up\nParameter    2 name: Device.WiFi.SSID.9.Enable\n               type:       bool,    value: false\n\n<\/pre>\n<\/div><\/div><p><br><\/p><ul><li>getn command to retrieve the access permission of the parameter<\/li><\/ul><div class=\"code panel pdl conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"code\"><div class=\"codeContent panelContent pdl\">\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\">~ # dmcli eRT getn Device.WiFi.SSID.1.Status\nCR component name is: eRT.com.cisco.spvtg.ccsp.CR\nsubsystem_prefix eRT.\ngetn from\/to component(eRT.com.cisco.spvtg.ccsp.wifi): Device.WiFi.SSID.1.Status\nExecution succeed.\nParameter    1 name: Device.WiFi.SSID.1.Status\n        writable:ReadOnly.<\/pre>\n<\/div><\/div><div class=\"code panel pdl conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"code\"><div class=\"codeContent panelContent pdl\">\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\">~ # dmcli eRT getn Device.WiFi.SSID.1.Enable\nCR component name is: eRT.com.cisco.spvtg.ccsp.CR\nsubsystem_prefix eRT.\ngetn from\/to component(eRT.com.cisco.spvtg.ccsp.wifi): Device.WiFi.SSID.1.Enable\nExecution succeed.\nParameter    1 name: Device.WiFi.SSID.1.Enable\n        writable:Writable.<\/pre>\n<\/div><\/div><p><br><\/p><ul><li>Command to list all corresponding parameters and the respective values<\/li><\/ul><div class=\"code panel pdl conf-macro output-block\" data-hasbody=\"true\" data-macro-name=\"code\"><div class=\"codeContent panelContent pdl\">\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"generic\">~ # dmcli eRT getv Device.WiFi.SSID.9.\nCR component name is: eRT.com.cisco.spvtg.ccsp.CR\nsubsystem_prefix eRT.\ngetv from\/to component(eRT.com.cisco.spvtg.ccsp.wifi): Device.WiFi.SSID.9.\nExecution succeed.\nParameter    1 name: Device.WiFi.SSID.9.Enable\n               type:       bool,    value: false\nParameter    2 name: Device.WiFi.SSID.9.Status\n               type:     string,    value: Down\nParameter    3 name: Device.WiFi.SSID.9.Alias\n               type:     string,    value: ath8\nParameter    4 name: Device.WiFi.SSID.9.Name\n               type:     string,    value: ath8\nParameter    5 name: Device.WiFi.SSID.9.LastChange\n               type:       uint,    value: 910\nParameter    6 name: Device.WiFi.SSID.9.LowerLayers\n               type:     string,    value: Device.WiFi.Radio.1.\nParameter    7 name: Device.WiFi.SSID.9.BSSID\n               type:     string,    value:\nParameter    8 name: Device.WiFi.SSID.9.MACAddress\n               type:     string,    value:\nParameter    9 name: Device.WiFi.SSID.9.SSID\n               type:     string,    value: OutOfService\nParameter   10 name: Device.WiFi.SSID.9.X_COMCAST-COM_DefaultSSID\n               type:     string,    value: OutOfService\nParameter   11 name: Device.WiFi.SSID.9.X_CISCO_COM_EnableOnline\n               type:       bool,    value: false\nParameter   12 name: Device.WiFi.SSID.9.X_CISCO_COM_RouterEnabled\n               type:       bool,    value: false\nParameter   13 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResultNumberOfEntries\n               type:       uint,    value: 3\nParameter   14 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.1.X_TCH_COM_Result\n               type:     string,    value: Invalid\nParameter   15 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.1.X_TCH_COM_CreationTime\n               type:   dateTime,    value: 0000-00-00 00:00:00\nParameter   16 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.1.X_TCH_COM_PAOffAvgChannel\n               type:     string,    value:\nParameter   17 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.1.X_TCH_COM_PAOnAvgChannel\n               type:     string,    value:\nParameter   18 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.1.X_TCH_COM_PAOffMaxChannel\n               type:     string,    value:\nParameter   19 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.1.X_TCH_COM_PAOnMaxChannel\n               type:     string,    value:\nParameter   20 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.1.X_TCH_COM_ResultsInfo\n               type:     string,    value:\nParameter   21 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.2.X_TCH_COM_Result\n               type:     string,    value: Invalid\nParameter   22 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.2.X_TCH_COM_CreationTime\n               type:   dateTime,    value: 0000-00-00 00:00:00\nParameter   23 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.2.X_TCH_COM_PAOffAvgChannel\n               type:     string,    value:\nParameter   24 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.2.X_TCH_COM_PAOnAvgChannel\n               type:     string,    value:\nParameter   25 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.2.X_TCH_COM_PAOffMaxChannel\n               type:     string,    value:\nParameter   26 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.2.X_TCH_COM_PAOnMaxChannel\n               type:     string,    value:\nParameter   27 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.2.X_TCH_COM_ResultsInfo\n               type:     string,    value:\nParameter   28 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.3.X_TCH_COM_Result\n               type:     string,    value: Invalid\nParameter   29 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.3.X_TCH_COM_CreationTime\n               type:   dateTime,    value: 0000-00-00 00:00:00\nParameter   30 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.3.X_TCH_COM_PAOffAvgChannel\n               type:     string,    value:\nParameter   31 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.3.X_TCH_COM_PAOnAvgChannel\n               type:     string,    value:\nParameter   32 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.3.X_TCH_COM_PAOffMaxChannel\n               type:     string,    value:\nParameter   33 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.3.X_TCH_COM_PAOnMaxChannel\n               type:     string,    value:\nParameter   34 name: Device.WiFi.SSID.9.X_TCH_COM_11nCalcResult.3.X_TCH_COM_ResultsInfo\n               type:     string,    value:\nParameter   35 name: Device.WiFi.SSID.9.Stats.BytesSent\n               type:       uint,    value: 0\nParameter   36 name: Device.WiFi.SSID.9.Stats.BytesReceived\n               type:       uint,    value: 0\nParameter   37 name: Device.WiFi.SSID.9.Stats.PacketsSent\n               type:       uint,    value: 0\nParameter   38 name: Device.WiFi.SSID.9.Stats.PacketsReceived\n               type:       uint,    value: 0\nParameter   39 name: Device.WiFi.SSID.9.Stats.ErrorsSent\n               type:       uint,    value: 0\nParameter   40 name: Device.WiFi.SSID.9.Stats.ErrorsReceived\n               type:       uint,    value: 0\nParameter   41 name: Device.WiFi.SSID.9.Stats.UnicastPacketsSent\n               type:       uint,    value: 0\nParameter   42 name: Device.WiFi.SSID.9.Stats.UnicastPacketsReceived\n               type:       uint,    value: 0\nParameter   43 name: Device.WiFi.SSID.9.Stats.DiscardPacketsSent\n               type:       uint,    value: 0\nParameter   44 name: Device.WiFi.SSID.9.Stats.DiscardPacketsReceived\n               type:       uint,    value: 0\nParameter   45 name: Device.WiFi.SSID.9.Stats.MulticastPacketsSent\n               type:       uint,    value: 0\nParameter   46 name: Device.WiFi.SSID.9.Stats.MulticastPacketsReceived\n               type:       uint,    value: 0\nParameter   47 name: Device.WiFi.SSID.9.Stats.BroadcastPacketsSent\n               type:       uint,    value: 0\nParameter   48 name: Device.WiFi.SSID.9.Stats.BroadcastPacketsReceived\n               type:       uint,    value: 0\nParameter   49 name: Device.WiFi.SSID.9.Stats.UnknownProtoPacketsReceived\n               type:       uint,    value: 0\nParameter   50 name: Device.WiFi.SSID.9.Stats.RetransCount\n               type:       uint,    value: 0\nParameter   51 name: Device.WiFi.SSID.9.Stats.FailedRetransCount\n               type:       uint,    value: 0\nParameter   52 name: Device.WiFi.SSID.9.Stats.RetryCount\n               type:       uint,    value: 0\nParameter   53 name: Device.WiFi.SSID.9.Stats.MultipleRetryCount\n              type:       uint,    value: 0\nParameter   54 name: Device.WiFi.SSID.9.Stats.ACKFailureCount\n               type:       uint,    value: 0\nParameter   55 name: Device.WiFi.SSID.9.Stats.AggregatedPacketCount\n               type:       uint,    value: 0\n\n<\/pre>\n<\/div><\/div><p><br><\/p><p><br><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Overview DmCli is a CCSP component that provides the Command Line Interface to the device. [&hellip;]<\/p>\n","protected":false},"author":28,"featured_media":0,"parent":9575,"menu_order":3,"comment_status":"open","ping_status":"closed","template":"","meta":{"_bbp_topic_count":0,"_bbp_reply_count":0,"_bbp_total_topic_count":0,"_bbp_total_reply_count":0,"_bbp_voice_count":0,"_bbp_anonymous_reply_count":0,"_bbp_topic_count_hidden":0,"_bbp_reply_count_hidden":0,"_bbp_forum_subforum_count":0,"footnotes":""},"class_list":["post-9589","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v24.9 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>CcspDmCli - RDK Documentation Portal | Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"CcspDmCli - RDK Documentation Portal | Documentation\" \/>\n<meta property=\"og:description\" content=\"Overview DmCli is a CCSP component that provides the Command Line Interface to the device. [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/\" \/>\n<meta property=\"og:site_name\" content=\"RDK Documentation Portal | Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-03-25T05:18:32+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"1 minute\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/\",\"name\":\"CcspDmCli - RDK Documentation Portal | Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\"},\"datePublished\":\"2022-06-21T13:52:51+00:00\",\"dateModified\":\"2025-03-25T05:18:32+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"RDK Broadband\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Components\",\"item\":\"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"CcspDmCli\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/developer.rdkcentral.com\/documentation\/#website\",\"url\":\"https:\/\/developer.rdkcentral.com\/documentation\/\",\"name\":\"RDK Documentation Portal | Documentation\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"CcspDmCli - RDK Documentation Portal | Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/","og_locale":"en_US","og_type":"article","og_title":"CcspDmCli - RDK Documentation Portal | Documentation","og_description":"Overview DmCli is a CCSP component that provides the Command Line Interface to the device. [&hellip;]","og_url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/","og_site_name":"RDK Documentation Portal | Documentation","article_modified_time":"2025-03-25T05:18:32+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"1 minute"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/","url":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/","name":"CcspDmCli - RDK Documentation Portal | Documentation","isPartOf":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website"},"datePublished":"2022-06-21T13:52:51+00:00","dateModified":"2025-03-25T05:18:32+00:00","breadcrumb":{"@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/ccspdmcli\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":2,"name":"Documentation","item":"https:\/\/developer.rdkcentral.com\/documentation\/"},{"@type":"ListItem","position":3,"name":"RDK Broadband","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/"},{"@type":"ListItem","position":4,"name":"Components","item":"https:\/\/developer.rdkcentral.com\/documentation\/documentation\/rdk_broadband_documentation\/components\/"},{"@type":"ListItem","position":5,"name":"CcspDmCli"}]},{"@type":"WebSite","@id":"https:\/\/developer.rdkcentral.com\/documentation\/#website","url":"https:\/\/developer.rdkcentral.com\/documentation\/","name":"RDK Documentation Portal | Documentation","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/developer.rdkcentral.com\/documentation\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"}]}},"_links":{"self":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9589","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/users\/28"}],"replies":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/comments?post=9589"}],"version-history":[{"count":3,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9589\/revisions"}],"predecessor-version":[{"id":12215,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9589\/revisions\/12215"}],"up":[{"embeddable":true,"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/pages\/9575"}],"wp:attachment":[{"href":"https:\/\/developer.rdkcentral.com\/documentation\/wp-json\/wp\/v2\/media?parent=9589"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}