Skip to content

Module Commands

Jump to bottom Edit New page
CBPSC edited this page Feb 16, 2017 · 5 revisions

copy-module

Copies a module to the specified page

Parameters
--id
--pageid
--topageid
--includesettings

  • id

  • Type: Integer

  • Required: Yes

  • Description: 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.

  • pageid

  • Type: Integer

  • Required: Yes

  • Description: The Page ID of the page that contains the module you want to copy.

  • topageid

  • Type: Integer

  • Required: Yes

  • Description: The Page ID of the target page. The page to which you want to copy the module.

  • includesettings

  • Type: Boolean

  • Required: No

  • Description: If true, Prompt will copy the source module's settings to the copied module.

Example usage: "copy-module 358 --pageid 71 --topageid 75"

delete-module

Permanently deletes the module instance and all referenced instances, or soft-deletes a module on a specific page. This does not uninstall modules or affect module definitions.

Parameters
--id
--pageid

  • id

  • Type: Integer

  • Required: Yes

  • Description: 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.

  • pageid

  • Type: Integer

  • Required: No

  • Description: Specifies the Page ID of the page on which the module to delete resides. When you specify the pageid in addition to the required id, the module will be sent to the DNN Recycle Bin as opposed to being permanently deleted.

Example usage: "delete-module 345"

list-modules

Retrieves a list of modules based on the specified criteria

DNN Prompt List-Modules Command

Parameters
--name
--title
--all
--deleted

  • name

  • Type: String

  • Required: No

  • Description: 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, list-modules on a page containing the module. Searches are case-insensitive.

  • title

  • Type: String

  • Required: No

  • Description: The title of the module to search for. This accepts wildcard (*) placeholders representing 0 or more characters. Searches are case-insensitive.

  • all

  • Type: Boolean

  • Required: No

  • Description: When specified, the command will operate on all modules for the current portal. This flag does not need a value.

  • deleted

  • Type: Boolean

  • Required: No

  • Description: When specified, the command will find all module instances in the portal that are in the Recycle Bin (if --deleted is true), or all module instances not in the Recycle Bin (if operate --deleted is false). If the flag is specified but no value is given, it will default to true. This flag may be used with --name and --title to further refine the results.

Example usages:

  • "list-modules" - Lists modules on current page
  • "list-modules 72" - Lists modules on the page with pageid 72
  • "list-modules --all" - Lists all modules in current portal
  • "list-modules --all --name XMod*" - Lists modules filtered by name. In this case XMod & XMod Pro modules will be returned
  • "list-modules 72 --name XMod" - Lists modules on a specific page filtered by module name. In this case all XMod & XMod Pro modules on the page with pageid 72 will be returned
  • "list-modules --all --title Configure* --name Site*" - Lists all modules filtered on name & title. In this case all modules in the portal whose module name starts with site and title starts with configure.

move-module

Moves a module to the specified page

Parameters
--id
--pageid
--topageid

  • id

  • Type: Integer

  • Required: Yes

  • Description: 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.

  • pageid

  • Type: Integer

  • Required: Yes

  • Description: The Page ID of the page that contains the module you want to copy.

  • topageid

  • Type: Integer

  • Required: Yes

  • Description: The Page ID of the target page. The page to which you want to copy the module.

Example usage: "move-moduel 358 --pageid 71 --topageid 75"

get-module

Retrieves details about a single module

Parameters
--id

  • id
  • Type: Integer
  • Required: Yes
  • Description: 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.

Example usage: "get-module 359"

restore-module

Recovers a module from the DNN Recycle Bin

Parameters
--id --pageid

  • id

  • Type: Integer

  • Required: Yes

  • Description: 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.

  • pageid

  • Type: Integer

  • Required: Yes

  • Description: The Page ID of the page on which the module you want to restore resided prior to deletion.

Example usage: "restore-module 359 --pageid 71"

Add a custom footer
Add a custom sidebar
Clone this wiki locally