### Start SIP Client Correlation

Source: https://gull.sourceforge.net/doc/sip.html

Execute this command in Terminal 1 to start the SIP client for the correlation example.

```bash
./start_client_corr.ksh
```

--------------------------------

### Start SIP Server Correlation 1

Source: https://gull.sourceforge.net/doc/sip.html

Execute this command in Terminal 2 to start the first SIP server (server_1) for the correlation example.

```bash
./start_server_corr_1.ksh
```

--------------------------------

### Start SIP Server Correlation 2

Source: https://gull.sourceforge.net/doc/sip.html

Execute this command in Terminal 3 to start the second SIP server (server_2) for the correlation example.

```bash
./start_server_corr_2.ksh
```

--------------------------------

### Start Seagull Client with Multiple Dictionaries

Source: https://gull.sourceforge.net/doc/sync.html

Launches the Seagull client, allowing for two dictionaries: one for a specific protocol and another for the synchronization library. Includes an example of setting the library path.

```bash
#!/bin/ksh
export LD_LIBRARY_PATH=/usr/local/bin
seagull -conf ../config/conf.client.xml -dico ../config/[protocol-dictionary].xml ../config/synchro-dictionary.xml -scen ../scenario/client.xml -log ../logs/client.log -llevel ET>
```

--------------------------------

### Navigate to Seagull Run Directory

Source: https://gull.sourceforge.net/doc/radius.html

Change directory to the 'run' folder where Seagull examples and scripts are located. This is a prerequisite for starting the server or client.

```bash
cd run
```

--------------------------------

### computestat.ksh Output Example

Source: https://gull.sourceforge.net/doc/core.html

Example output from computestat.ksh showing various statistical measures computed from input data.

```text
[Using file        : client-rtt.2004-12-02.11:11:01.016.csv.y]
[number values     : 23136]
[minimum value     : 1.267000]
[maximum value     : 29.074000]
[average value     : 3.321995]
[variance          : 0.803202]
[standard deviation: 0.896216]
[95th percentile   : 5.410000]
```

--------------------------------

### Start Seagull Radius Server

Source: https://gull.sourceforge.net/doc/radius.html

Execute the server start script in Terminal 2. This command initiates the Radius server process.

```bash
./start_server.ksh
```

--------------------------------

### Start Timer

Source: https://gull.sourceforge.net/doc/core.html

Starts a timer used for collecting response time statistics.

```XML
<start-timer></start-timer>
```

--------------------------------

### Generic Configuration XML Example

Source: https://gull.sourceforge.net/doc/core.html

Example of a generic configuration file in XML format, defining a transport entity for TCP connections. This describes network environment and traffic parameters.

```xml
<!-- Synchro example -->
<?xml version="1.0" encoding="ISO-8859-1"?>
<configuration name="Simple IP Server Conf">

<define entity="transport"
    name="trans-ip-v4"
    file="libtrans_ip.so"
    create_function="create_cipio_instance"
    delete_function="delete_cipio_instance"
    init-args="type=tcp">
  </define>
<!-- Then you specify the opening of the channel, on the transport previously described. -->
```

--------------------------------

### Install Seagull Protocol on HPUX

Source: https://gull.sourceforge.net/doc/core.html

Use the swinstall command to install a specific Seagull protocol package on HPUX 11i/11.23.

```bash
swinstall -s /full_path_to_the_depot/seagull-[protocol]-[tool version]-[OS]-[OS release version]-[processor].depot
```

--------------------------------

### Install Seagull Core on HPUX

Source: https://gull.sourceforge.net/doc/core.html

Use the swinstall command to install the Seagull core package on HPUX 11i/11.23.

```bash
swinstall -s /full_path_to_the_depot/seagull-core-[tool version]-[OS]-[OS release version]-[processor].depot
```

--------------------------------

### Protocol Statistics Screen Example

Source: https://gull.sourceforge.net/doc/core.html

This example illustrates the format of the protocol statistics screen, showing periodic and cumulative values for sent and received messages categorized by protocol primitive.

```text
|--------------------------------+---------------------+-----------------------|
|                                |  Periodic value     |   Cumulative value    |
| primitive                      |     sent | received |      sent |  received |
|--------------------------------+---------------------+-----------------------|
| MGT                            |        0 |        0 |         0 |         0 |
```

--------------------------------

### Start Seagull Radius Client

Source: https://gull.sourceforge.net/doc/radius.html

Execute the client start script in Terminal 1. This command initiates the Radius client process to interact with the server.

```bash
./start_client.ksh
```

--------------------------------

### Commented H248 Client Scenario (XML)

Source: https://gull.sourceforge.net/doc/h248.html

A commented H248 client scenario in XML format, demonstrating both short and pretty H248 forms. This example includes scenario setup, counters, and traffic definitions.

```xml
<?xml version="1.0" encoding="ISO-8859-1" ?>
<scenario>

  <counter>
    <counterdef name="transaction-counter" init="999">
    </counterdef>
  </counter>

  <traffic>

```

--------------------------------

### Install Seagull Core on Linux (RedHat/Fedora)

Source: https://gull.sourceforge.net/doc/core.html

Use the rpm command to install the Seagull core package on Linux RedHat-new and Fedora core 3.

