Agent

java.lang.Object
- Mimic.Agent

public class Agent
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`AGENT_HALTED` agent's state : halted
`static int`	`AGENT_NOT_CONFIG` agent's state : not configured
`static int`	`AGENT_PAUSED` agent's state : paused
`static int`	`AGENT_RUNNING` agent's state : running
`static int`	`AGENT_STOPPED` agent's state : stopped
`static int`	`AGENT_STOPPING` agent's state : stopping (or starting)

Constructor Summary

Constructors
Constructor and Description

Agent(int agent_no, Session session)
Creates an agent object for a given session

Constructors
Constructor and Description
`Agent(int agent_no, Session session)` Creates an agent object for a given session

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add_ipalias(java.lang.String address, int port, java.lang.String mask, java.lang.String iface)` Add a new ipalias (See mimic agent ipalias add)
`void`	`add_timer_script(java.lang.String script, int interval, java.lang.String args)` Add (and start) timerscript with given interval and arguments (See mimic timer script add)
`void`	`agent_store_append(java.lang.String var, java.lang.String val, int persist)` Append (and start) storage with a given variable and value (See mimic agent store append)
`void`	`agent_store_copy(int other)` Copy variable store from other agent (See mimic agent store copy)
`int`	`agent_store_exists(java.lang.String var)` Examine existance of a store variable (See mimic agent store exists)
`java.lang.String`	`agent_store_get(java.lang.String var)` Return variable value (See mimic agent store get)
`java.util.LinkedList`	`agent_store_list()` List variables (See mimic agent store list)
`void`	`agent_store_lreplace(java.lang.String var, int index, java.lang.String val)` Treat variable as a list and modify entry for given index with given value (See mimic agent store lreplace)
`java.util.LinkedList`	`agent_store_mget(java.util.LinkedList vars)` Get multiple variable values (See mimic agent store mget)
`void`	`agent_store_mlreplace(java.util.LinkedList varlist, java.util.LinkedList indexlist, java.util.LinkedList vallist)` Treat each variable as a list and modify entry for given index with given value (See mimic agent store mlreplace)
`int`	`agent_store_persists(java.lang.String var)` Examine persistance of a store variable (See mimic agent store persists)
`void`	`agent_store_set(java.lang.String var, java.lang.String val, int persist)` Set (and start) storage with a given variable and value (See mimic agent store set)
`void`	`agent_store_unset(java.lang.String var)` Unset a variable-value pair (See mimic agent store unset)
`void`	`configure(java.lang.String address, java.util.LinkedList mibs)` Configure agent
`void`	`del_ipalias(java.lang.String address, int port)` Delete a configured ipalias (See mimic agent ipalias delete)
`void`	`del_timer_script(java.lang.String script)` Delete a running script with specified name (See mimic timer script delete)
`void`	`from_add(java.lang.String host, int port)` Add a new 'from' entry (See mimic agent from add)
`void`	`from_del(java.lang.String host, int port)` Delete a configured 'from' entry (See mimic agent from delete)
`java.util.LinkedList`	`from_list()` List the 'from' entry list for the agent (See mimic agent from list)
`int`	`get_agent_no()` Get agent's number
`int`	`get_changed()` Get the changed flag (See mimic agent get)
`int`	`get_config_changed()` Get the config changed flag (See mimic agent get)
`int`	`get_delay()` Get the delay (See mimic agent get)
`int`	`get_drops()` Get the drop rate (See mimic agent get)
`java.lang.String`	`get_host()` Get the primary ip address (See mimic agent get)
`int`	`get_inform_retries()` Get the inform retries (See mimic agent get)
`int`	`get_inform_timeout()` Get the inform timeout (See mimic agent get)
`java.lang.String`	`get_interface()` Get the interface for the primary ipalias (See mimic agent get)
`java.lang.String`	`get_mask()` Get the primary subnet mask (See mimic agent get)
`java.util.LinkedList`	`get_mibs()` Get the MIB triplets (See mimic agent get)
`java.lang.String`	`get_oiddir()` Get the OidDir filename (See mimic agent get)
`java.lang.String`	`get_owner()` Get the owner (See mimic agent get)
`int`	`get_pdusize()` Get the maximum PDU size (See mimic agent get)
`int`	`get_port()` Get the port number (See mimic agent get)
`java.lang.String`	`get_privdir()` Get the private directory (See mimic agent get)
`java.util.LinkedList`	`get_protocols()` Get the list of protocols (See mimic agent get)
`java.lang.String`	`get_read_community()` Get the read community (See mimic agent get)
`java.lang.String`	`get_scen()` Get the simulation scen (See mimic agent get)
`Session`	`get_session()` Get agent's session
`java.lang.String`	`get_sim()` Get the sim name (See mimic agent get)
`int`	`get_starttime()` Get the start time (See mimic agent get)
`int`	`get_state_changed()` Get the state changed flag (See mimic agent get)
`static java.lang.String`	`get_state_descr(int state)` Get the description of the specified agent state (See mimic agent get)
`int`	`get_state()` Get the agent state (See mimic agent get)
`java.util.LinkedList`	`get_statistics_Long()` Get the list of statistics (Long) (See mimic agent get)
`java.util.LinkedList`	`get_statistics_String()` Get the list of statistics (String) (See mimic agent get)
`java.util.LinkedList`	`get_statistics()` Get the list of statistics (See mimic agent get)
`int`	`get_trace()` Get the trace flag (See mimic agent get)
`int`	`get_validate()` Get the validate flag (See mimic agent get)
`Valuespace`	`get_valuespace()` Get the valuespace object for this agent.
`java.lang.String`	`get_write_community()` Get the write community (See mimic agent get)
`void`	`halt()` Halt agent (from running) (See mimic agent halt)
`java.util.LinkedList`	`list_ipaliases()` List the ipaliases for the agent (See mimic agent ipalias list)
`java.util.LinkedList`	`list_timer_scripts()` List the currently running timer scripts (See mimicsh_timer_script_list)
`void`	`pause_at(int time)` Pause agent at given time (from running) (See mimic agent pause)
`void`	`pause_now()` Pause agent now (from running) (See mimic agent pause)
`java.lang.String`	`protocol_msg(java.lang.String protocol, java.lang.String msg)` Pass agent's message string to the protocol
`void`	`remove()` Delete a configured agent (See mimic agent remove)
`void`	`resume()` Resume agent (from paused/halted) (See mimic agent resume)
`void`	`save()` Save the agent's valuespace changes (See mimic agent save)
`void`	`set_delay(int delay)` Set the delay (See mimic agent set)
`void`	`set_drops(int drops)` Set the drop rate (See mimic agent set)
`void`	`set_host(java.lang.String host)` Set the primary ip address (See mimic agent set)
`void`	`set_inform_retries(int retries)` Set the inform retries (See mimic agent set)
`void`	`set_inform_timeout(int timeout)` Set the inform timeout (See mimic agent set)
`void`	`set_interface(java.lang.String iface)` Set the interface for primary ipalias (See mimic agent set)
`void`	`set_mask(java.lang.String mask)` Set the primary subnet mask (See mimic agent set)
`void`	`set_mibs(java.util.LinkedList mibs)` Set the MIB triplets (See mimic agent set)
`void`	`set_oiddir(java.lang.String oiddir)` Set the OidDir filename (See mimic agent set)
`void`	`set_pdusize(int pdusize)` Set the maximum PDU size (See mimic agent set)
`void`	`set_port(int port)` Set the port number (See mimic agent set)
`void`	`set_protocols(java.util.LinkedList protocols)` Set the list of protocols supported (See mimic agent set)
`void`	`set_read_community(java.lang.String readcomm)` Set the read community (See mimic agent set)
`void`	`set_starttime(int starttime)` Set the starttime (See mimic agent set)
`void`	`set_trace(int flag)` Set the trace flag (See mimic agent set)
`void`	`set_validate(int flag)` Set the validate flag (See mimic agent set)
`void`	`set_write_community(java.lang.String writecomm)` Set the write community (See mimic agent set)
`void`	`start_ipalias(java.lang.String address, int port)` Start the configured ipalias (See mimic agent ipalias start)
`void`	`start()` Start agent (from stopped) (See mimic agent start)
`int`	`status_ipalias(java.lang.String address, int port)` Status of the configured ipalias for the agent (See mimic agent ipalias status)
`void`	`stop_ipalias(java.lang.String address, int port)` Stop the configured ipalias (See mimic agent ipalias stop)
`void`	`stop()` Stop agent (from running, paused, halted) (See mimic agent stop)
`void`	`trap_config_add(java.lang.String address, int port)` Set the trap destination (See mimic agent trap config add)
`void`	`trap_config_del(java.lang.String address, int port)` Remove the trap destination from list (See mimic agent trap config delete)
`java.util.LinkedList`	`trap_config_list()` Get the trap destination list (See mimic agent trap config list)
`java.util.LinkedList`	`trap_list()` Get the trap list

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - AGENT_RUNNING
```
public static final int AGENT_RUNNING
```
    agent's state : running
    
    See Also:
    
    Constant Field Values
  - AGENT_STOPPED
```
public static final int AGENT_STOPPED
```
    agent's state : stopped
    
    See Also:
    
    Constant Field Values
  - AGENT_HALTED
```
public static final int AGENT_HALTED
```
    agent's state : halted
    
    See Also:
    
    Constant Field Values
  - AGENT_PAUSED
```
public static final int AGENT_PAUSED
```
    agent's state : paused
    
    See Also:
    
    Constant Field Values
  - AGENT_NOT_CONFIG
```
public static final int AGENT_NOT_CONFIG
```
    agent's state : not configured
    
    See Also:
    
    Constant Field Values
  - AGENT_STOPPING
```
public static final int AGENT_STOPPING
```
    agent's state : stopping (or starting)
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Agent
```
public Agent(int agent_no,
             Session session)
