MIMIC REST API
  1. MQTT
MIMIC REST API
  • Access
    • Adds/Overwrites the user entry in the access control database.
    • Clears a users entry from access control database.
    • Returns the current access control database in use.
    • Returns the current admin directory.
    • Returns the current administrator.
    • Returns the state of access control checking.
    • Returns an array of entries.
    • Loads the specified file for access control data.
    • Saves current access control data in specified file.
    • Allows setting the name of the current access control database.
    • Allows the user to enable/disable the access control check.
  • Agent
    • Add an agent.
    • Add a source address that the agent will accept messages from.
    • delete a source address that the agent will accept messages from.
    • List the source addresses that the agent will accept messages from.
    • has the agent value space changed?
    • has the lab configuration changed?
    • one-way transit delay in msec.
    • drop rate (every N-th PDU). 0 means no drops.
    • host address of the agent.
    • timeout in seconds for retransmitting INFORM PDUs.
    • network interface card for the agent.
    • subnet mask of the agent.
    • set of MIBs, simulations and scenarios
    • number of starts for the agent.
    • MIB directory of the agent.
    • owner of the agent.
    • maximum PDU size.
    • port number
    • private directory of the agent.
    • protocols supported by agent
    • read community string
    • first scenario name
    • first simulation name
    • relative start time
    • current running state of the agent
    • has the agent state changed?
    • current statistics of the agent instance
    • SNMP PDU tracing
    • SNMP SET validation policy.
    • write community string
    • Halt the current agent.
    • Adds a new ipalias for the agent.
    • Deletes an existing ipalias from the agent.
    • Lists all the additional ipaliases configured for the agent.
    • Starts an existing ipalias for the agent.
    • Returns the status (0=down, 1=up) of an existing ipalias for the agent.
    • Stops an existing ipalias for the agent.
    • Pause the current agent.
    • Returns the protocol's configuration.
    • Reload the current agent.
    • Remove the current agent.
    • Resume the current agent.
    • Save agent MIB values.
    • one-way transit delay in msec
    • drop rate (every N-th PDU)
    • host address of the agent.
    • timeout in seconds for retransmitting INFORM PDUs
    • network interface card for the agent
    • subnet mask of the agent.
    • set of MIBs, simulations and scenarios
    • MIB directory of the agent.
    • owner of the agent
    • maximum PDU size
    • port number
    • private directory of the agent.
    • protocols supported by agent as a comma-separated list
    • read community string
    • relative start time
    • SNMP PDU tracing
    • SNMP SET validation policy
    • write community string
    • Start the current agent.
    • Show the agent's primary IP address
    • This command copies the variable store from the other agent to this agent.
    • This command can be used as a predicate to ascertain the existence of a given variable.
    • Fetches the value associated with a variable.
    • This command will return the list of variables in the said scope.
    • These commands treat the variable as a list, and allow to replace an entry in the list at the specified index with the specified value. The variable has to already exist.
    • This command can be used as a predicate to ascertain the persistence of a given variable.
    • These commands allow the creation of a new variable, or changing an existing value.
    • Deletes a variable which is currently defined.
    • Add a new timer script to be executed at specified interval (in msec) with the specified argument.
    • Remove a timer script from the execution list.
    • List the timer scripts currently running along with the their intervals.
    • Add a trap destination to the set of destinations.
    • Remove a trap destination from the set of destinations.
    • List the set of trap destinations for this agent instance.
    • List the outstanding asynchronous traps for this agent instance.
  • COAP
    • Show the agent's COAP argument structure
    • Show the agent's COAP configuration
    • Show the agent's COAP statistics
    • Show the agent's COAP traffic tracing
    • Set the agent's COAP configuration
    • Set the agent's COAP traffic tracing
    • Show the COAP statistics headers
  • DHCP
    • Show the agent's DHCP argument structure
    • Show the agent's DHCP configuration
    • Show the agent's DHCP statistics
    • Show the agent's DHCP traffic tracing
    • Show the parameters configured by the server in its DHCP-OFFER message
    • Set the agent's DHCP configuration
    • Set the agent's DHCP traffic tracing
    • Show the DHCP statistics headers
  • IPMI
    • Show the agent's IPMI argument structure
    • Show the agent's IPMI configuration
    • Show the agent's IPMI statistics
    • Show the agent's IPMI traffic tracing
    • Show the outgoing message's attributes
    • Set the agent's IPMI configuration
    • Set the agent's IPMI traffic tracing
    • Set the outgoing message's attributes
    • Show the IPMI statistics headers
  • MQTT
    • Show the agent's MQTT TCP connection state
      GET
    • Show the agent's MQTT state
      GET
    • Show the agent's current messages' cardinality
      GET
    • Show the agent's message attributes
      GET
    • Set the agent's message attributes
      PUT
    • Restart receiving messages from a subcription of the agent
      PUT
    • Abort agent's MQTT TCP session without sending DISCONNECT command
      PUT
    • Start agent's MQTT TCP session
      PUT
    • Disconnect agent's MQTT TCP session by sending DISCONNECT command
      PUT
    • Set the agent's MQTT TCP connection target broker
      PUT
    • Set the agent's MQTT session
      PUT
    • Set the agent's MQTT client ID
      PUT
    • Set the agent's MQTT TCP keepalive
      PUT
    • Set the agent's MQTT disconnection action
      PUT
    • Set the agent's MQTT client password
      PUT
    • Set the agent's MQTT TCP connection target port
      PUT
    • Set the agent's MQTT client username
      PUT
    • Set the agent's MQTT client's will
      PUT
    • Set the agent's MQTT will message's QOS field
      PUT
    • Set the agent's MQTT retained will
      PUT
    • Set the agent's MQTT client will's topic
      PUT
    • Show the agent's current subscriptions' cardinality
      GET
    • Show the agent's subscription attributes
      GET
    • Set the agent's subscribe attributes
      PUT
    • Stops receiving messages from a subcription of the agent
      PUT
    • Show the agent's MQTT argument structure
      GET
    • Show the agent's MQTT configuration
      GET
    • Show the agent's MQTT statistics
      GET
    • Show the agent's MQTT traffic tracing
      GET
    • Set the agent's MQTT configuration
      PUT
    • Set the agent's MQTT traffic tracing
      PUT
    • Show the MQTT statistics headers
      GET
  • NETFLOW
    • Change NETFLOW data export interval
    • Change NETFLOW template export interval
    • Change NETFLOW export attributes
    • Show list of NETFLOW exports
    • Show the agent's NETFLOW argument structure
    • Show the agent's NETFLOW configuration
    • Show the agent's NETFLOW statistics
    • Show the agent's NETFLOW traffic tracing
    • Halt NETFLOW traffic
    • Reload NETFLOW configuration before resuming traffic
    • Resuming traffic
    • Swap NETFLOW collector
    • Set the agent's NETFLOW configuration
    • Swap NETFLOW configuration file
    • Set the agent's NETFLOW traffic tracing
    • Show the NETFLOW statistics headers
  • PROXY
    • Show the agent's PROXY argument structure
    • Show the agent's PROXY configuration
    • Show the agent's PROXY statistics
    • Show the agent's PROXY traffic tracing
    • Add individual proxy target on the agent and the simulator host
    • Check individual target
    • List all proxy targets
    • Remove individual proxy target on the agent and the simulator host
    • Start additional target
    • Stop additional target
    • Set the agent's PROXY configuration
    • Set the agent's PROXY traffic tracing
    • Show the PROXY statistics headers
  • SFLOW
    • Show the agent's SFLOW argument structure
    • Show the agent's SFLOW configuration
    • Show the agent's SFLOW statistics
    • Show the agent's SFLOW traffic tracing
    • Halt SFLOW traffic
    • Reload SFLOW configuration before resuming traffic
    • Resuming traffic
    • Set the agent's SFLOW configuration
    • Set the agent's SFLOW traffic tracing
    • Show the SFLOW statistics headers
  • SNMPTCP
    • Show the agent's SNMPTCP argument structure
    • Show the agent's SNMPTCP configuration
    • Show the agent's SNMPTCP statistics
    • Show the agent's SNMPTCP traffic tracing
    • Disable individual IP aliases on the agent and the simulator host
    • Enable individual IP aliases on the agent and the simulator host
    • Check individual IP aliases on the agent and the simulator host
    • List all IP aliases on the agent and the simulator host
    • Set the agent's SNMPTCP configuration
    • Set the agent's SNMPTCP traffic tracing
    • Show the SNMPTCP statistics headers
  • SNMPv3
    • Adds a new access entry with the specified parameters.
    • Clears all access entries.
    • Deletes the specified access entry.
    • Returns the current acccess entries as an array of strings.
    • Returns the SNMPv3 configuration.
    • Retrieves the contextEngineID for the agent instance.
    • Retrieves the number of times the agent has been restarted.
    • For started agents, retrieves the current engineID in use by the snmpv3 module.
    • Retrieves the time in seconds for which the agent has been running.
    • Adds a new group entry with the specified parameters.
    • Clears all group entries.
    • Deletes the specified group entry.
    • Returns the current group entries as an array of strings.
    • Changes the SNMPv3 configuration.
    • Adds a new user entry with the specified parameters.
    • Clears all user entries.
    • Deletes the specified user entry.
    • Returns the current user entries as a Tcl list.
    • Saves current user settings in the currently loaded USM config file.
    • Saves current user settings in the specified USM config file.
    • Saves current group, access, view settings in the currently loaded VACM config file.
    • Saves current group, access, view settings in the specified VACM config file.
    • Adds a new view entry with the specified parameters.
    • Clears all view entries.
    • Deletes the specified view entry.
    • Returns the current view entries as an array of strings.
  • SSH
    • Show the agent's SSH argument structure
    • Show the agent's SSH configuration
    • Show the agent's SSH statistics
    • Show the agent's SSH traffic tracing
    • Disable individual IP aliases on the agent and the simulator host
    • Enable individual IP aliases on the agent and the simulator host
    • Check individual IP aliases on the agent and the simulator host
    • List all IP aliases on the agent and the simulator host
    • Set the agent's SSH configuration
    • Set the agent's SSH traffic tracing
    • Show the SSH statistics headers
  • SYSLOG
    • Show the agent's SYSLOG argument structure
    • Show the agent's SYSLOG configuration
    • Show the agent's SYSLOG statistics
    • Show the agent's SYSLOG traffic tracing
    • Show the outgoing message's attributes
    • Set the agent's SYSLOG traffic tracing
    • Set the agent's SYSLOG configuration
    • Set the agent's SYSLOG traffic tracing
    • Set the outgoing message's attributes
    • Show the SYSLOG statistics headers
  • TELNET
    • Changes the connection's current logon.
    • Executes the command asynchronously .
    • Triggers the asynchronous signal event with the specified signal name
    • Show the agent's TELNET argument structure
    • Show the agent's TELNET configuration
    • Show the agent's TELNET statistics
    • Show the agent's TELNET traffic tracing
    • Disable individual IP aliases on the agent and the simulator host
    • Enable individual IP aliases on the agent and the simulator host
    • Check individual IP aliases on the agent and the simulator host
    • List all IP aliases on the agent and the simulator host
    • Show the agent's TELNET connections
    • Show the agent's TELNET keymap file name
    • Show the agent's TELNET rules db file name
    • Show the agent's TELNET server state
    • Show the agent's TELNET user db file name
    • Show the agent's TELNET users
    • Set the agent's TELNET configuration
    • Set the agent's TELNET traffic tracing
    • Show the TELNET statistics headers
  • TFTP
    • Show the agent's TFTP argument structure
    • Show the agent's TFTP configuration
    • Show the agent's TFTP statistics
    • Show the agent's TFTP traffic tracing
    • Create a read session to download srcfile from server
    • Create a read session to upload srcfile to server
    • Set the agent's TFTP configuration
    • Set the agent's TFTP traffic tracing
    • Show a parameter of a TFTP sesssion
    • Set a parameter of a TFTP sesssion
    • Start a TFTP sesssion
    • Check a TFTP sesssion's status
    • Stop a TFTP sesssion
    • Show the TFTP statistics headers
  • TOD
    • Show the agent's TOD argument structure
    • Show the agent's TOD configuration
    • Show the agent's TOD statistics
    • Show the agent's TOD traffic tracing
    • Retrieve TOD time
    • Set the agent's TOD configuration
    • Set the agent's TOD traffic tracing
    • Show the TOD statistics headers
  • WEB
    • Show the agent's WEB argument structure
    • Show the agent's WEB configuration
    • Show the agent's WEB statistics
    • Show the agent's WEB traffic tracing
    • Add the agent's WEB port
    • Show the agent's WEB port
    • Remove the agent's WEB port
    • Set the agent's WEB port attribute
    • Start the agent's WEB port
    • Stop the agent's WEB port
    • Set the agent's WEB configuration
    • Set the agent's WEB traffic tracing
    • Show the WEB statistics headers
  • Valuespace
    • Add an entry to a table.
    • Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.
    • Get a variable in the Value Space.
    • Return the syntactical information for the specified object, such as type, size, range, enumerations, and ACCESS.
    • Display the MIB object instances for the specified object.
    • Display the MIB objects below the current position
    • Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.
    • Get multiple variables in the Value Space.
    • Return the MIB that defines the specified object.
    • Set multiple variables in the Value Space.
    • Unset multiple variables in the Value Space
    • Return the symbolic name of the specified object identifier.
    • Return the numeric OID of the specified object.
    • Remove an entry from a table.
    • Set a variable in the Value Space.
    • Split the numerical OID into the object OID and instance OID.
    • Get the state of a MIB object object.
    • Set the state of a MIB object object
    • Unset a variable in the Value Space in order to free its memory.
    • Display the variables for the specified instance instance for the specified MIB object object
  • Daemon
    • Clear the lab configuration.
    • The list of {agentnum {statistics}} for agents that are currently active and whose statistics have changed since the last invocation of this command.
    • The list of {agentnum} that are currently active (running or paused).
    • The currently loaded lab configuration file for the particular user.
    • This predicate indicates if the currently loaded agent configuration file has changed.
    • The list of {agentnum} for which a configurable parameter changed.
    • The list of {agentnum state} for which the state changed.
    • The number of clients currently connected to the daemon.
    • The list of {agentnum} that are currently configured.
    • The set of network interfaces that can be used for simulations.
    • The last configured agent instance.
    • The current log file for the Simulator.
    • The maximum number of agent instances.
    • The network address of the host where the MIMIC simulator is running.
    • The default network device to be used for agent addresses.
    • The product number that is licensed.
    • The set of protocols supported by the Simulator.
    • The return mode.
    • The version of the MIMIC command interface.
    • Load the lab configuration file file.
    • Get multiple sets of information about MIMIC, where infoArray is one of the parameters defined in the mimic get command.
    • Save the lab configuration.
    • Save the lab configuration in file.
    • The current log file for the Simulator.
    • The network address of the host where the MIMIC simulator is running.
    • This operation flushes all global objects which need to be made persistent to disk.
    • Start MIMIC.
    • Stop MIMIC.
    • This command can be used as a predicate to ascertain the existence of a given variable.
    • Fetches the value associated with a variable.
    • This command will return the list of variables in the said scope.
    • These commands treat the variable as a list, and allow to replace an entry in the list at the specified index with the specified value. The variable has to already exist.
    • This command can be used as a predicate to ascertain the persistence of a given variable.
    • Set the variable store for the global storage
    • Deletes a variable which is currently defined.
    • Terminate the MIMIC daemon.
    • Add a new timer script to be executed at specified interval (in msec) with the specified argument.
    • Remove a timer script from the execution list.
    • List the timer scripts currently running along with the their intervals.
  1. MQTT

Start agent's MQTT TCP session

http://gambitcomm.local
http://gambitcomm.local
http://gambitcomm.local
http://gambitcomm.local
PUT
/mimic/agent/{agentNum}/protocol/msg/mqtt/client/runtime/connect
Start a connection
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'http://gambitcomm.local/mimic/agent//protocol/msg/mqtt/client/runtime/connect'
Response Response Example
200 - Example 1
[
    "string"
]

Request

Path Params

Responses

🟢200successful operation
application/json
Body

🟠400Invalid agent number value
Modified at 2022-09-10 22:56:55
Previous
Abort agent's MQTT TCP session without sending DISCONNECT command
Next
Disconnect agent's MQTT TCP session by sending DISCONNECT command
Built with