MIMIC REST

current running state of the agent

0-Unknown 1-Running 2-Stopped 3-Halted 4-Paused 5-Deleted 6-Stopping

current statistics of the agent instance

The statistics are returned as 64-bit decimal numbers for the following statistics, total, discarded, error, GET, GETNEXT, SET, GETBULK, trap, GET variables, GETNEXT variables, SET variables, GETBULK variables, INFORM sent, INFORM re-sent, INFORM timed out, INFORM acked, INFORM REPORT

delete a source address that the agent will accept messages from.

An empty ipaddress or 0.0.0.0 both imply any address. Similarly an empty port or 0 both imply any port. For agents with source-address-indexing enabled, messages which do not match any source address will be discarded with an ERROR message, similar to community string mismatches.

Deletes a variable which is currently defined.

This will cleanup persistent variables if needed

Deletes a variable which is currently defined.

This will cleanup persistent variables if needed

Deletes an existing ipalias from the agent.

port defaults to 161 if not specified.

Deletes the specified access entry.

Deletes the specified access entry.

Deletes the specified group entry.

Deletes the specified group entry.

Deletes the specified user entry.

Deletes the specified user entry.

Deletes the specified view entry.

Deletes the specified view entry.

Display the MIB object instances for the specified object.

This enables MIB browsing of the MIB on the current agent.

Display the MIB objects below the current position

This command is similar to the ls or dir operating system commands to list filesystem directories.

Display the variables for the specified instance instance for the specified MIB object object

This enables variable browsing of the MIB on the current agent.

drop rate (every N-th PDU). 0 means no drops.

drop rate (every N-th PDU). 0 means no drops.

Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.

Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.

Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.

Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.

Fetches the value associated with a variable.

The value will be returned as a string (like all Tcl values).

Fetches the value associated with a variable.

The value will be returned as a string (like all Tcl values).

first scenario name

first scenario name

first simulation name

first simulation name

Get a variable in the Value Space.

Get a variable in the Value Space.

Get multiple sets of information about MIMIC, where infoArray is one of the parameters defined in the mimic get command.

Get multiple sets of information about MIMIC, where infoArray is one of the parameters defined in the mimic get command.

Get multiple variables in the Value Space.

This is a performance optimization of the mimic value get command, to be used when many variables are requested.

Get the state of a MIB object object.

To disable traversal into a MIB object and any subtree underneath, set the state to 0, else set the state to 1.

has the agent state changed?

has the agent state changed?

has the agent value space changed?

has the agent value space changed?

has the lab configuration changed?

has the lab configuration changed?

host address of the agent.

Currently, only IPv4 addresses are allowed as the main address of the agent, but both IPv4 and IPv6 addresses are allowed as IP aliases for the agent.

List all IP aliases on the agent and the simulator host

By default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent

List all IP aliases on the agent and the simulator host

By default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent

List all IP aliases on the agent and the simulator host

By default, the MIMIC TELNET server listens on all the IP addresses (aliases) that are configured for an agent

List all proxy targets

List the outstanding asynchronous traps for this agent instance.

List the outstanding asynchronous traps for this agent instance.

List the set of trap destinations for this agent instance.

Each trap destination is identified with an IP address and a port number. The default port number is the standard SNMP trap port 162.

List the source addresses that the agent will accept messages from.

This in effect implements source-address-indexing, where 2 agents with the same address can be configured, each accepting messages from different management stations.

List the timer scripts currently running along with the their intervals.

The command mimic timer script list lists global timer scripts, the command /mimic/timer/script/{agentNum}/list is the per-agent equivalent NOTE Global timer scripts run globally but within them you can address individual agents using {agentNum}. To schedule timerscripts for an individual agent, use /mimic/timer/script/{agentNum}.

List the timer scripts currently running along with the their intervals.

The command mimic timer script list lists global timer scripts, the command /mimic/timer/script/{agentNum}/list is the per-agent equivalent NOTE Global timer scripts run globally but within them you can address individual agents using {agentNum}. To schedule timerscripts for an individual agent, use /mimic/timer/script/{agentNum}.

Lists all the additional ipaliases configured for the agent.

The agent host address (set with mimic agent set host) is not in this list, since it is already accessible separately with mimic agent get host.

maximum PDU size.

The limit for this configurable is 65536.

MIB directory of the agent.

MIB directory of the agent.

network interface card for the agent.

network interface card for the agent.

number of starts for the agent.

This count is incremented each time an agent starts. It affects the SNMPv3 EngineBoots parameter.

one-way transit delay in msec.

The minimum granularity is 10 msec.

owner of the agent.

owner of the agent.

port number

port number

private directory of the agent.

private directory of the agent.

protocols supported by agent

protocols supported by agent as an array of strings

read community string

read community string

relative start time

relative start time

Retrieve TOD time

Retrive time from server