```
    Creates an agent object for a given session
    
    Parameters:
    
    agent_no - (IN) agent number
    
    session - (IN) session object
- Method Detail
  - get_agent_no
```
public int get_agent_no()
```
    Get agent's number
    
    Returns:
    
    int - agent's number
  - get_session
```
public Session get_session()
```
    Get agent's session
    
    Returns:
    
    Session - agent's session
  - start
```
public void start()
           throws ErrorInfo
```
    Start agent (from stopped) (See mimic agent start)
    
    Throws:
    
    ErrorInfo - on error
  - stop
```
public void stop()
          throws ErrorInfo
```
    Stop agent (from running, paused, halted) (See mimic agent stop)
    
    Throws:
    
    ErrorInfo - on error
  - pause_now
```
public void pause_now()
               throws ErrorInfo
```
    Pause agent now (from running) (See mimic agent pause)
    
    Throws:
    
    ErrorInfo - on error
  - pause_at
```
public void pause_at(int time)
              throws ErrorInfo
```
    Pause agent at given time (from running) (See mimic agent pause)
    
    Parameters:
    
    time - int
    
    Throws:
    
    ErrorInfo - on error
  - halt
```
public void halt()
          throws ErrorInfo
```
    Halt agent (from running) (See mimic agent halt)
    
    Throws:
    
    ErrorInfo - on error
  - resume
```
public void resume()
            throws ErrorInfo