```bash
rpm -ivh seagull-core-[tool version]-[OS]-[OS release version]-[processor].rpm
```

--------------------------------

### Start Seagull Client with Synchro Lib

Source: https://gull.sourceforge.net/doc/sync.html

Launches the Seagull client with specified configuration, dictionary, scenario, and log settings. This is a basic command for initiating a client session that utilizes the synchro library.

```bash
seagull -conf ../config/conf.client.xml -dico ../config/synchro-dictionary.xml 
-scen ../scenario/client.xml -log ../logs/client.log -llevel ET
```

--------------------------------

### Synchronization Command with Parameters

Source: https://gull.sourceforge.net/doc/sync.html

Example of sending a synchronization command with parameters, including restoring values from external files and previous messages.

```xml
<send channel="channel-1">
  <action>
     <inc-counter name="session-counter"></inc-counter>
     <set-value name="user-id-1" 
                format="$(session-counter)"></set-value>
     <restore-from-external field="1" entity="field-bin-1-data"
       begin="1" end="3"></restore-from-external>
     <restore name="PARAM" entity="field-bin-2-data"></restore>
  </action>
  <command-synchro name="CMD_CALLCREATE">
    <parameter name="field-bin-2-data" value="1234"> </parameter>
  </command-synchro>
  <action>
    <store name="SESSION-ID" entity="user-id-1"></store> 
  </action>
</send>
```

--------------------------------

### Install Seagull Protocol on Linux (RedHat/Fedora)

Source: https://gull.sourceforge.net/doc/core.html

Use the rpm command to install a specific Seagull protocol package on Linux RedHat-new and Fedora core 3.

```bash
rpm -ivh seagull-[protocol]-[tool version]-[OS]-[OS release version]-[processor].rpm
```

--------------------------------

### Radius Accounting Request/Response Scenario

Source: https://gull.sourceforge.net/doc/radius.html

Illustrates a typical Radius accounting flow with start and stop requests. This scenario is included with Seagull installation.

```text
   
  Client                         Server
    | Accounting-Request            |
    | Acct-Status-Type = 1 (start)  |
    |------------------------------>|
    |                               |
    | Accounting-Response           |
    | Acct-Status-Type = 1          |
    |<------------------------------|
    |                               |
    | PAUSE                         |
    |                               |
    | Accounting-Request            |
    | Acct-Status-Type = 2 (stop)   |
    |------------------------------>|  
    | Accounting-Response           |
    | Acct-Status-Type = 2          |
    |<------------------------------|

```

--------------------------------

### TCAP Server Output Example

Source: https://gull.sourceforge.net/doc/octcap.html

This is an example of the output displayed on the TCAP server's terminal after starting and potentially handling traffic. It shows statistics like elapsed time, call rates, and message counts.

```text
|------------------------+---------------------------+-------------------------|
| Start/Current Time     |       2005-12-14 10:04:11 |     2005-12-14 10:06:53 |
|------------------------+---------------------------+-------------------------|
|       Counter Name        |      Periodic value       |     Cumulative value    |
|------------------------+---------------------------+-------------------------|
| Elapsed Time           | 00:00:01:008              | 00:02:41:596            |
| Call rate (/s)         |   75.397                  |   41.505                |
|------------------------+---------------------------+-------------------------|
| Incoming calls         |       76                  |     6707                |
| Outgoing calls         |        0                  |        0                |
| Msg Recv/s             |  149.802                  |   82.985                |
| Msg Sent/s             |  149.802                  |   82.979                |
| Unexpected msg         |        0                  |        0                |
| Current calls          |        3                  |    0.019                |
|------------------------+---------------------------+-------------------------|
| Successful calls       |       75                  |     6704                |
| Failed calls           |        0                  |        0                |
| Refused calls          |        0                  |        0                |
| Aborted calls          |        0                  |        0                |
| Timeout calls          |        0                  |        0                |
|------------------------+---------------------------+-------------------------|
| Last Info              | Incomming traffic                                   |
| Last Error             | No error                                            |
|--- Next screen : Press key 1 ----------------------- [h]: Display help ------|
```

--------------------------------

### Install Seagull Core on Linux (Debian)

Source: https://gull.sourceforge.net/doc/core.html

Use the dpkg command to install the Seagull core package on Linux Debian.

```bash
dpkg -i seagull-core-[tool version]-[OS]-[OS release version]-[processor].deb
```

--------------------------------

### Install Seagull Protocol on Linux (Debian)

Source: https://gull.sourceforge.net/doc/core.html

Use the dpkg command to install a specific Seagull protocol package on Linux Debian.

```bash
dpkg -i seagull-[protocol]-[tool version]-[OS]-[OS release version]-[processor].deb
```

--------------------------------

### Synchronization Scenario Script

Source: https://gull.sourceforge.net/doc/sync.html

An example XML scenario script for synchronization, including initialization, traffic, and command definitions.

