Tag: <usertool> - User tool and proxy Definition

Definition

The user tool tag defines all the tools that are available to be used to access a device. These are chosen in a profile and appear under each device that use the template and have been connected together through a profile. The <access> tags define exactly how this access happens.

This tag has the following attributes:

Parameters

  • display_name (str): This is the display string used in the PxM Client* on the link for the tool under the device.
  • protocol (str): The name of the protocol the tools uses. This also tells the PxM Platform what type of proxy to use to facilitate the connection.
  • launch_script (str): The name of the .au3 file the tool is launched with.
  • map_launch_type (local, profile):This defines which type of account is used to establish the underlying RDP RemoteApp connection to the MAP server.

MAP Launch Type Values

The map_launch_type attribute can have the following values:

map_launch_type Value Description
local This tells the PxM Platform to create a MAP_USER_ account locally on the MAP server and use this to make the underlying RDP RemoteApp connection to the MAP server.
profile This tells the PxM Platform to use the same account in the underlying RDP RemoteApp connection as defined in the profile for accessing the target device. This can be a domain account. To use a domain account the MAP server must be a domain member.

Example

This example shows a device that has three user tools available: SSH, a web browser interface and a thick management client:

1
2
3
4
5
   <usertools>
      <usertool display_name='Browser (HTTPS)' protocol='https'/>
      <usertool display_name='Command Line (SSH)' protocol='ssh'/>
      <usertool display_name='Management Console' launch_script='management_console.au3'/>
   </usertools>

This example shows a MAP tool that will be launched with a local PxM MAP RDP RemoteApp account:

1
2
3
   <usertools>
      <usertool display_name='Management Console' launch_script='management_console.au3' map_launch_type='local'/>
   </usertools>

This example shows a MAP tool that will be launched on the PxM MAP over RDP RemoteApp with whatever account has been defined in the profile:

1
2
3
   <usertools>
      <usertool display_name='Management Console' launch_script='management_console.au3' map_launch_type='profile'/>
   </usertools>

Note

Any protocol referenced in a <usertool> tag MUST have a corresponding <access> tag referencing that protocol. Any <usertool> element that uses a launch_script, does not need a corresponding access definition.

Parent Tags

Child Tags

  • None