```
    Resume agent (from paused/halted) (See mimic agent resume)
    
    Throws:
    
    ErrorInfo - on error
  - configure
```
public void configure(java.lang.String address,
                      java.util.LinkedList mibs)
               throws ErrorInfo
```
    Configure agent
    
    Parameters:
    
    address - (IN) ip-address
    
    mibs - (IN) MIB triplets
    
    Throws:
    
    ErrorInfo - on error
  - remove
```
public void remove()
            throws ErrorInfo
```
    Delete a configured agent (See mimic agent remove)
    
    Throws:
    
    ErrorInfo - on error
  - get_interface
```
public java.lang.String get_interface()
                               throws ErrorInfo
```
    Get the interface for the primary ipalias (See mimic agent get)
    
    Returns:
    
    String - interface
    
    Throws:
    
    ErrorInfo - on error
  - get_host
```
public java.lang.String get_host()
                          throws ErrorInfo
```
    Get the primary ip address (See mimic agent get)
    
    Returns:
    
    String - ip-address
    
    Throws:
    
    ErrorInfo - on error
  - get_mask
```
public java.lang.String get_mask()
                          throws ErrorInfo
```
    Get the primary subnet mask (See mimic agent get)
    
    Returns:
    
    String - subnet mask
    
    Throws:
    
    ErrorInfo - on error
  - get_port
```
public int get_port()
             throws ErrorInfo
