Outbound Instruction Type - Login (L)

Must be the first instruction sent from the application after connecting to the relay. It is used to establish identity and confirm a proper login.

Required fields supplied by application

I: A universally unique string identifying the process. Multiple runs of the same application should have the same ID (I). If an application were to be shut down and restarted, the ID (I) should not change.

Optional parameters supplied by application

Optional parameters are used to provide metrics about the application.

PL: Used to supply a fully qualified java class name to an AMI relay plugin. The class must implement the com.vortex.agent.AmiPlugin interface

O: Used to supply options about the current session. The following options are available and can be used in conjunction by comma delimiting:

QUIET - AMI will not send any information back to the client (statuses, etc). Note execute commands (E) will still be send to the client
LOG - Force AMI relay to log data to / from this session (default file = AmiSession.log)
UNIX - Force AMI to not send \r on messages
WINDOWS - Force AMI to send \r on messages
TTY - teletype terminal (for UNIX) is for interactively working with AMI backend

Example

In the below example, we see the optional attributes APP, MEM and STAT are supplied to shed light on the application name, memory used and status. Note that string values are surrounded in quotes. The options are forcing ami to use UNIX formatting (no \r) and force logging at the ami relay.