text/microsoft-resx 2.0 System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 You've submitted invalid data. Your request cannot be processed. Invalid syntax You are not authorized to access to this resource. Your session may have timed-out. If so login again. This functionality has not yet been implemented. The server has encoutered an issue and was unable to process your request. Please try again later. Your session may have timed-out. If so login again. Command '{0}' not found. {0} or {1} Did you mean '{0}'? No modules found. An error occurred while attempting to add the module. Please see the DNN Admin Logs for details. Unable to find a desktop module with the name '{0}' for this portal Successfully added {0} new module{1} Successfully copied the module. Module deleted successfully. No modules were added The source Page ID and target Page ID cannot be the same.\n Successfully moved the module. An error occurred while attempting to copy the module. See the DNN Admin Logs for Details. An error occurred while attempting to move the module. See the DNN Admin Logs for Details. Failed to delete the module with id {0}. Please see log viewer for more details. You do not have enough permissions to perform this operation. Could not find module with id {0} on page with id {1} No module found with id {0}. Could not load Target Page. No page found in the portal with ID '{0}' User triggered an Application Restart Initiates a restart of the DNN instance and reloads the page. Default Description Options Required Type Unable to find help for that command <section class="dnn-prompt-inline-help"> <h3>Understanding Prompt Commands</h3> <p> As with most command line interfaces, the more commands you memorize, the more efficient you can be. Understanding the reasoning behind <em>how</em> Prompt commands are named and structured will make it much easier to learn and internalize them. </p> <ol> <li> <strong>Prompt is Case-Insensitive</strong>. That means you can use lowercase, uppercase or mixed-case command names and option flag names. This is typical of most command lines and we find it makes it easier to use on a daily basis. </li> <li> <strong>Commands are either 1 word or 2 words separated by a single dash (-) and no spaces</strong>. </li> <li> <strong>One-Word Commands:</strong> These are generally reserved for commands that interact with the Prompt console itself or the browser. In other words, most of these commands take place in the browser. Some examples are: <code>cls</code> which clears the console screen and <code>reload</code> which tells the browser to reload the page. There are also two-word commands that operate on the client side such as <code>clear-history</code> (though there is a shortcut for clear-history: <code>clh</code></li> <li> <strong>Two-Word Commands:</strong> These commands follow the format <code>action-component</code>&mdash;an action followed by a single dash followed by a component or object that the action operates on. </li> </ol> <h4>Common Actions</h4> <p>This is not a complete list of all actions but covers most of them...</p> <table class="table"> <thead> <tr> <th>Action</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td class="mono">list</td> <td> Retrieves a list of objects. The assumption is that two or more objects will be returned so the component portion of the command is plural:<br> <code>list-pages</code> NOT <code>list-page</code> </td> </tr> <tr> <td class="mono">get</td> <td> Will retrieve a single object. If the command results in multiple objects, only the fist object found will be retrieved. Since this command operates on a single item, the component is singular and not plural:<br> <code>get-page</code> NOT <code>get-pages</code> </td> </tr> <tr> <td class="mono">new</td> <td> Creates a new object. We chose the word <code>new</code> since it requires less typing than 'create' and it is a more accurate than 'add', which connotes adding something to something else. </td> </tr> <tr> <td class="mono">add</td> <td> Adds something to something else. This should not be confused with <code>new</code> which <em>creates</em> a new object. Consider <code>add-roles</code> and <code>new-role</code>. The former is used to <em>add</em> one or more security roles to a user (i.e. add a role to the list of roles the user already has), whereas the latter command creates a new security role in the DNN system. </td> </tr> <tr> <td class="mono">set</td> <td> Modifies an object. This could mean 'update' or set (for the first time) a value. We chose the word 'set' not only because it's short and easy to type, but also because it is more accurate in more scenarios. 'Update' implies you are changing a value that has already been set, but is less accurate if you are setting a value for the first time. And did we mention 'set' is half the length of 'update'? </td> </tr> <tr> <td class="mono">delete</td> <td> Deletes an object. The results of this action are contextually dependent. If DNN provides a recycle bin facility like it does for pages and users, then the command will send the object to that recycle bin, allowing it to be restored later. If there is no such facility provided, then the object would be permanently deleted. </td> </tr> <tr> <td class="mono">restore</td> <td> If an object has been previously deleted and DNN provides a recycle facility for the object, then this will restore the object. </td> </tr> <tr> <td class="mono">purge</td> <td> If the object has been previously deleted and DNN provides a recycle facility for the object, then this command will permanently delete the object. The DNN user interface typically refers to this as 'remove' however we felt that 'purge' more accurately reflected the action. </td> </tr> </tbody> </table> <h4>Common Components</h4> <p>Most components should be familiar to any user with admin experience with DNN. Below are the most common:</p> <p>A Note on Plural vs Singular Components: Whenever a command can 1 or more items, the component will be plural. <code>list-modules</code>, for instance. When the command is designed to return a single object or the first object, then the component will be singular as in <code>get-module</code></p> <table class="table"> <thead> <tr> <th>Component</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td class="mono">user/users</td> <td> A DNN User. </td> </tr> <tr> <td class="mono">page/pages</td> <td>A page in the site. NOTE: For historical reasons, DNN refers to pages <em>internally</em> as Tabs while the DNN user interface refers to them as pages. We've chosen to use 'page', but you may see references to Tab or TabID returned from page-related commands. For Prompt's purposes, you should only use 'page' but understand that 'page and 'tab' are synonymous. </td> </tr> <tr> <td class="mono">role/roles</td> <td>A DNN Security Role.</td> </tr> <tr> <td class="mono">task/tasks</td> <td>A task is a DNN Scheduler Item or Scheduled Task. We use the word task due to its brevity.</td> </tr> <tr> <td class="mono">portal/portals</td> <td>A DNN site or portal.</td> </tr> <tr> <td class="mono">module/modules</td> <td>A DNN module. Depending on the command, this could be a module definition or module instance.</td> </tr> </tbody> </table> <h4>See Also</h4> <a data-cmd="help syntax" class="dnn-prompt-cmd-insert" href="#">Basic Syntax</a> <a data-cmd="help" class="dnn-prompt-cmd-insert" href="#">Prompt Commands List</a> </section> <section class="dnn-prompt-inline-help"> <h3>Basic Syntax</h3> <p> <em>Prompt</em> functions in a way similar to a Terminal, Bash shell, Windows CMD shell, or Powershell. You enter a command and hit <code>ENTER</code> and the computer responds with a result. For very simple commands like <code>help</code> or <code>list-modules</code>, that's all you need. Some commands, though, may require additional data or they may allow you to provide additional options. </p> <p> Specifying a target or context for a command: For commands that operate on an object like a user, or that require a context like a page, you simply provide that information after the command. For example, to find the user <em>jsmith</em> using the <code>get-user</code> command, you would type: <code>get-user jsmith</code> followed by the <code>ENTER</code> key to submit it. If you will be specifying flags (see next paragraph), those should <em>always come after</em> the target/context of the command. </p> <p> Specifying Options to Commands: Some commands require even more data or allow you to specify optional configuration information. In <em>Prompt</em> we call these &quot;flags&quot;. These should come <em>after</em> any target/context needed by the command (see above paragraph) and <em>must</em> be preceded with two hyphens or dashes (<code>--</code>). There should be no spaces between the dashes and there should be no space between the dashes and the name of the flag. If then flag requires a value, you add that after the flag. </p> <p> As an example of using flags, take the <code>get-user</code> command. By default, you would specify the username of the user you want to find. However, you can also search by their email address. In that case, you would use the <code>--email</code> flag. Here's how you would use it: </p> <code class="block"> get-user --email jsmith@sample.com </code> <p> If the value of a flag is more than one word, enclose it in double quotes like so: </p> <code class="block"> set-page --title "My Page" </code> <h4>See Also</h4> <a data-cmd="help learn" class="dnn-prompt-cmd-insert" href="#">Learning Prompt Commands</a> <a data-cmd="help" class="dnn-prompt-cmd-insert" href="#">Prompt Commands List</a> </section> Adds a module to a page on the website. Name of the desktop module to add. This should be unique existing module name. Specify the title of the module on the page. Id of the page to add module on. Specify the pane in which the module should be added. If not provided, module would be added to ContentPane. <h4>Add a module to a page</h4> <code class="block">add-module --name "Html" --pageid 23 --pane TopPane</code> Copies a module to the specified page. Explicitly specifies the Module ID of the module to copy. Use of the flag is not required. You can simply provide the ID value as the first argument. If true, Prompt will copy the source module's settings to the copied module. The Page ID of the page that contains the module you want to copy. Specify the pane in which the module should be copied. If not provided, module would be copied to ContentPane. The Page ID of the target page. The page to which you want to copy the module. Soft-deletes a module on a specific page. The module will be sent to the DNN Recycle Bin. This will not uninstall modules or affect module definitions. Explicitly specifies the Module ID of the module to retrieve. Use of the flag is not required. You can simply provide the ID value as the first argument. Specifies the Page ID of the page on which the module to delete resides. <h4>Delete and Send Module Instance to Recycle Bin</h4> <p>This will delete a module instance on a specific page and send it to the DNN Recycle Bin</p> <code class="block">delete-module 345 --pageid 42</code> Retrieves details about a single module in a specified page Explicitly specifies the Module ID of the module to retrieve. Use of the flag is not required. You can simply provide the ID value as the first argument. The Page ID of the page that contains the module. Module '{0}' has been found in page '{1}'. <h4>Get Information on a Specific Module</h4> <p>The code below retrieves the details for a module whose Module ID is 345 on a page 48</p> <code class="block">get-module 359 --pageid 48</code> <p>The following version is a more explicit version of the code above, but does the same thing on a page 48.</p> <code class="block">get-module --id 359 --pageid 48</code> <h4>Results</h4> <table class="command-result-tbl"> <tr> <td>ModuleId</td> <td>:</td> <td>359</td> </tr> <tr> <td>Title</td> <td>:</td> <td>Navigation</td> </tr> <tr> <td>ModuleName</td> <td>:</td> <td>Console</td> </tr> <tr> <td>FriendlyName</td> <td>:</td> <td>Console</td> </tr> <tr> <td>ModuleDefId</td> <td>:</td> <td>102</td> </tr> <tr> <td>TabModuleId</td> <td>:</td> <td>48</td> </tr> <tr> <td>AddedToPages</td> <td>:</td> <td>42, 46, 47, 48</td> </tr> </table> Retrieves a list of modules based on the search criteria When specified, the command will find all module instances in the portal that are in the Recycle Bin (if <span class="mono">--deleted</span> is true), or all module instances <em>not</em> in the Recycle Bin (if <span class="mono">--deleted</span> is false). If the flag is specified but no value is given, it will default to <span class="mono">true</span>. This flag may be used with <span class="mono">--name</span> and <span class="mono">--title</span> to further refine the results. Page Size for the page. Max is 500. The name of the module to search for. This accepts the wildcard (*) character to do partial searches. The Module Name is not the same thing as the module's Friendly Name or the module's Title. To find the Module Name, <code>list-modules</code> on a page containing the module. Searches are case-insensitive The title of the module to search for. This accepts wildcard (*) placeholders representing 0 or more characters. Searches are case-insensitive. Page number to show records. When specified, the command will show modules from specified page only. Use of the flag is not required. You can simply provide the ID value as the first argument. <h4>List Modules in the Current Portal</h4> <code class="block">list-modules</code> <h4>List Modules on Specific Page</h4> <code class="block">list-modules 72</code> <h4>List Modules Filtered by Module Name</h4> <p>This will return all XMod and XMod Pro modules in the current portal</p> <code class="block">list-modules --name XMod*</code> <h4>List Modules on a Specific Page Filtered by Module Name</h4> <p>This will return all XMod and XMod Pro modules on the page with a Page/TabId of 72</p> <code class="block">list-modules 72 --name XMod*</code> <h4>List All Modules Filtered on Name and Title</h4> <p>This will return all modules in the portal whose Module Name starts with Site <strong>and</strong> Title starts with Configure.</p> <code class="block">list-modules --title Configure* --name Site*</code> <h4>Returns</h4> <table class="command-result-tbl"> <thead> <tr> <th>ModuleId</th> <th>Title</th> <th>ModuleName</th> <th>FriendlyName</th> <th>ModuleDefId</th> <th>TabModuleId</th> <th>AddedToPages</th> </tr> </thead> <tbody> <tr> <td>394</td> <td>Configure portal settings, page design and apply a template...</td> <td>SiteWizard</td> <td>Site Wizard</td> <td>88</td> <td>86</td> <td>64</td> </tr> <tr> <td>395</td> <td>Configure the sitemap for submission to common search engines</td> <td>Sitemap</td> <td>Sitemap</td> <td>106</td> <td>87</td> <td>65</td> </tr> </tbody> </table> <h4>List All Deleted Modules in Portal</h4> <p>This will return all modules in the DNN Recycle Bin.</p> <code class="block">list-modules --deleted</code> <h4>Returns</h4> <table class="command-result-tbl"> <thead> <tr> <th>ModuleId</th> <th>Title</th> <th>Pane</th> <th>ModuleName</th> <th>FriendlyName</th> <th>ModuleDefId</th> <th>TabModuleId</th> <th>IsDeleted</th> <th>TabId</th> </tr> </thead> <tbody> <tr> <td>358</td> <td>Home Banner</td> <td>ContentPane</td> <td>DNN_HTML</td> <td>HTML</td> <td>120</td> <td>106</td> <td>true</td> <td>74</td> </tr> <tr> <td>410</td> <td>Module that was copied</td> <td>ContentPane</td> <td>DNN_HTML</td> <td>HTML</td> <td>120</td> <td>104</td> <td>true</td> <td>71</td> </tr> </tbody> </table> <h4>List All Deleted Modules Filtered on Name and Title</h4> <p>This will return all modules in the DNN Recycle Bin whose Module Name ends with &quot;HTML&quot; and whose Module Title contains &quot;that&quot;.</p> <code class="block">list-modules --deleted --name *HTML --title *that*</code> <h4>Returns</h4> <table class="command-result-tbl"> <thead> <tr> <th>ModuleId</th> <th>Title</th> <th>Pane</th> <th>ModuleName</th> <th>FriendlyName</th> <th>ModuleDefId</th> <th>TabModuleId</th> <th>IsDeleted</th> <th>TabId</th> </tr> </thead> <tbody> <tr> <td>410</td> <td>Module that was copied</td> <td>ContentPane</td> <td>DNN_HTML</td> <td>HTML</td> <td>120</td> <td>104</td> <td>true</td> <td>71</td> </tr> </tbody> </table> Moves a module to the specified page Explicitly specifies the Module ID of the module to copy. Use of the flag is not required. You can simply provide the ID value as the first argument. The Page ID of the page that contains the module you want to copy. Specify the pane in which the module should be moved. If not provided, module would be moved to ContentPane. The Page ID of the target page. The page to which you want to copy the module. <h4>Move a Module from One Page to Another</h4> <p>This command takes the module with Module ID 358 on the Page with Page ID of 71 and places module on the page with a Page ID of 75</p> <code class="block">move-module 358 --pageid 71 --topageid 75</code> <h4>Results</h4> <table class="command-result-tbl"> <tr> <td>ModuleId</td> <td>:</td> <td>358</td> </tr> <tr> <td>Title</td> <td>:</td> <td>My Module</td> </tr> <tr> <td>ModuleName</td> <td>:</td> <td>DNN_HTML</td> </tr> <tr> <td>FriendlyName</td> <td>:</td> <td>HTML</td> </tr> <tr> <td>ModuleDefId</td> <td>:</td> <td>120</td> </tr> <tr> <td>TabModuleId</td> <td>:</td> <td>107</td> </tr> <tr> <td>AddedToPages</td> <td>:</td> <td>71, 75</td> </tr> <tr> <td colspan="3">Successfully moved the module.</td> </tr> </table> Clears the server's cache and reloads the page. <code class="block"> clear-cache </code> <h4>Results</h4> <table class="command-result-tbl"> <tr><td>Cache cleared</td></tr> <tr><td>Reloading in 3 seconds</td></tr> </table> Clears history of commands used in current session Clears the Event Log for the current portal. <code class="block"> clear-log </code> <h4>Results</h4> <table class="command-result-tbl"> <tr><td><em>[Event Log Cleared]</em></td></tr> </table> Clears the Prompt console. <code>cls</code> is a shortcut for <a href="#clear-screen" class="dnn-prompt-cmd-insert"><code>clear-screen</code></a> Echos back the first argument received Exits the Prompt console. Retrieves information about the DNN installation <h4>Get Information on Current DNN Installation</h4> <code class="block"> get-host </code> <h4>Results</h4> <table class="command-result-tbl"> <tr> <td>Product</td> <td>:</td> <td>DNN Platform</td> </tr> <tr> <td>Version</td> <td>:</td> <td>9.0.0.1002</td> </tr> <tr> <td>UpgradeAvailable</td> <td>:</td> <td>true</td> </tr> <tr> <td>Framework</td> <td>:</td> <td>4.6</td> </tr> <tr> <td>IP Address</td> <td>:</td> <td>fe80::a952:8263:d357:ab90%5</td> </tr> <tr> <td>Permissions</td> <td>:</td> <td>ReflectionPermission, WebPermission, AspNetHostingPermission</td> </tr> <tr> <td>Site</td> <td>:</td> <td>dnnprompt.com</td> </tr> <tr> <td>Title</td> <td>:</td> <td>DNN Corp</td> </tr> <tr> <td>Url</td> <td>:</td> <td>http://www.dnnsoftware.com</td> </tr> <tr> <td>Email</td> <td>:</td> <td>support@dnnprompt.com</td> </tr> <tr> <td>Theme</td> <td>:</td> <td>Gravity (2-Col)</td> </tr> <tr> <td>Container</td> <td>:</td> <td>Gravity (Title_h2)</td> </tr> <tr> <td>EditTheme</td> <td>:</td> <td>Gravity (2-Col)</td> </tr> <tr> <td>EditContainer</td> <td>:</td> <td>Gravity (Title_h2)</td> </tr> <tr> <td>PortalCount</td> <td>:</td> <td>1</td> </tr> </table> Retrieves basic information about the current portal or specified portal Portal Id to get info. Only host can get information of portals other than current. <h4>Get Information on Current Portal</h4> <code class="block"> get-portal </code> <h4>Results</h4> <table class="command-result-tbl"> <tr> <td>PortalId</td> <td>:</td> <td>0</td> </tr> <tr> <td>PortalName</td> <td>:</td> <td>dnnsoftware.com</td> </tr> <tr> <td>CdfVersion</td> <td>:</td> <td>-1</td> </tr> <tr> <td>RegistrationMode</td> <td>:</td> <td>Verified</td> </tr> <tr> <td>DefaultPortalAlias</td> <td>:</td> <td>dnnsoftware.com</td> </tr> <tr> <td>PageCount</td> <td>:</td> <td>34</td> </tr> <tr> <td>UserCount</td> <td>:</td> <td>5</td> </tr> <tr> <td>SiteTheme</td> <td>:</td> <td>Xcillion (Inner)</td> </tr> <tr> <td>AdminTheme</td> <td>:</td> <td>Xcillion (Admin)</td> </tr> <tr> <td>Container</td> <td>:</td> <td>Xcillion (NoTitle)</td> </tr> <tr> <td>AdminContainer</td> <td>:</td> <td>Xcillion (Title_h2)</td> </tr> <tr> <td>Language</td> <td>:</td> <td>en-US</td> </tr> </table> Retrieves basic information about the current portal or specified portal Site Id to get info. Only host can get information of portals other than current. <h4>Get Information on Current Portal</h4> <code class="block"> get-portal </code> <h4>Results</h4> <table class="command-result-tbl"> <tr> <td>PortalId</td> <td>:</td> <td>0</td> </tr> <tr> <td>PortalName</td> <td>:</td> <td>dnnsoftware.com</td> </tr> <tr> <td>CdfVersion</td> <td>:</td> <td>-1</td> </tr> <tr> <td>RegistrationMode</td> <td>:</td> <td>Verified</td> </tr> <tr> <td>DefaultPortalAlias</td> <td>:</td> <td>dnnsoftware.com</td> </tr> <tr> <td>PageCount</td> <td>:</td> <td>34</td> </tr> <tr> <td>UserCount</td> <td>:</td> <td>5</td> </tr> <tr> <td>SiteTheme</td> <td>:</td> <td>Xcillion (Inner)</td> </tr> <tr> <td>AdminTheme</td> <td>:</td> <td>Xcillion (Admin)</td> </tr> <tr> <td>Container</td> <td>:</td> <td>Xcillion (NoTitle)</td> </tr> <tr> <td>AdminContainer</td> <td>:</td> <td>Xcillion (Title_h2)</td> </tr> <tr> <td>Language</td> <td>:</td> <td>en-US</td> </tr> </table> Lists all the commands. Retrieves a list of portals for the current DNN Installation Retrieves a list of portals for the current DNN Installation Reloads the current page Page {0} of {1}. Page {0} of {1}. Press any key to load next page. Press CTRL + X to end. Default Description Flag Options Required Type General Commands Host Commands Module Commands Portal Commands Command Commands Description Learning Prompt Commands Here is a list of available commands for Prompt. Prompt Commands See Also Overview/Basic Syntax An error occurred while attempting to clear the cache. Cache Cleared. An error occurred while attempting to clear the Event Log. Event Log Cleared. Nothing to echo back <h4></h4> '[0]' is required. You do not have authorization to access this functionality. The get-host command does not take any arguments or flags. get-host command executed successfully. The get-portal command does not take any arguments or flags. Could not find a portal with ID of '{0}' Portal '{0}' has been found. An error occurred while attempting to list the commands. Found {0} commands. Description Name Version Category The list-portal command does not take any arguments or flags '{0}' Portal{1} found. Sets the DNN View Mode. This has the same effect as clicking the appropriate options in the DNN Control Bar. One of three view modes: <code>edit</code>, <code>layout</code>, or <code>view</code>. You do not need to specify the <span class="mono">--mode</span> flag explicitly. Simply type one of the view mode values after the command. <div> <h4>Change the DNN View Mode</h4> <code class="block"> set-mode layout </code> OR <code class="block"> set-mode view </code> OR <code class="block"> set-mode edit </code> </div> An error occurred while attempting to restart the application. Application Restarted <h4>Copy a Module from One Page to Another</h4> <p>This command makes a copy of the module with Module ID 358 on the Page with Page ID of 71 and places that copy on the page with a Page ID of 75</p> <code class="block">copy-module 358 --pageid 71 --topageid 75</code> <h4>Results</h4> <table class="command-result-tbl"> <tr> <td>ModuleId</td> <td>:</td> <td>358</td> </tr> <tr> <td>Title</td> <td>:</td> <td>My Module</td> </tr> <tr> <td>ModuleName</td> <td>:</td> <td>DNN_HTML</td> </tr> <tr> <td>FriendlyName</td> <td>:</td> <td>HTML</td> </tr> <tr> <td>ModuleDefId</td> <td>:</td> <td>120</td> </tr> <tr> <td>TabModuleId</td> <td>:</td> <td>107</td> </tr> <tr> <td>AddedToPages</td> <td>:</td> <td>71, 75</td> </tr> <tr> <td colspan="3">Successfully copied the module.</td> </tr> </table> <h4></h4> <h4></h4> <h4></h4> <h4>Results</h4> <table class="command-result-tbl"> <tr><td>Application restarted</td></tr> <tr><td>Reloading in 3 seconds</td></tr> </table> <em> { Factory Method } </em> <em> { Specific Instance } </em> <em> { None } </em> You do not have authorization to access this functionality.