```
    Get the port number (See mimic agent get)
    
    Returns:
    
    int - port number
    
    Throws:
    
    ErrorInfo - on error
  - get_read_community
```
public java.lang.String get_read_community()
                                    throws ErrorInfo
```
    Get the read community (See mimic agent get)
    
    Returns:
    
    String - read community
    
    Throws:
    
    ErrorInfo - on error
  - get_write_community
```
public java.lang.String get_write_community()
                                     throws ErrorInfo
```
    Get the write community (See mimic agent get)
    
    Returns:
    
    String - write community
    
    Throws:
    
    ErrorInfo - on error
  - get_mibs
```
public java.util.LinkedList get_mibs()
                              throws ErrorInfo
```
    Get the MIB triplets (See mimic agent get)
    
    Returns:
    
    LinkedList - list of MIB triplets
    
    Throws:
    
    ErrorInfo - on error
  - get_sim
```
public java.lang.String get_sim()
                         throws ErrorInfo
```
    Get the sim name (See mimic agent get)
    
    Returns:
    
    String - sim name
    
    Throws:
    
    ErrorInfo - on error
  - get_scen
```
public java.lang.String get_scen()
                          throws ErrorInfo
```
    Get the simulation scen (See mimic agent get)
    
    Returns:
    
    String - scenario
    
    Throws:
    
    ErrorInfo - on error
  - get_pdusize
```
public int get_pdusize()
                throws ErrorInfo
```
    Get the maximum PDU size (See mimic agent get)
    
    Returns:
    
    int - PDU size
    
    Throws:
    
    ErrorInfo - on error
  - get_protocols
```
public java.util.LinkedList get_protocols()
                                   throws ErrorInfo
```
    Get the list of protocols (See mimic agent get)
    
    Returns:
    
    LinkedList - list of protocols
    
    Throws:
    
    ErrorInfo - on error
  - get_delay
```
public int get_delay()
              throws ErrorInfo
```
    Get the delay (See mimic agent get)
    
    Returns:
    
    int - delay
    
    Throws:
    
    ErrorInfo - on error
  - get_starttime
```
public int get_starttime()
                  throws ErrorInfo
```
    Get the start time (See mimic agent get)
    
    Returns:
    
    int - start time
    
    Throws:
    
    ErrorInfo - on error
  - get_state
```
public int get_state()
              throws ErrorInfo
```
    Get the agent state (See mimic agent get)
    
    Returns:
    
    int - state
    
    Throws:
    
    ErrorInfo - on error
  - get_statistics
```
public java.util.LinkedList get_statistics()
                                    throws ErrorInfo
```
    Get the list of statistics (See mimic agent get)
    
    Returns:
    
    LinkedList - SNMP statistics (total discarded error GET GETNEXT SET BULK TRAP GETVAR GETNEXTVAR SETVAR BULKVAR)
    
    Throws:
    
    ErrorInfo - on error
  - get_statistics_Long
```
public java.util.LinkedList get_statistics_Long()
                                         throws ErrorInfo
```
    Get the list of statistics (Long) (See mimic agent get)
    
    Returns:
    
    LinkedList(Long) - SNMP statistics (total discarded error GET GETNEXT SET BULK TRAP GETVAR GETNEXTVAR SETVAR BULKVAR)
    
    Throws:
    
    ErrorInfo - on error
  - get_statistics_String
```
public java.util.LinkedList get_statistics_String()
                                           throws ErrorInfo
```
    Get the list of statistics (String) (See mimic agent get)
    
    Returns:
    
    LinkedList(String) - SNMP statistics (total discarded error GET GETNEXT SET BULK TRAP GETVAR GETNEXTVAR SETVAR BULKVAR)
    
    Throws:
    
    ErrorInfo - on error
  - get_drops
```
public int get_drops()
              throws ErrorInfo
```
    Get the drop rate (See mimic agent get)
    
    Returns:
    
    int - drop rate
    
    Throws:
    
    ErrorInfo - on error
  - get_changed
```
public int get_changed()
                throws ErrorInfo
```
    Get the changed flag (See mimic agent get)
    
    Returns:
    
    int - changed flag
    
    Throws:
    
    ErrorInfo - on error
  - get_config_changed
```
public int get_config_changed()
                       throws ErrorInfo
