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