Test programs: Specifying Prosody Processor modules

There are three different ways in which a test program may let you specify a Prosody processor module:

• Programs which specify A single module on the command line - for example, cpumon.
• Programs which specify A list of modules on the command line - for example, locplay.
• By command while the test program is running - for example, tonedet.

A single module on the command line

Some test programs require you to specify a single Prosody processor. They use the -x option to specify a card and the -m option to specify a Prosody processor module on that card. The name of the card has this format:

1. A portion which specifies the type of Prosody card. This is:
   • s3 for Prosody S (v3)
   • x for Prosody X
2. A colon (:)
3. A portion specific to the type of Prosody
   • For Prosody S (v3) it is the Prosody S server address, optional port, and security key
   • For Prosody X it is the Prosody X card address and security key

For example, module 1 on the Prosody X card voipgw.example.com which has security key '2AGgcFm5' would be specified as -x x:voipgw.example.com/2AGgcFm5 -m 1.

A list of modules on the command line

Some test programs allow you to specify a list of Prosody processor modules. These programs use the -x option to specify the list of module specifications separated by commas. Each module specification consists of the name of a card (as would be used to specify A single module on the command line) followed by a list of numbers in square brackets, [], separated by comma. This list is a list of modules on that card. It may be omitted, in which case all modules on the card are used.

For example, the specification:

	-x x:10.202.163.63/mykey,x:1.2.3.4/hello[3]

assuming card 10.202.163.63 has four Prosody processor modules, specifies that these modules should be used:

1. Module 0 on card 10.202.163.63 using security key 'mykey'
2. Module 1 on card 10.202.163.63 using security key 'mykey'
3. Module 2 on card 10.202.163.63 using security key 'mykey'
4. Module 3 on card 10.202.163.63 using security key 'mykey'
5. Module 3 on Prosody X card 1.2.3.4 using security key 'hello'

By command while the test program is running

For test programs that implement a command to select a Prosody module, the method uses the m command as follows.

Initially, a module is specified with a full description like this:

	m+x:prosgw.example.com/2AGgcFm5[1]

The description is the same as would be used to specify a list of modules on the command line. When you specify a module like this, it is opened, subsequent commands refer to it until you select a different module, and it can later be referred to by number in a simpler way:

	m2

If your specification refers to more than one module, then all are opened, and the first one is selected. You can use the command m? to see the list of modules you have opened.

For example,

	m+x:prosgw.example.com/2AGgcFm5[3]
		selects module 3 on Prosody X card prosgw.example.com which has security key '2AGgcFm5'