```xml
<?xml version="1.0" encoding="ISO-8859-1" ?>
<scenario>

<counter>
  <counterdef name="session-counter" init="0"> </counterdef>
</counter>

<init>
   <send channel="channel-1">
     <command-synchro name="CMD_INITSYNCHRO">
     </command-synchro>
   </send>
   <receive channel="channel-1">
     <command-synchro name="CMD_INITSYNCHRO">
     </command-synchro>
   </receive>
</init>

<traffic>
   <send channel="channel-1">
     <action>
        <inc-counter name="session-counter"></inc-counter>
        <set-value name="user-id-1" 
                   format="$(session-counter)"></set-value>
     </action>
     <command-synchro name="CMD_CALLCREATE">
     </command-synchro>
     <action>
       <store name="SESSION-ID" entity="user-id-1"></store> 
     </action>
   </send>
   <receive channel="channel-1">
     <command-synchro name="CMD_CALLCREATE">
     </command-synchro>
   </receive>
</traffic>

</scenario>
```

--------------------------------

### Define Binary Protocol Header

Source: https://gull.sourceforge.net/doc/core.html

Example of defining a message header for a binary protocol, including fields for length and message type, and specifying where length calculation should start.

```xml
<header name="Message" length="msg-length" type="message-type">
    <fielddef name="some-field1" size="4" unit="octet"></fielddef>
    <start-length/>
    <fielddef name="msg-length" size="2" unit="octet"></fielddef>
    <fielddef name="message-type" size="4" unit="octet"></fielddef>
</header>
```

--------------------------------

### Seagull Radius Server Output Example

Source: https://gull.sourceforge.net/doc/radius.html

Example output displayed on the server terminal during Radius client interaction. It shows statistics like elapsed time, call rates, and message counts.

```text
|------------------------+---------------------------+-------------------------|
| Start/Current Time     |       2007-07-18 14:37:43 |     2007-07-18 14:38:13 |
|------------------------+---------------------------+-------------------------|
|    Counter Name        |      Periodic value       |     Cumulative value    |
|------------------------+---------------------------+-------------------------|
| Elapsed Time           | 00:00:01:009              | 00:00:30:300            |
| Call rate (/s)         |    0.991                  |    0.132                |
|------------------------+---------------------------+-------------------------|
| Incoming calls         |        1                  |        4                |
| Outgoing calls         |        0                  |        0                |
| Msg Recv/s             |    2.973                  |    0.231                |
| Msg Sent/s             |    2.973                  |    0.231                |
| Unexpected msg         |        0                  |        0                |
| Current calls          |        1                  |    0.033                |
|------------------------+---------------------------+-------------------------|
| Successful calls       |        2                  |        3                |
| Failed calls           |        0                  |        0                |
| Refused calls          |        0                  |        0                |
| Aborted calls          |        0                  |        0                |
| Timeout calls          |        0                  |        0                |
|------------------------+---------------------------+-------------------------|
| Last Info              | Incomming traffic                                   |
| Last Error             | No error                                            |
|--- Next screen : Press key 1 ----------------------- [h]: Display help ------|
        
```

--------------------------------

### Use Configuration Parameters in SIP Message

Source: https://gull.sourceforge.net/doc/core.html

Demonstrates how to restore the values of defined configuration parameters within a message, using the $(parameter_name) syntax. This example shows usage within a SIP INVITE message.

```xml
<message>
  <![CDATA[INVITE sip:**$(service)**@**$(param_ip)** SIP/2.0
      Via: SIP/2.0/UDP north.east.isi.edu
      From: Mark Handley <sip:mjh@isi.edu>
      To: Eve Schooler <sip:schooler@caltech.edu>
      Call-ID: 2963313058@north.east.isi.edu
      CSeq: 1 INVITE
      Subject: SIP will be discussed, too
      Content-Type: application/sdp
      Content-Length: 187 ]] >
</message>
```

--------------------------------

### Global Statistics CSV Example

Source: https://gull.sourceforge.net/doc/core.html

This example shows the format of a global statistics file generated by Seagull. It includes various counters such as StartTime, LastResetTime, CurrentTime, ElapsedTime, Rate, and IncomingCall, with periodic and cumulative values.

```csv
StartTime;LastResetTime;CurrentTime;ElapsedTime(P);ElapsedTime(C);Rate(P);Rate(C);IncomingCall(P);IncomingCall(C);
2004-12-02 11:11:01;2004-12-02 11:11:01;2004-12-02 11:11:01;00:00:00;00:00:00;111.111;111.111;0;0;
2004-12-02 11:11:01;2004-12-02 11:11:05;2004-12-02 11:11:06;00:00:05;00:00:05;40.7837;40.9018;0;0;
2004-12-02 11:11:01;2004-12-02 11:11:10;2004-12-02 11:11:11;00:00:05;00:00:10;50.9287;45.9128;0;0;
2004-12-02 11:11:01;2004-12-02 11:11:15;2004-12-02 11:11:16;00:00:05;00:00:15;50.729;47.5145;0;0;
2004-12-02 11:11:01;2004-12-02 11:11:20;2004-12-02 11:11:21;00:00:05;00:00:20;50.729;48.3179;0;0;
2004-12-02 11:11:01;2004-12-02 11:11:25;2004-12-02 11:11:26;00:00:05;00:00:25;50.9287;48.838;0;0;
2004-12-02 11:11:01;2004-12-02 11:11:30;2004-12-02 11:11:31;00:00:05;00:00:30;50.729;49.153;0;0;
          
```

--------------------------------

### Define Configuration Parameters

Source: https://gull.sourceforge.net/doc/core.html

