Wiretap path translation

Wiretap path translation converts the syntax of a file path referred by a Wiretap server running on a Linux workstation to a format the client can understand. It allows Wiretap clients to understand file paths that are referenced by an Autodesk Creative Finishing product to clips that have been soft-imported from a NAS, SAN, or any remote mounted storage.

Configure the path translation database

/usr/discreet/wiretap/cfg/wiretap_path_translation_db.xml contains a set of rules that specify how to convert (translate) a file path referred to by a source workstation (the host running the Wiretap server) into a path that the client can understand. To configure:

  1. Open /usr/discreet/wiretap/cfg/sw_wiretap_path_translation_db.xml for editing and create the rules for translating the file path. The rules are applied in the order they appear in the file. The first rule is applied. If that rule matches, then the translation is complete. If the rule doesn't match, the next rule is examined. If the network includes groups of hosts that mount their storage using the same syntax, it may be possible to use a group or platform rule to translate the syntax for all similar hosts. If, however, all hosts use different syntax and mount points for their storage, a host/path rule is needed for each source and destination host.
  2. Save the file. Stone and Wire do not have to be restarted to apply changes in the path translation database. The Wiretap server periodically checks the timestamp of the file and, if there are changes, it updates itself accordingly. To test the changes, restart Stone and Wire manually: /etc/init.d/stone+wire restart.

Respect XML syntax when editing the path translation file, for example reserved characters.

Creating a rule for host-to-host translation

Create a host/path rule to translate the path syntax used by the source workstation (the workstation running the Wiretap server) to the path syntax used by the destination workstation. The syntax is:
<map src_host=”<src_host>” src_path=”<src_path>”
dst_host=”<dst_host>” dst_path=”<dst_path>” 

Enter values as follows:

src_host
The host name or IP address of the workstation to which a client connects. If you create a group rule for source workstations, the value of this attribute can be the group name.
src_path
The host name or IP address of the workstation to which a client connects. If you create a group rule for source workstations, the value of this attribute can be the group name.
dst_host
The host name or IP address of the client that mounts the same storage referred to by the source, using a different syntax. If you create a group rule for destination workstations, the value of this attribute can be the group name.
dst_path
The path to the remote storage as referred to by the destination host (or hosts, when mapping a group).

Example:

<map src_host=“flame1”   src_path=“/CXFS1”
dst_host=“windows1” dst_path=“N:\”>

Create a rule for groups of hosts

Use the group rule when you have several workstations that use the same rule to convert the path syntax of a single source or group of source workstations. This rule is effective in larger installations where numerous workstations mount storage using identical syntax. All hosts in a group rule must mount directories using exactly the same syntax. Group names must be unique and must not conflict with host names or platform names. The syntax of the group rule is as follows:

<group name=”<group_name>” os=”<os_name>”>
 [<host name=”<host_name>”>]
</group>
group name
Identifies the name of the group. Create a group name of your choosing. Each group name must be unique. Use the value of this attribute in a host-to-host rule to map all members of the group to the same storage mount point.
host name
Identifies the name of a host that is in the group.
os
Optional. Allows all of the hosts in the group to be linked to a single OS. A platform rule can then be used to map all the hosts in a group to the same mount point. The os attribute is restricted to the following values: Linux, Windows NT, and MacOSX.

Once a group is defined, use the host/path rule to map all the hosts in the group to the same path by using the group name for either the src_host or dst_host attribute value. In the following example, all hosts in the Lustre_Windows_Stations group map the Autodesk_Stations storage path to N:\myclips, a mount point they all share:

 <map src_host=“Autodesk_Stations” src_path=“/CXFS1/myclips
dst_host=“Lustre_Windows_Stations” dst_path=“N:\myclips”>

Use a platform rule to map all the hosts in a group to the same destination path based on the operating system they all run. In the following example, the platform rule is used to map all Windows users to N:\ when translating /usr/ from a Linux system:

 <map src_os=“Linux”      src_path=“/usr/”
dst_os=“WindowsNT”  dst_path=“N:\”>

Create a rule for a group of hosts on the same OS

The platform rule is similar to the group rule in that the rule is applied to all hosts running the same operating system. All hosts running the same operating system must mount directories using exactly the same syntax. For example, all Windows workstations must mount the NAS on the N:\ mount point to use the same path translation rule for the NAS. Platform names must be unique and must not conflict with host names or group names. The syntax is:

<map src_os=“<src_os>” src_path=“<src_path> ”
dst_os=“<dst_os>” dst_path=“<dst_path>”>

Each attribute must have a value. See the following table for a description of the valid values for each attribute. The src_os and dst_os attributes are restricted to the following values: Linux, WindowsNT, and MacOSX.

src_os
The operating system of the workstation to which a client connects.
src_path
The path to the remote storage as referred to by all hosts using the same operating system.
dst_os
The operating system of the client that mounts the same storage referred to by the source.
dst_path
The path to the remote storage as referred to by the hosts running the destination operating system.

Example:

 <map src_os=“Linux”      src_path=“/usr/”
dst_os=“WindowsNT”  dst_path=“N:\”>

Share the database among multiple Wiretap servers

If there are many Wiretap servers, path translation database must be updated on each server every time there is a change to the network configuration. To simplify the management of the database, create a symbolic link from the path translation file on all hosts running the Wiretap server to one machine that contains the actual file.

Test the path translation database

The /usr/discreet/wiretap/tools/2016/wiretap_translate_path command verifies that a path requested from the Wiretap server on the local machine can be translated into a path that can be understood by the client machine. Enter the command for syntax.