```
    Get the config changed flag (See mimic agent get)
    
    Returns:
    
    int - config changed flag
    
    Throws:
    
    ErrorInfo - on error
  - get_state_changed
```
public int get_state_changed()
                      throws ErrorInfo
```
    Get the state changed flag (See mimic agent get)
    
    Returns:
    
    int - state changed flag
    
    Throws:
    
    ErrorInfo - on error
  - get_trace
```
public int get_trace()
              throws ErrorInfo
```
    Get the trace flag (See mimic agent get)
    
    Returns:
    
    int - trace flag
    
    Throws:
    
    ErrorInfo - on error
  - get_validate
```
public int get_validate()
                 throws ErrorInfo
```
    Get the validate flag (See mimic agent get)
    
    Returns:
    
    int - validate flag
    
    Throws:
    
    ErrorInfo - on error
  - get_owner
```
public java.lang.String get_owner()
                           throws ErrorInfo
```
    Get the owner (See mimic agent get)
    
    Returns:
    
    String - owner name
    
    Throws:
    
    ErrorInfo - on error
  - get_privdir
```
public java.lang.String get_privdir()
                             throws ErrorInfo
```
    Get the private directory (See mimic agent get)
    
    Returns:
    
    String - private directory
    
    Throws:
    
    ErrorInfo - on error
  - get_oiddir
```
public java.lang.String get_oiddir()
                            throws ErrorInfo
```
    Get the OidDir filename (See mimic agent get)
    
    Returns:
    
    String - OidDir filename
    
    Throws:
    
    ErrorInfo - on error
  - get_inform_timeout
```
public int get_inform_timeout()
                       throws ErrorInfo
```
    Get the inform timeout (See mimic agent get)
    
    Returns:
    
    int - timeout
    
    Throws:
    
    ErrorInfo - on error
  - get_inform_retries
```
public int get_inform_retries()
                       throws ErrorInfo
```
    Get the inform retries (See mimic agent get)
    
    Returns:
    
    int - retries
    
    Throws:
    
    ErrorInfo - on error
  - trap_list
```
public java.util.LinkedList trap_list()
                               throws ErrorInfo
```
    Get the trap list
    
    Returns:
    
    Linked list of trap OIDs
    
    Throws:
    
    ErrorInfo - on error
  - trap_config_list
```
public java.util.LinkedList trap_config_list()
                                      throws ErrorInfo
```
    Get the trap destination list (See mimic agent trap config list)
    
    Returns:
    
    Linked list of trap destination,port
    
    Throws:
    
    ErrorInfo - on error
  - trap_config_add
```
public void trap_config_add(java.lang.String address,
                            int port)
                     throws ErrorInfo
```
    Set the trap destination (See mimic agent trap config add)
    
    Parameters:
    
    address - target ip address
    
    port - target port
    
    Throws:
    
    ErrorInfo - on error
  - trap_config_del
```
public void trap_config_del(java.lang.String address,
                            int port)
                     throws ErrorInfo
```
    Remove the trap destination from list (See mimic agent trap config delete)
    
    Parameters:
    
    address - target ip address
    
    port - target port
    
    Throws:
    
    ErrorInfo - on error
  - set_interface
```
public void set_interface(java.lang.String iface)
                   throws ErrorInfo
```
    Set the interface for primary ipalias (See mimic agent set)
    
    Parameters:
    
    iface - (IN) interface
    
    Throws:
    
    ErrorInfo - on error
  - set_host
```
public void set_host(java.lang.String host)
              throws ErrorInfo
```
    Set the primary ip address (See mimic agent set)
    
    Parameters:
    
    host - (IN) ip-address
    
    Throws:
    
    ErrorInfo - on error
  - set_mask
```
public void set_mask(java.lang.String mask)
              throws ErrorInfo
```
    Set the primary subnet mask (See mimic agent set)
    
    Parameters:
    
    mask - (IN) subnet mask
    
    Throws:
    
    ErrorInfo - on error
  - set_port
```
public void set_port(int port)
              throws ErrorInfo
```
    Set the port number (See mimic agent set)
    
    Parameters:
    
    port - (IN) port number
    
    Throws:
    
    ErrorInfo - on error
  - set_read_community
```
public void set_read_community(java.lang.String readcomm)
                        throws ErrorInfo