Sets configuration parameters within the configuration file, which can then be used in scenarios. Examples show defining a parameter for IP address and a service name.

```xml
<define entity="config-param"  name="**param_ip**" value="127.0.0.1"></define>
```

```xml
<define entity="config-param"  name="**service**"  value="schooler"></define>
```

--------------------------------

### Diameter Presence Check Example

Source: https://gull.sourceforge.net/doc/core.html

Example of a presence check for the Diameter protocol within a receive command. The check-presence action must be defined in the post-action section.

```xml
<receive channel="channel-1">
  <command name="SAA">
  </command>
  <action>
    <check-presence name="name_of_avp_to_check" behaviour="error"></check-presence>
  </action>
</receive>
```

--------------------------------

### External Data File Example

Source: https://gull.sourceforge.net/doc/core.html

An example of an external CSV data file, including data type definitions, comments, and data rows with string and number values.

```csv
 "string";"string";"number";
# FIELD 0        FIELD 1       FIELD 2    
"0472826017" ;  "0x214365870921" ; "10" ;
"0472826027" ;  "0x214365870931" ; "12" ;
"0472826037" ;  "0x214365870941" ; "14" ;
"0472826047" ;  "0x214365870951" ; "16" ;
"0472826057" ;  "0x214365870961" ; "18" ;
"0472826067" ;  "0x214365870971" ; "20" ;
"0472826077" ;  "0x214365870981" ; "22" ;
```

--------------------------------

### Branching on Parameter Value (SIP)

Source: https://gull.sourceforge.net/doc/core.html

Example demonstrating branching based on a parameter's value for the SIP protocol. 'branch_on' specifies the value to match, and 'look_ahead' or 'look_back' control the jump in the scenario.

```xml
<!-- SIP example-->
<check-value behaviour="error" branch_on="100" look_ahead="2">
</check-value>
```

--------------------------------

### Seagull Binaries Directory Listing

Source: https://gull.sourceforge.net/doc/core.html

Lists the Seagull binaries and library files installed in the /usr/local/bin directory.

```bash
/usr/local/bin/
     seagull
     computestat.ksh
     plotstat.ksh
     startoctave_plot.ksh
     startoctave_stat.ksh
     csvextract
     csvsplit
     [library-files].so
```

--------------------------------

### Start TCAP Client (ITU)

Source: https://gull.sourceforge.net/doc/octcap.html

Execute the script to start the TCAP client using the ITU configuration. This script is typically run in a separate terminal session to interact with the server.

```shell
./start_client_itu.ksh
```

--------------------------------

### Start TCAP Server (ITU)

Source: https://gull.sourceforge.net/doc/octcap.html

Execute the script to start the TCAP server using the ITU configuration. This script is typically run in a separate terminal session.

```shell
./start_server_itu.ksh
```

--------------------------------

### Verify Seagull Installation

Source: https://gull.sourceforge.net/doc/core.html

Checks if the 'seagull' executable is in the system's PATH.

```bash
ocadmin@myhost:~$ type seagull
seagull is /usr/local/bin/seagull
```

--------------------------------

### Store Parameter Action

Source: https://gull.sourceforge.net/doc/core.html

Example of using a post-action within a <receive> command to store a received session ID into a call variable.

```xml
<receive channel="channel-1">
  <message name="FOO_BAR">
  </message>
  <action>
    <store name="SESSION-ID" entity="user-id-1"></store> 
  </action>
</receive>
```

--------------------------------

### Log Level Configuration Example

Source: https://gull.sourceforge.net/doc/core.html

Configure Seagull's logging levels using the -llevel option. Multiple levels can be combined, but 'A' and 'N' are exclusive. Time-stamping can be disabled with -notimelog.

```bash
-llevel EWT will log Errors, Warnings and Traffic events.
```

--------------------------------

### Timer Management in Scenarios

Source: https://gull.sourceforge.net/doc/core.html

When managing response time statistics, ensure timers are not imbricated. Always stop a timer before starting a new one.

```xml
<start-timer>
...
<stop-timer>
...
<start-timer>
...
<stop-timer>
```

--------------------------------

### Increment Counter and Set Value Actions

Source: https://gull.sourceforge.net/doc/core.html

Example of using pre-actions within a <send> command to increment a session counter and set a user ID based on that counter.

```xml
<send channel="channel-1">
  <action>
    <inc-counter name="session-counter"></inc-counter>
    <set-value name="user-id-1" format="$(session-counter)"></set-value>
  </action>
  <message name="FOO_BAR">
  </message>
</send>
```

--------------------------------

### Field Definition Example (OCTCAP Protocol)

Source: https://gull.sourceforge.net/doc/core.html

Defines a field with specific attributes for the OCTCAP protocol, including its name, type, and associated get/set functions.

```xml
<fielddef name="uid"  type="number"
          set-function="set_primitive_uid"
          get-function="get_primitive_uid">
</fielddef>
```

--------------------------------

### Radius Pre-Action: Increment Counters and Set Values

Source: https://gull.sourceforge.net/doc/radius.html

Example of pre-action commands for Radius messages, including incrementing session and identifier counters, and setting values using formatted strings.