Retrieves the contextEngineID for the agent instance.

Retrieves the contextEngineID for the agent instance.

Retrieves the number of times the agent has been restarted.

Retrieves the number of times the agent has been restarted.

Retrieves the time in seconds for which the agent has been running.

Retrieves the time in seconds for which the agent has been running.

Return the MIB that defines the specified object.

This will only return a MIB name if the object is unmistakeably defined in a MIB.

Return the numeric OID of the specified object.

Return the numeric OID of the specified object.

Return the symbolic name of the specified object identifier.

Return the symbolic name of the specified object identifier.

Return the syntactical information for the specified object, such as type, size, range, enumerations, and ACCESS.

Return the syntactical information for the specified object, such as type, size, range, enumerations, and ACCESS.

Returns an array of entries.

Each entry consists of user, agents (in minimal range representation) and access mask (not used currently).

Returns the current access control database in use.

If nothing is specified then this returns "".

Returns the current admin directory.

If nothing is specified in admin/settings.cfg then returns "". If no admin directory is specified then the shared area will be used where needed (e.g. for persistent info, access control data files etc. )

Returns the current administrator.

If nothing is specified in admin/settings.cfg then returns "".

Returns the protocol's configuration.

Returns the protocol's configuration.

Returns the state of access control checking.

0 indicates that it is disabled, 1 indicates it is enabled.

set of MIBs, simulations and scenarios

set of MIBs, simulations and scenarios

Show the agent's COAP argument structure

Agent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap

Show the agent's COAP configuration

Agent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap

Show the agent's COAP statistics

Statistics of fields indicated in the headers

Show the agent's COAP traffic tracing

Trace 1 means enabled, 0 means not

Show the agent's DHCP argument structure

Agent's DHCP configuration particulars

Show the agent's DHCP configuration

Agent's DHCP configuration hwaddr,classid,add_options,script

Show the agent's DHCP statistics

Statistics of fields indicated in the headers

Show the agent's DHCP traffic tracing

Trace 1 means enabled, 0 means not

Show the COAP statistics headers

The headers of statistics fields

Show the DHCP statistics headers

The headers of statistics fields

Show the parameters configured by the server in its DHCP-OFFER message

DHCP-OFFER message parameters

SNMP PDU tracing

SNMP PDU tracing

SNMP SET validation policy.

Is a bitmask in which with the following bits (from LSB) check for type, length, range, access

subnet mask of the agent.

subnet mask of the agent.

The current log file for the Simulator.

The current log file for the Simulator.

The currently loaded lab configuration file for the particular user.

In the case of multi-user access this command returns a different configuration file loaded for each user.

The default network device to be used for agent addresses.

The default network device to be used for agent addresses if the interface is not explicitly specified for an agent.

The last configured agent instance.

The last configured agent instance.

The list of {agentnum {statistics}} for agents that are currently active and whose statistics have changed since the last invocation of this command.

This list is guaranteed to be sorted into increasing order.

The list of {agentnum state} for which the state changed.

This list contains at most 5000 agent(s), and is guaranteed to be sorted into increasing order.

The list of {agentnum} for which a configurable parameter changed.

This list contains at most 5000 agent(s), and is guaranteed to be sorted into increasing order.

The list of {agentnum} that are currently active (running or paused).

This list is guaranteed to be sorted into increasing order.

The list of {agentnum} that are currently configured.

This list is guaranteed to be sorted into increasing order.

The maximum number of agent instances.

The maximum number of agent instances.

The network address of the host where the MIMIC simulator is running.

The network address of the host where the MIMIC simulator is running.

The number of clients currently connected to the daemon.

The number of clients currently connected to the daemon.

The product number that is licensed.

The product number that is licensed.

The return mode.

The OpenAPI daemon operates in two modes, nocatch, where error returns from MIMIC operations return error; or catch, where the TCL catch semantics are used (these are similar to C++ exceptions)

The set of network interfaces that can be used for simulations.

The set of network interfaces that can be used for simulations.

The set of protocols supported by the Simulator.

The set of protocols supported by the Simulator.

This command can be used as a predicate to ascertain the existence of a given variable.

It returns "1" if the variable exists, else "0".

This command can be used as a predicate to ascertain the persistence of a given variable.

It returns "1" if the variable is persistent, else "0".

This command will return the list of variables in the said scope.

The list will be a Tcl format list with curly braces "{}" around each list element. These elements in turn are space separated.

This predicate indicates if the currently loaded agent configuration file has changed.

Whether the loaded agent configuration file has changed since the last time this predicate was queried. This allows for a client to detect agent configuration changes and to synchronize those changes from the MIMIC daemon.

timeout in seconds for retransmitting INFORM PDUs.

The agent will retransmit INFORM PDUs at this interval until it has received a reply from the manager.

write community string

write community string