```
    Set the read community (See mimic agent set)
    
    Parameters:
    
    readcomm - (IN) read community
    
    Throws:
    
    ErrorInfo - on error
  - set_write_community
```
public void set_write_community(java.lang.String writecomm)
                         throws ErrorInfo
```
    Set the write community (See mimic agent set)
    
    Parameters:
    
    writecomm - (IN) write community
    
    Throws:
    
    ErrorInfo - on error
  - set_protocols
```
public void set_protocols(java.util.LinkedList protocols)
                   throws ErrorInfo
```
    Set the list of protocols supported (See mimic agent set)
    
    Parameters:
    
    protocols - (IN) list of protocol strings
    
    Throws:
    
    ErrorInfo - on error
  - set_delay
```
public void set_delay(int delay)
               throws ErrorInfo
```
    Set the delay (See mimic agent set)
    
    Parameters:
    
    delay - (IN) delay
    
    Throws:
    
    ErrorInfo - on error
  - set_starttime
```
public void set_starttime(int starttime)
                   throws ErrorInfo
```
    Set the starttime (See mimic agent set)
    
    Parameters:
    
    starttime - (IN) start time
    
    Throws:
    
    ErrorInfo - on error
  - set_mibs
```
public void set_mibs(java.util.LinkedList mibs)
              throws ErrorInfo
```
    Set the MIB triplets (See mimic agent set)
    
    Parameters:
    
    mibs - (IN) list of MIB triplet strings
    
    Throws:
    
    ErrorInfo - on error
  - set_trace
```
public void set_trace(int flag)
               throws ErrorInfo
```
    Set the trace flag (See mimic agent set)
    
    Parameters:
    
    flag - (IN) trace flag
    
    Throws:
    
    ErrorInfo - on error
  - set_pdusize
```
public void set_pdusize(int pdusize)
                 throws ErrorInfo
```
    Set the maximum PDU size (See mimic agent set)
    
    Parameters:
    
    pdusize - (IN) PDU size
    
    Throws:
    
    ErrorInfo - on error
  - set_drops
```
public void set_drops(int drops)
               throws ErrorInfo
```
    Set the drop rate (See mimic agent set)
    
    Parameters:
    
    drops - (IN) drop rate
    
    Throws:
    
    ErrorInfo - on error
  - set_validate
```
public void set_validate(int flag)
                  throws ErrorInfo
```
    Set the validate flag (See mimic agent set)
    
    Parameters:
    
    flag - (IN) validate flag
    
    Throws:
    
    ErrorInfo - on error
  - set_oiddir
```
public void set_oiddir(java.lang.String oiddir)
                throws ErrorInfo
```
    Set the OidDir filename (See mimic agent set)
    
    Parameters:
    
    oiddir - (IN) OidDir filename
    
    Throws:
    
    ErrorInfo - on error
  - set_inform_timeout
```
public void set_inform_timeout(int timeout)
                        throws ErrorInfo
```
    Set the inform timeout (See mimic agent set)
    
    Parameters:
    
    timeout - (IN) timeout secs
    
    Throws:
    
    ErrorInfo - on error
  - set_inform_retries
```
public void set_inform_retries(int retries)
                        throws ErrorInfo
```
    Set the inform retries (See mimic agent set)
    
    Parameters:
    
    retries - (IN) no of retries
    
    Throws:
    
    ErrorInfo - on error
  - save
```
public void save()
          throws ErrorInfo
```
    Save the agent's valuespace changes (See mimic agent save)
    
    Throws:
    
    ErrorInfo - on error
  - add_ipalias
```
public void add_ipalias(java.lang.String address,
                        int port,
                        java.lang.String mask,
                        java.lang.String iface)
                 throws ErrorInfo
```
    Add a new ipalias (See mimic agent ipalias add)
    
    Parameters:
    
    address - (IN) ip-address
    
    port - (IN) port number
    
    mask - (IN) subnet mask
    
    iface - (IN) interface
    
    Throws:
    
    ErrorInfo - on error
  - del_ipalias
```
public void del_ipalias(java.lang.String address,
                        int port)
                 throws ErrorInfo
```
    Delete a configured ipalias (See mimic agent ipalias delete)
    
    Parameters:
    
    address - (IN) ip-address
    
    port - (IN) port number
    
    Throws:
    
    ErrorInfo - on error
  - start_ipalias
```
public void start_ipalias(java.lang.String address,
                          int port)
                   throws ErrorInfo