```xml
<send channel="trans-ip-v4">
  <action>
    <!-- For each new call, increment the Acct-Session-Id counter -->
    <inc-counter name="session-counter"> </inc-counter>
    <inc-counter name="identifier-counter"> </inc-counter>
    <set-value name="Acct-Session-Id" 
               format="$(session-counter)"></set-value>
    <set-value name="Identifier" 
               format="$(identifier-counter)"></set-value>

    <!-- This field must not be use with a true value -->
    <restore-from-external field="0" entity="Authenticator"></restore-from-external> 

  </action>
```

--------------------------------

### TCAP Pre-actions for Sending Messages

Source: https://gull.sourceforge.net/doc/octcap.html

Example of pre-actions within a TCAP <send> command. Used to set values or fields before a message is sent.

```xml
<send channel="channel-1">
    <action>
       <set-value name="uid" format="$(client-uid-counter)"></set-value>
       <restore-from-external field="1" entity="TC_INVOKE" sub-entity="operation-data"
                        begin="5" end="10"></restore-from-external>
    </action>
```

--------------------------------

### SIP External Data File Format

Source: https://gull.sourceforge.net/doc/sip.html

This is an example of the format for an external data file used in SIP communication. It shows fields like 'string' for identifiers and SIP-related information.

```text
"string" ; "string"                                                                                                   ; "string" ; "string"             ; "string"                             ; "string"                             ; "string" ;
    "joe"    ; "Digest realm=\"cosims.net\", nonce=\"b8d2v9ZxfE3VHg6ZD3P87Wo1mfth4BBArn7VFQlWWR4=\", algorithm=AKAv1-MD5" ; "INVITE" ; "sip:127.0.0.1:5061" ; "0xCDC2458FEB3E20F62B6D676AC72CB318" ; "0x465B5CE8B199B4BA48D2B72EE238A6BC" ; "0xB9A3" ;
    "xxxxxx" ; "Digest xxxxxxxx"                                                                                        " ; "XXXXXX" ; "xxxxxxxxxxxxxxxxxx" ; "0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" ; "0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA" ; "0xAAAA" ;
    ...
    ...
    
    

```

--------------------------------

### SIP Call Flow Diagram

Source: https://gull.sourceforge.net/doc/sip.html

This diagram illustrates the call flow for a SIP correlation example between a client and two servers. It shows the sequence of messages like INVITE, 180 Ringing, 200 OK, and ACK.

```text
   


  CLIENT                SERVER_1              SERVER_2
    |(1) INVITE            
    |--------------------->|
    |(2) 180 Ringing       |
    |<---------------------|
    |(3) 200 OK            |
    |<---------------------|
    |(4) ACK               |
    |--------------------->|
                           |
                           |(5) INVITE 
                           |--------------------->|
                           |(6) 180 Ringing       |
                           |<---------------------|
                           |(7) 200 OK            |
                           |<---------------------|
                           |(8) ACK               |
                           |--------------------->|
                                                  |
     (9)  INVITE                                  |
    |<--------------------------------------------|
    |(10) 180 Ringing                             |
    |<--------------------------------------------|
    |(11) 200 OK                                  |
    |<--------------------------------------------|
    |(12) ACK                                     |
    |---------------------------------------------|
    |                                             
    |(13) PAUSE                                    
    |                                             
    |(14) BYE                                     |
    |-------------------------------------------->|
    |(15) 200 OK                                  |
    |<--------------------------------------------|
    |                                             
    |(16) BYE              |
    |--------------------->|
    |(17) 200 OK           |
    |<---------------------|


```

--------------------------------

### Scenario Statistics Example

Source: https://gull.sourceforge.net/doc/core.html

This table illustrates scenario statistics for a TCAP execution, showing message counts, retransmissions, timeouts, and unexpected events for different scenario types.

```text
|--------------------------+-------------------------+-------------------------|
|                          | Messages   | Retrans    | Timeout    | Unexp.     |
|             TC_BEGIN <-- |      20702 |          0 |          0 |          0 |
|          TC_CONTINUE --> |      20702 |          0 |          0 |          0 |
|          TC_CONTINUE <-- |      20699 |          0 |          0 |          0 |
|               TC_END --> |      20699 |          0 |          0 |          0 |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|                          |                         |                         |                         |
|--------------------------+-------------------------+-------------------------|
```

--------------------------------

### Send Command for Open ID Channel

Source: https://gull.sourceforge.net/doc/core.html

Example of a send command for a channel configured with the open ID feature. The 'label' attribute links to the correlation command, and the 'open' action establishes the connection.

```xml
<send channel="channel-2" label="command-2">
      <action>
        <open args="mode=client;dest=127.0.0.1:8080"></open>
      </action>
      <message> 
      ...</message>
```

--------------------------------

### Diameter Server Statistics

Source: https://gull.sourceforge.net/doc/diameter.html

Example output from the Diameter server terminal, showing statistics like elapsed time, call rate, incoming/outgoing calls, and message counts. This output is displayed when the server is running.

