The IP address of a connected venue being referenced. Not needed if -r is specified. When used, also requires port ID to be specified with -p.

The port number for a connected venue being referenced. Not needed if -r is specified. When used, also requires host IP address to be specified with -h.

destination is a 0-based integer destination ID for a venue being referenced. Not needed if -h and -p are both specified. Use listconnections to obtain destination IDs.

One or more arguments providing data appropriate to the command. The number and meaning of arguments varies among the commands. Do not repeat -a if providing more than one argument. The arguments themselves do not require quotes around them.

string designates a text file name to which the command output is written. Not all commands can write to a file. Some commands generate file names that include host and port identifiers followed by the string entered. Any existing file with the same name is overwritten. See the config command for more information about how the program constructs such filenames.

Disconnect from and then reconnect to the specified venue. Takes either 0 or 3 -a arguments. With no arguments, only one venue must be connected; if the FX adapter has multiple FX sessions, this command fails. The three -a arguments to identify a session are BeginString (FIX tag 8), SenderCompID (FIX tag 49), and TargetCompID (FIX tag 56). Bouncing an FX session does not reset destination numbers.

Example:

bounce -r 0 -a FIX.4.4 SENDER_ID TARGET_ID

Attempts to bounce the FX session specified by these parameters on the handler at connection 0. No output is returned if the operation succeeds, but you are notified if a valid connection is not specified.

Prints configuration key-value pairs in configuration file format for the connection described by a refnum or host and port. Use -f to pipe command output to a file, which can then be used as a configuration file. For example:

config -h 10.97.12.333 -p 11111 -f test.log

would create a file named 10.97.12.233_11111_test.log, in which the host and port identifiers are separated with an underscore, followed by an underscore and the provided file name.

Takes no arguments and returns the handler status, version info, and the venue name.

Example response:

Printing all current connections: 
--------------------------------- 
[0] : FXSpotStream Market Data [10.181.1.189:11109]
[1] : Deutsche Bank AutobahnFX Rapid FIX Market Data [10.181.1.189:11107] 
---------------------------------

Provides usage text about commands and their options, and arguments; and about addressing destinations.

Prints a list of all active connections to StreamBase FX Servers, including each server's Local Reference Number, IP Address, and Port. The numbers returned in the first column are destination references; provide a reference number returned from this command to the config, logs, snapshot, bounce, and unsubscribe commands with the -r option. Without a -r option (or -h and -p) options, those commands act on all current subscriptions.

Example response:

Printing all current connections:
---------------------------------
[0] : Deutsche Bank AutobahnFX Rapid FIX Market Data [10.97.233.40:11107]
[1] : FXSpotStream Market Data [10.97.233.40:11109]
---------------------------------

Returns a list of paths to log files for the FX Adapter for the connection at destination refnum or port id at host ip. For example:

logs -h 10.97.12.333 -p 11111

or

logs -r 0

Causes the client to ping the multicast group to update the connection list with any new FX servers and to remove dead connections. This command is automatically called by the client every 5 seconds, and can also be issued manually (without affecting the periodic pinging).

The ping command produces no output. Use listconnections to identify current group members.

Exits the sb-trading-components-admin utility, asking for confirmation first. You can also type Ctrl+C (or Ctrl+D on Linux or OS X) to exit immediately.

Takes a reference number or a host-port pair and one -a argument, the Subscription ID, for which to take a snapshot. Requires the option and that argument. Obtain subscription IDs with the listconnections command. Thus, snapshot -r 0 Is an invalid command, since it fails to provide the requisite subscriptionID.

Example:

snapshot -r 0 -a R-1-1403640896972

Retrieves a snapshot of the subscription with subscriptionID R-1-1403640896972. The first few lines of a typical response follow:

#Response from: FXSpotStream [10.181.1.189:11109]
# Operation SUCCEEDED
# Message:
# Snapshot query returned 2 quotes
[0]:
Subscription ID: R-1-1403640896972
MsgSeqNum: 10
Instrument:
Instrument Type: SPOT
Currency 1: EUR
Currency 2: USD
Settlement Date:
Settlement Date Far:
Tenor:
Tenor Far:
Venue Name: FXSpotStream
Quote ID: Q-5-1403640896991MSB
...

Interactively subscribes to a venue, specifying the same thirteen fields as the initial subscription file. It returns a status and message, which reports only on the success or failure of the submission of the command. If the handler rejects the request, it will not be reported by this response.

All thirteen arguments must be provided in the following order:

Expects all thirteen values. Use null in place of any values which you do not want to specify.

Example:

subscribe -r 0 -a SPOT EUR USD null null null null null 0 null null null null

Possible response:

#Response from: FXSpotStream [10.181.1.189:11109]
# Operation SUCCEEDED
# Message:
# Sent SUBSCRIBE R-1-1403702057539 request to handler

Lists subscriptions to FX venues. Takes 0, 1, or 2 -a arguments:

If used, the cur1 and cur2 arguments are specified as standard three-character currency codes.

Examples:

subs

Sends a request to list all active subscriptions

subs -a USA

Sends a request to list all subscriptions whose Currency1 or Currency2 value is USA.

subs -a USA EUR

Sends a request to list all subscriptions whose Instrument's Currency1 and Currency2 values are USA and EUR (order is irrelevant). A typical response:

#Response from: FXSpotStream [10.181.1.189:11109]
# Operation SUCCEEDED
# Message:
# Subscription query returned 1 subscriptions
[0]:
Subscription ID: R-1-1403640896972
MD Req ID: R-1-1403640896972
Instrument:
Instrument Type: SPOT
Currency 1: EUR
Currency 2: USD
Settlement Date:
Settlement Date Far:
Tenor:
Tenor Far:
Side: BOTH
Market Depth: 0
Quantity:
Quantity Far:
Currency:
Duration:
Expiration:
Pending Unsubscribe Timeout:

Unsubscribes from a venue. Takes one required argument, the subscription ID to unsubscribe from. Returns a status and a message reporting whether the submission was successful. The response does not indicate whether or not the handler rejected the request. Use the subscriptions command to verify the outcome.

Example:

unsubscribe -r 0 -a R-1-1372341719901

Sends an unsubscribe command for the subscription whose subscriptionID is R-1-1372341719901. Possible response:

#Response from: FXSpotStream [10.181.1.189:11109]
# Operation SUCCEEDED
# Message:
# Sent UNSUBSCRIBE R-1-1372341719901 request to handler

(String) — The TCP port used to communicate back to the FX admin client tool.

(int) — The UDP port used to listen for ping requests to enable the FX admin client tool to find all the handlers.

(int) — The UDP port used to write back the ping response to enable the FX admin client tool to find all the handlers.

(String) — The multicast address used to communicate with the FX admin client tool.

(String, "Enabled" or "Disabled") — Determines whether the venue handler opens the socket connections required by the FX admin client tool.