Resource Registry syntax summary

This is the syntax that is used with the Resource Registry utility command.

Use the ResourceRegistryHelper.bat utility command on Windows systems or the ResourceRegistryHelper.sh on UNIX systems to update resources and virtual servers in resource name (.mrn) files. The command returns 0 if the update is successful, and 1 if it is not successful. It is a batch operation that you can use for automation.

To display help for the command, enter ResourceRegistryHelper.bat at the command line prompt in the IBM Transformation Extender installation directory.

The options in the Resource Registry utility command are not case-sensitive.


resourceregistryhelper.bat [path/file_name.mrn  
  -A {  ADD    {-R resource name | -S virtual server name}
      | REMOVE {-R resource name | -S virtual server name}
      | MODIFY {-R resource_name | -S virtual_server_name | -R resource_name -S virtual_server_name}
                -V value               		
               [-E [-KEYFILE keyfile_path [-KEYID keyID | -P passphrase]]]
      | -CK    [-E [-KEYFILE keyfile_path [-KEYID keyID | -P passphrase]]]]}

The command is shown in railroad track format below:

Read syntax diagramSkip visual syntax diagram resourceregistryhelper.bat path/file_name.mrn -A ADD-Rresource_name-Sserver_nameREMOVE-Rresource_name-Sserver_nameMODIFY-Rresource_name-Sserver_name-Sserver_name-Rresource_name-Vvalue-E-KEYFILEkeyfile_name-KEYIDkey_ID-Ppassphrase-CK-KEYFILEkeyfile_name-KEYIDkey_ID-Ppassphrase
Keyword
Description
-A
The action (-A) option of the Resource Registry utility command indicates the action (MODIFY, ADD or REMOVE) to perform on a specified resource or virtual server in the resource name file (.mrn) file.
ADD
Adds a specified resource or virtual server to the resource name (.mrn) file.
REMOVE
Removes a specified resource or virtual server from the .mrn file.
MODIFY
Changes the value of a specified resource, virtual server, or both resource and virtual server in the .mrn file. The -V parameter is required with the MODIFY command.
  • If you specify only the resource name (-R), the command changes the value of that resource across all servers.
  • If you specify only the server name (-S), the command changes all of that server's resources to the new value.
  • If you specify both the resource name and the server name, the command changes the resource value only for the specified server.
-CK
Changes the master key that encrypts the values in the specified .mrn file to a different master key. You can specify an existing master key by using the -KEYID option, or generate a new master key with a custom passphrase or a random passphrase.
-R resource name
Specifies the name of the resource that you want to add, remove, or change.
-S virtual_server_name
Specifies the name of the virtual server that you want to add, remove, or change.
-V value
Specifies the new value of the resource or virtual server that you are changing.
-E
Encrypts the specified resource or virtual server value in the .mrn file. The -E option is valid only on the MODIFY command. When you omit the -E option, the resource or virtual server name is not encrypted. This is the default.
-KEYFILE keyfile_path
Specifies the name and path of the master key (.mkf) file, relative to the .mrn file. The .mkf file stores Resource Registry encryption keys. -KEYFILE is optional. If you omit it, the command uses the default itx.mkf file in the .mrn file directory as the source of existing master keys or to store a new master key.

To generate a new random master key, specify the -KEYFILE option without the -KEYID or the -P options.

-KEYID key_ID
The numeric identifier of an existing key that the MODIFY command is to use to encrypt a resource value. The key identifier is optional. If you do not specify the -KEYID option or the -P option, the command generates a new encryption key with a random passphrase. You cannot regenerate a key that was created with a random passphrase.
-P passphrase
A 32-byte passphrase that is to identify a new encryption key. Any character restrictions?The passphrase is optional. If you omit both the -KEYID option and the -P option, the command generates a new encryption key with a random passphrase. You cannot regenerate a key that was created with a random passphrase.