ovowtoolutil

The ovowtoolutil tool allows command-line management of tools and tool groups. Specific tools or tool groups are referred to in several different ways:

For tools

• By hierarchical path (-tool_path_parameter)

  A hierarchical path is a directory-like path of tool group names followed by a tool name that uniquely identifies a group. Captions/Display Names are used as names, backslash \ is used as a separator (for example, \rocco\cad\room108). The path must always start with \. A single \ denotes the Root. If a tool or tool group name itself contains a backslash, it must be escaped with an additional backslash (\\).

• By tool ID (-tool_id_parameter)

  Tool ID represents the Name property of the tool that uniquely identifies it. It is usualy a GUID but it can also be any other unique string.

For tool groups

• By hierarchical path (-group_path_parameter)

  A hierarchical path is a directory-like path of tool group names that uniquely identifies a group. Captions/Display Names are used as tool group names, backslash \ is used as a separator (for example, \rocco\cad\room108). The path must always start with \. A single \ denotes the Root. If group name itself contains a backslash, it must be escaped with an additional backslash (\\).

• By tool ID (-group_id_parameter)

  Group ID represents the Name property a tool group that uniquely identifies it. It is usually a GUID but it can also be any other unique string.

Command synopsis

ovowtoolutil
   [ -help ]
   [ -add_group -group_path <hierarchy path> ]
   [ -add_tool -type EXE|VBS|JS|WSH|PERL|URL -tool_name <tool name>
			 (-cmd <command> | cmd_file <file name>)
			 [-tool_id <tool id>] [-descr <descr>]
			 [-group_path <hierarchy path> | group_id <group id>]
			 [-output yes|no] [-params <params>] [-edit_params yes|no]
			 [-req_pass yes|no] [-pass <password>]
			 [-exec_as <user>] [-edit_login yes|no]
			 [-exec_on MGMTSRV|NODE|NODELIST|CONSOLE]
			 [-node_list_id <list of ids> |
				-node_list_pnn <list of prim. node names>] ]
   [ -delete_group (-group_path <hierarchy path> | -group_id <group id>) ]
   [ -delete_tool (-tool_path <tool hierarchy path> | tool_id <tool id>) ]
   [ -rename_group (-group_path <hierarchy path> | -group_id <group id>)
				 (-new_id <new tool id> -new_name <new tool name> |
				 (-new_id <new tool id> -new_name <tool name>) ]
   [ -rename_tool (-tool_path <tool hierarchy path> | tool_id <tool id>=>)
				(-new_id <new tool id> -new_name <new tool name> |
				(-new_id <new tool id> | -new_name <new tool name>) ]

Options

-help		 Show tool usage and description.

-add_group	Add a tool group to this management server.
   -group_path <hierarchy path>
	Specifies a tool group by hierarchical path. All non-existing groups
	in the path will be created.

-add_tool	 Add a tool to this management server.
   -type EXE|VBS|JS|WSH|PERL|URL
	Specifies the type of tool: EXE=executable, VBS=Visual Basic script,
	JS=JScript, WSH=Windows Scripting Host script, PERL=Perl script
	URL=internet URL
   -tool_name <tool name>
	Specifies the name (caption) of the tool.
   -cmd <command> | cmd_file <file name>
	Specifies the command to be executed. It can be an executable path or
	a script (given directly on command line). To read script from a file
	use -cmd_file to specify a file path.
   -tool_id <tool id>]
	Specifies the id of the tool. If not given, new GUID will be generated.
   -descr <descr>
	Specifies a description of the tool.
   -group_path <hierarchy path> | group_id <group id>
	Specifies a parent tool group for the new tool, either as hierarchy
	path or as id.
   -output yes|no
	Specifies whether tool has output or not (defaults to "no").
   -params <params>
	Specifies additional parameters of the tool
	(applicable only for executables).
   -edit_params yes|no
	Specifies whether operator will be allowed to edit parameters or not
	(defaults to "no").
   -req_pass yes|no
	Specifies whether password is required to run the tool (defaults to "no"").
   -pass <password>
	Specifies the password for the tool.
   -exec_as <user>
	Specifies the user account under which the tool will run.
   -edit_login yes|no
	Specifies whether operator will be allowed to edit user information
	(defaults to "no").
   -exec_on MGMTSRV|NODE|NODELIST|CONSOLE
	Specifies the target to run the tool on: MGMTSRV=management server, 
	NODE=selected node, NODELIST=list of nodes, CONSOLE=console.
   -node_list_id <list of ids> | -node_list_pnn <list of prim. node names> 
	Specifies a list of nodes (to run the tool on), either as list of ids or
	a list of primary node names. Items must be separated by commas (,).

-delete_group	 Delete a tool group from this management server.
   -group_path <hierarchy path>
	Specifies a tool group to be deleted by hierarchical path.
   -group_id <group id>
	Specifies a tool group to be deleted by its ID.

-delete_tool	Delete a tool from this management server.
   -tool_path <hierarchy path>
	Specifies a tool to be deleted by hierarchical path.
   -tool_id <group id>
	Specifies a tool to be deleted by its ID.

-rename_group	 Rename a tool group (its name, id or both).
   -group_path <hierarchy path>
	Specifies a tool group to be renamed by hierarchical path.
   -group_id <group id>
	Specifies a tool group to be renamed by its Id.
   -new_id <new group id>
	Specifies the new Id of the group.
   -new_name <new group name>
	Specifies the new name of the group.

-rename_tool	Rename a tool (its name, id or both).
   -tool_path <hierarchy path>
	Specifies a tool to be renamed by hierarchical path.
   -tool_id <group id>
	Specifies a tool to be renamed by its ID.
   -new_id <new tool id>
	Specifies the new Id of the tool.
   -new_name <new tool name>
	Specifies the new name of the tool.

Examples

ovowtoolutil -help

  outputs help and usage of the tool

ovowtoolutil -add_tool -type EXE -tool_name MY_TOOL -cmd mytool.exe

  creates a new tool named MY_TOOL that will be started through the mytool.exe
  executable; the tool is assigned to the root tool group as no specific tool group
  was given
  
ovowtoolutil -rename_tool -tool_path \test_tools\beep -new_name my_beep

  renames the tool caption from beep from tool group \test_tools to my_beep