```
    Start the configured ipalias (See mimic agent ipalias start)
    
    Parameters:
    
    address - (IN) ip-address
    
    port - (IN) port number
    
    Throws:
    
    ErrorInfo - on error
  - stop_ipalias
```
public void stop_ipalias(java.lang.String address,
                         int port)
                  throws ErrorInfo
```
    Stop the configured ipalias (See mimic agent ipalias stop)
    
    Parameters:
    
    address - (IN) ip-address
    
    port - (IN) port number
    
    Throws:
    
    ErrorInfo - on error
  - status_ipalias
```
public int status_ipalias(java.lang.String address,
                          int port)
                   throws ErrorInfo
```
    Status of the configured ipalias for the agent (See mimic agent ipalias status)
    
    Parameters:
    
    address - (IN) ip address
    
    port - (IN)
    
    Returns:
    
    int - status of the ipalias
    
    Throws:
    
    ErrorInfo - on error
  - list_ipaliases
```
public java.util.LinkedList list_ipaliases()
                                    throws ErrorInfo
```
    List the ipaliases for the agent (See mimic agent ipalias list)
    
    Returns:
    
    LinkedList - list of ipalias detail strings (address,port,mask,interface)
    
    Throws:
    
    ErrorInfo - on error
  - add_timer_script
```
public void add_timer_script(java.lang.String script,
                             int interval,
                             java.lang.String args)
                      throws ErrorInfo
```
    Add (and start) timerscript with given interval and arguments (See mimic timer script add)
    
    Parameters:
    
    script - (IN) script to add
    
    interval - (IN) interval in milli-seconds
    
    args - (IN) arguments passed to the script
    
    Throws:
    
    ErrorInfo - on error
  - del_timer_script
```
public void del_timer_script(java.lang.String script)
                      throws ErrorInfo
```
    Delete a running script with specified name (See mimic timer script delete)
    
    Parameters:
    
    script - (IN) script to delete
    
    Throws:
    
    ErrorInfo - on error
  - list_timer_scripts
```
public java.util.LinkedList list_timer_scripts()
                                        throws ErrorInfo
```
    List the currently running timer scripts (See mimicsh_timer_script_list)
    
    Returns:
    
    LinkedList list of scripts configured (script,interval,args)
    
    Throws:
    
    ErrorInfo - on error
  - protocol_msg
```
public java.lang.String protocol_msg(java.lang.String protocol,
                                     java.lang.String msg)
                              throws ErrorInfo
```
    Pass agent's message string to the protocol
    
    Parameters:
    
    protocol - (IN) protocol to send message to
    
    msg - (IN) message string to be sent
    
    Returns:
    
    String reply buffer
    
    Throws:
    
    ErrorInfo - on error
  - get_valuespace
```
public Valuespace get_valuespace()
```
    Get the valuespace object for this agent.
    
    Returns:
    
    Valuespace - agent's valuespace object
  - get_state_descr
```
public static java.lang.String get_state_descr(int state)
```
    Get the description of the specified agent state (See mimic agent get)
    
    Parameters:
    
    state - (IN)
    
    Returns:
    
    String - Description of agent state
  - agent_store_set
```
public void agent_store_set(java.lang.String var,
                            java.lang.String val,
                            int persist)
                     throws ErrorInfo
```
    Set (and start) storage with a given variable and value (See mimic agent store set)
    
    Parameters:
    
    var - (IN) variable to set
    
    val - (IN) value to set
    
    persist - (IN) persistence
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_append
```
public void agent_store_append(java.lang.String var,
                               java.lang.String val,
                               int persist)
                        throws ErrorInfo
```
    Append (and start) storage with a given variable and value (See mimic agent store append)
    
    Parameters:
    
    var - (IN) variable to set
    
    val - (IN) value to set
    
    persist - (IN) persistence
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_lreplace
```
public void agent_store_lreplace(java.lang.String var,
                                 int index,
                                 java.lang.String val)
                          throws ErrorInfo
```
    Treat variable as a list and modify entry for given index with given value (See mimic agent store lreplace)
    
    Parameters:
    
    var - (IN) variable to set
    
    index - (IN) variable to set
    
    val - (IN) value to set
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_mlreplace
```
public void agent_store_mlreplace(java.util.LinkedList varlist,
                                  java.util.LinkedList indexlist,
                                  java.util.LinkedList vallist)
                           throws ErrorInfo