```text
|------------------------+---------------------------+-------------------------|
| Start/Current Time     |       2005-12-14 10:04:11 |     2005-12-14 10:06:53 |
|------------------------+---------------------------+-------------------------|
|    Counter Name        |      Periodic value       |     Cumulative value    |
|------------------------+---------------------------+-------------------------|
| Elapsed Time           | 00:00:01:008              | 00:02:41:596            |
| Call rate (/s)         |   75.397                  |   41.505                |
|------------------------+---------------------------+-------------------------|
| Incoming calls         |       76                  |     6707                |
| Outgoing calls         |        0                  |        0                |
| Msg Recv/s             |  149.802                  |   82.985                |
| Msg Sent/s             |  149.802                  |   82.979                |
| Unexpected msg         |        0                  |        0                |
| Current calls          |        3                  |    0.019                |
|------------------------+---------------------------+-------------------------|
| Successful calls       |       75                  |     6704                |
| Failed calls           |        0                  |        0                |
| Refused calls          |        0                  |        0                |
| Aborted calls          |        0                  |        0                |
| Timeout calls          |        0                  |        0                |
|------------------------+---------------------------+-------------------------|
| Last Info              | Incomming traffic                                   |
| Last Error             | No error                                            |
|--- Next screen : Press key 1 ----------------------- [h]: Display help ------|
```

--------------------------------

### Scenario Example with External Authentication Data

Source: https://gull.sourceforge.net/doc/sip.html

Demonstrates a SIP INVITE scenario that restores authentication parameters from external fields and then sets the 'www-authentication' header. It also includes actions to increment a counter and store message details.

```xml
<send channel="channel-1">
     <action>
     <!-- For each new call, increment the callid counter -->
       <inc-counter name="callid-counter"> </inc-counter>
       <set-value name="call-id"
                  format="$(callid-counter)@255.255.255.255"></set-value>
        
       <!-- Restore data for authentication -->
       <restore-from-external field="0" name="USER-AUTH"></restore-from-external>
       <restore-from-external field="1" name="AUTH-AUTH"></restore-from-external>
       <restore-from-external field="2" name="METHOD-AUTH"></restore-from-external>
       <restore-from-external field="3" name="URI-AUTH"></restore-from-external>
       <restore-from-external field="4" name="OP-AUTH"></restore-from-external>
       <restore-from-external field="5" name="K-AUTH"></restore-from-external>
       <restore-from-external field="6" name="AMF-AUTH"></restore-from-external>
       <set-value name="www-authentication" method="authentication"
                  format="username=$(USER-AUTH);aka_op=$(OP-AUTH);aka_k=$(K-AUTH);aka_amf=$(AMF-AUTH);auth=$(AUTH-AUTH);method=$(METHOD-AUTH);uri=$(URI-AUTH)"></set-value>

     </action>
     <message>
     <!-- header -->
     <! [ CDATA[INVITE sip:schooler@cs.caltech.edu SIP/2.0
         Via: SIP/2.0/UDP north.east.isi.edu
         From: Mark Handley <sip:mjh@isi.edu>
         To: Eve Schooler <sip:schooler@caltech.edu>
         Call-ID: 2963313058@north.east.isi.edu
         CSeq: 1 INVITE
         Subject: SIP will be discussed, too
         Content-Type: application/sdp
         Content-Length: 187]] >
     <!-- body -->
     <![CDATA[v=0
              o=user1 53655765 2353687637 IN IP4 155.208.221.173
              s=Mbone Audio
              i=Discussion of Mbone Engineering Issues
              e=mbone@somewhere.com
              c=IN IP4 155.208.221.173
              t=0 0
              m=audio 3456 RTP/AVP 0
         a=rtpmap:0 PCMU/8000]] >
     </message>
     <action>
       <!-- Store completed fields for future msg-->
       <store name="SID" entity="call-id"></store>
       <store name="VIA" entity="via"></store>
       <store name="FROM" entity="from"></store>
       <store name="TO" entity="to"></store>
       </action>
   </send>
```

--------------------------------

### XCAP Client Scenario Example

Source: https://gull.sourceforge.net/doc/xcap.html

This XML scenario defines an XCAP client's interaction with an XCAP server. It includes opening a channel, sending a PUT request with an XML body, receiving a 201 Created response, sending a DELETE request, and finally receiving a 200 OK response before closing the channel.