```
    Treat each variable as a list and modify entry for given index with given value (See mimic agent store mlreplace)
    
    Parameters:
    
    varlist - (IN) variable to set
    
    indexlist - (IN) variable to set
    
    vallist - (IN) value to set
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_unset
```
public void agent_store_unset(java.lang.String var)
                       throws ErrorInfo
```
    Unset a variable-value pair (See mimic agent store unset)
    
    Parameters:
    
    var - (IN) variable to unset
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_list
```
public java.util.LinkedList agent_store_list()
                                      throws ErrorInfo
```
    List variables (See mimic agent store list)
    
    Returns:
    
    LinkedList list of variables
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_exists
```
public int agent_store_exists(java.lang.String var)
                       throws ErrorInfo
```
    Examine existance of a store variable (See mimic agent store exists)
    
    Parameters:
    
    var - (IN)
    
    Returns:
    
    1 if exists, 0 otherwise
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_persists
```
public int agent_store_persists(java.lang.String var)
                         throws ErrorInfo
```
    Examine persistance of a store variable (See mimic agent store persists)
    
    Parameters:
    
    var - (IN)
    
    Returns:
    
    1 if is persistent, 0 otherwise
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_get
```
public java.lang.String agent_store_get(java.lang.String var)
                                 throws ErrorInfo
```
    Return variable value (See mimic agent store get)
    
    Parameters:
    
    var - (IN)
    
    Returns:
    
    value
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_mget
```
public java.util.LinkedList agent_store_mget(java.util.LinkedList vars)
                                      throws ErrorInfo
```
    Get multiple variable values (See mimic agent store mget)
    
    Parameters:
    
    vars - (IN) LinkedList
    
    Returns:
    
    LinkedList list of variables
    
    Throws:
    
    ErrorInfo - on error
  - agent_store_copy
```
public void agent_store_copy(int other)
                      throws ErrorInfo
```
    Copy variable store from other agent (See mimic agent store copy)
    
    Parameters:
    
    other - (IN)
    
    Throws:
    
    ErrorInfo - on error
  - from_list
```
public java.util.LinkedList from_list()
                               throws ErrorInfo
```
    List the 'from' entry list for the agent (See mimic agent from list)
    
    Returns:
    
    Linked list entries of from host,port
    
    Throws:
    
    ErrorInfo - on error
  - from_add
```
public void from_add(java.lang.String host,
                     int port)
              throws ErrorInfo
```
    Add a new 'from' entry (See mimic agent from add)
    
    Parameters:
    
    host - (IN) ip-address
    
    port - (IN) port
    
    Throws:
    
    ErrorInfo - on error
  - from_del
```
public void from_del(java.lang.String host,
                     int port)
              throws ErrorInfo
```
    Delete a configured 'from' entry (See mimic agent from delete)
    
    Parameters:
    
    host - (IN) ip-address
    
    port - (IN) port
    
    Throws:
    
    ErrorInfo - on error

Class Agent

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AGENT_RUNNING

AGENT_STOPPED

AGENT_HALTED

AGENT_PAUSED

AGENT_NOT_CONFIG

AGENT_STOPPING

Constructor Detail

Agent

Method Detail

get_agent_no

get_session

start

stop

pause_now

pause_at

halt

resume

configure

remove

get_interface

get_host

get_mask

get_port

get_read_community

get_write_community

get_mibs

get_sim

get_scen

get_pdusize

get_protocols

get_delay

get_starttime

get_state

get_statistics

get_statistics_Long

get_statistics_String

get_drops

get_changed

get_config_changed

get_state_changed

get_trace

get_validate

get_owner

get_privdir

get_oiddir

get_inform_timeout

get_inform_retries

trap_list

trap_config_list

trap_config_add

trap_config_del

set_interface

set_host

set_mask

set_port

set_read_community

set_write_community

set_protocols

set_delay

set_starttime

set_mibs

set_trace

set_pdusize

set_drops

set_validate

set_oiddir

set_inform_timeout

set_inform_retries

save

add_ipalias

del_ipalias

start_ipalias

stop_ipalias

status_ipalias