```xml
<?xml version="1.0" encoding="ISO-8859-1" ?>
<scenario>

<traffic>
  <send channel="xcap-channel">
    <action>
      <open args="mode=client;dest=127.0.0.1:8090"></open>
    </action>
    <message>
      <!-- header -->
      <![CDATA[PUT /xcap/test-auid1/users/sip:user@hp.com/doc.xml HTTP/1.1
        Content-type: application/note+xml;charset=UTF-8
        X-XCAP-Asserted-Identity: "sip:user@hp.com"
        User-Agent: Seagull-gull.sourceforge.net
        Host: clever5:8090
        Accept: text/html, image/gif, *; q=.2, */*; q=.2
        Connection: keep-alive] ]>
      <!-- Body -->
      <![CDATA[<?xml version="1.0" encoding="UTF-8"?>
      <note xmlns:dog="the:namespace:for:dog">
        <dog:to>Jani</dog:to>
        <from>Tove</from>
        <heading>Re: Reminder</heading>
        <body>I will not forget you this week end!</body>
      </note>] ]>
    </message>
  </send>

  <receive channel="xcap-channel">
    <message>
    <!-- header -->
    <![CDATA[HTTP/1.1 201 Created
      Server: Apache-Coyote/1.1
      Pragma: No-cache
      Cache-Control: no-cache
      Expires: Wed, 31 Dec 1969 18:00:00 CST
      X-Powered-By: Servlet 2.4; JBoss-4.0.4.GA
      ETag: 1
      Content-Length: 0
      Date: Mon, 07 Aug 2006 21:14:46 GMT] ]>
    </message>
  </receive>

  <send channel="xcap-channel">
    <message>
      <!-- header -->
      <![CDATA[DELETE /xcap/test-auid1/users/sip:user@hp.com/doc.xml HTTP/1.1
        X-XCAP-Asserted-Identity: "sip:user@hp.com"
        User-Agent: Seagull-gull.sourceforge.net
        Host: clever5:8090
        Accept: text/html, image/gif, *; q=.2, */*; q=.2
        Connection: keep-alive
        Content-type: application/x-www-form-urlencoded
      ] ]>
    </message>
  </send>
  
  <receive channel="xcap-channel">
    <message>
    <!-- header -->
    <![CDATA[HTTP/1.1 200 OK
      Server: Apache-Coyote/1.1
      Pragma: No-cache
      Cache-Control: no-cache
      Expires: Wed, 31 Dec 1969 18:00:00 CST
      X-Powered-By: Servlet 2.4; JBoss-4.0.4.GA
      ETag: 1
      Content-Length: 0
      Date: Mon, 07 Aug 2006 21:14:46 GMT] ]>
    </message>
    <action>
      <close></close>
    </action>
  </receive>

  </traffic>
</scenario>
```

--------------------------------

### Compile Seagull from Source

Source: https://gull.sourceforge.net/doc/core.html

Navigate to the decompressed Seagull directory, edit the build configuration, and then compile the source code. Executables will be placed in the bin/ directory.

```bash
cd seagull
./build.ksh
```

--------------------------------

### Specify Multiple Protocol Dictionaries

Source: https://gull.sourceforge.net/doc/core.html

Command-line option to specify multiple protocol dictionary files for multi-protocol scenarios.

```bash
 -dico ../config/[dictionary_1-name].xml ../config/[dictionary_2-name].xml
```

--------------------------------

### Specify Protocol Dictionary

Source: https://gull.sourceforge.net/doc/core.html

Command-line option to specify a single protocol dictionary file for Seagull.

```bash
 -dico ../config/[dictionary-name].xml 
```

--------------------------------

### Launch Octcap ITU Client Script

Source: https://gull.sourceforge.net/doc/octcap.html

Use this script to launch the Octcap ITU client. Ensure LD_LIBRARY_PATH is set correctly. Additional SHLIB_PATH exports may be required depending on your SS7 version and OS.

```shell
#!/bin/ksh

export LD_LIBRARY_PATH=/usr/local/bin

seagull -conf ../config/conf.client-itu.xml -dico ../config/octcap-itu-dictionnary.xml 
-scen ../scenario/client-itu.xml -log ../logs/client.log -llevel ET	
	
	
```

--------------------------------

### Basic Send Message Structure

Source: https://gull.sourceforge.net/doc/core.html

Illustrates the basic structure of a <send> command in a Seagull scenario, showing where pre-actions, the message itself, and post-actions can be placed.

```xml
<send>
  <action>    <!-- Pre-action  -->
  </action>
  <message>   <!-- Message     -->
  </message>
  <action>    <!-- Post-action -->
  </action>
</send>
```

--------------------------------

### Seagull Archive File

Source: https://gull.sourceforge.net/doc/core.html

The command to extract the Seagull archive file before installation.

```bash
seagull-[tool version]-[OS]-[OS release version].tar.gz
```

--------------------------------

### Dump Statistics

Source: https://gull.sourceforge.net/doc/core.html

Retrieves the statistics counters from Seagull. This is achieved by sending an HTTP GET request to the specified URI.

```APIDOC
## GET /seagull/counters/all

### Description
Retrieves the statistics counters from Seagull.

### Method
GET

### Endpoint
/seagull/counters/all

### Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **fields** (object) - Statistics counters

#### Response Example
{
  "example": "{\"counters\": { \"packets_sent\": 1000, \"packets_received\": 950 }}"
}
```

--------------------------------

### Launch Seagull Client Script

Source: https://gull.sourceforge.net/doc/radius.html

This ksh script launches the Seagull client with specified configuration and dictionary files. Ensure LD_LIBRARY_PATH is set correctly.

```shell
#!/bin/ksh

export LD_LIBRARY_PATH=/usr/local/bin
seagull -conf ../config/conf.client.xml -dico ../config/radius-accounting.xml -scen ../scenario/radius-accounting.client.xml -log ../logs/radius-accounting.client.log -llevel ET
        
```

--------------------------------

### External Method Definition Example

Source: https://gull.sourceforge.net/doc/core.html

Defines an external method for encoding, specifying the library and function to be used for cryptographic operations.

```xml
<external-method>
  <defmethod name="authentication"
             param="lib=lib_crypto.so;function=crypto_method">
  </defmethod>
</external-method>
```

--------------------------------

### Decompress Seagull Source Code

Source: https://gull.sourceforge.net/doc/core.html

Use these commands to decompress the Seagull source code tarball. Ensure you have gzip and tar installed.

```bash
gunzip seagull-x.y.z.tar.gz
tar -xvf seagull-x.y.z.tar
```

--------------------------------

### Launch Seagull Client Script

Source: https://gull.sourceforge.net/doc/diameter.html

This shell script launches the Seagull client with specified configuration, dictionary, scenario, and log files. Ensure LD_LIBRARY_PATH is set correctly.

```shell
#!/bin/ksh

export LD_LIBRARY_PATH=/usr/local/bin

seagull -conf ../config/conf.client.xml -dico ../config/base_cx.xml 
-scen ../scenario/sar-saa.client.xml -log ../logs/sar-saa.client.log -llevel ET	
	

```

--------------------------------

### Radius Post-Action: Store Value

Source: https://gull.sourceforge.net/doc/radius.html

Example of a post-action command for Radius messages, used to store a received value into a named entity.

```xml
<action>
      <store name="ACCT_SES_ID" entity="Acct-Session-Id"></store>
    </action>
  </send>
```

--------------------------------

### SIP Client Configuration with External File

Source: https://gull.sourceforge.net/doc/sip.html

An XML scenario for a SIP client that uses an external file to set fields like Call-ID, Via, From, and To. This example demonstrates dynamic value setting and message construction.

```xml
<?xml version="1.0" encoding="ISO-8859-1" ?>
<scenario>

<counter>
  <counterdef name="callid-counter" init="0"> </counterdef>
</counter>

<traffic>
   <send channel="channel-1">
     <action>
    
       <inc-counter name="callid-counter"> </inc-counter>
    
       <set-value name="call-id"
                  format="$(callid-counter)@255.255.255.255"></set-value>

     
       <restore-from-external field="1" entity="call-id-addr"></restore-from-external>

     
       <store  name="local_ip"  entity="call-id-addr"></store>

   
       <set-value name="via"
                  format="SIP/2.0/UDP 255.255.255.255"></set-value>
       <restore name="local_ip" entity="via-addr"></restore>
      
       <restore-from-external field="4" entity="via-transport"></restore-from-external>

     
       <set-value name="from"
                  format=" seagull <sip:seagull@255.255.255.255&gt;;tag=1"></set-value>
      
       <restore-from-external field="0" entity="from-name"></restore-from-external>

       
       <store name="local_name"  entity="from-name"></store>

       <restore name="local_ip" entity="from-addr"></restore>

     
       <set-value name="to"
                  format="sut <sip:service@255.255.255.255:5060&gt;"></set-value>
      
       <restore-from-external field="2" entity="to-name"></restore-from-external>

       <restore-from-external field="3" entity="to-addr"></restore-from-external>

  
       <restore name="local_name" entity="invite-name"></restore>
       <restore name="local_ip" entity="invite-addr"></restore>

     </action>
     <message>

     <! [ CDATA[INVITE sip:schooler@cs.caltech.edu SIP/2.0
         Via: SIP/2.0/UDP north.east.isi.edu
         From: Mark Handley $lt;sip:mjh@isi.edu>
         To: Eve Schooler <sip:schooler@caltech.edu>
         Call-ID: 2963313058@north.east.isi.edu
         CSeq: 1 INVITE
         Subject: SIP will be discussed, too
         Content-Type: application/sdp
         Content-Length: 187]] >

     <![CDATA[v=0
              o=user1 53655765 2353687637 IN IP4 155.208.221.173
              s=Mbone Audio
              i=Discussion of Mbone Engineering Issues
              e=mbone@somewhere.com
              c=IN IP4 155.208.221.173
              t=0 0
              m=audio 3456 RTP/AVP 0
              a=rtpmap:0 PCMU/8000]] >
     </message>
     <action>
       
       <store name="SID" entity="call-id"></store>
       <store name="VIA" entity="via"></store>
       <store name="FROM" entity="from"></store>
       <store name="TO" entity="to"></store>
       </action>
   </send>

   <receive channel="channel-1">
    <message>
    
      <! [CDATA[SIP/2.0 180 Ringing
         Via: SIP/2.0/UDP north.east.isi.edu
         From: Mark Handley <sip:mjh@isi.edu>
         To: Eve Schooler <sip:schooler@caltech.edu> ;tag=9883472
         Call-ID: 2963313058@north.east.isi.edu
         CSeq: 1 INVITE]] >
    </message>
   </receive>


```

--------------------------------

### Restore Data from External Field with Offset

Source: https://gull.sourceforge.net/doc/core.html

Inject data from an external field into a message field, specifying the start and end octets for the injection.

```xml
<restore-from-external field="1" entity="FIELD_NAME"
       begin="1" end="3">
       </restore-from-external>
```

--------------------------------

### Find Seagull Packages for Uninstall (Linux RPM)

Source: https://gull.sourceforge.net/doc/core.html

Lists all installed Seagull-related packages on a Linux system using the rpm package manager.

```bash
rpm -aq | grep seagull
```

--------------------------------

### Define Text Protocol Field with Regexp

Source: https://gull.sourceforge.net/doc/core.html

Example of defining a field for a text protocol (SIP) using a regular expression to capture its value.

```xml
<fielddef name="call-id"
          format="call-id: $(field-value)\r\n">
  <regexp name="call-id"
          expr="[Cc][Aa][Ll][Ll]-[Ii][Dd][   ]*:[  ]*([!-}]*).*$"
          nbexpr="2">

```