Gambit Communications

MIMIC REST API

This is the API for MIMIC client to connect to MIMIC daemon.

IoT & devices#openapi#iot

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the API for MIMIC client to connect to MIMIC daemon.

Endpoints 356

Access

  • POSTAdds/Overwrites the user entry in the access control database./mimic/access/add/:user/:agents/:maskAdds/Overwrites the user entry in the access control database.
  • DELETEClears a users entry from access control database./mimic/access/del/:userUsing '*' for user clears all the users.
  • GETReturns the current access control database in use./mimic/access/get/acldbIf nothing is specified then this returns "".
  • GETReturns the current admin directory./mimic/access/get/admindirIf 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…
  • GETReturns the current administrator./mimic/access/get/adminuserIf nothing is specified in admin/settings.cfg then returns "".
  • GETReturns the state of access control checking./mimic/access/get/enabled0 indicates that it is disabled, 1 indicates it is enabled.
  • GETReturns an array of entries./mimic/access/listEach entry consists of user, agents (in minimal range representation) and access mask (not used currently).
  • PUTLoads the specified file for access control data./mimic/access/load/:filenameIf filename is not specified then the currently set 'acldb' parameter is used.
  • PUTSaves current access control data in specified file./mimic/access/save/:filenameIf filename is not specified then the currently set 'acldb' parameter is used.
  • PUTAllows setting the name of the current access control database./mimic/access/set/acldb/:databaseNameThis will be used for subsequent load and save operations.
  • PUTAllows the user to enable/disable the access control check./mimic/access/set/enabled/:enabledOrNot0 indicates disabled, 1 indicates enabled.

Agent

  • POSTAdd an agent./mimic/agent/:agentNum/add/:IPAdd an agent.
  • POSTAdd a source address that the agent will accept messages from./mimic/agent/:agentNum/from/add/:IP/:portAn 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,…
  • DELETEdelete a source address that the agent will accept messages from./mimic/agent/:agentNum/from/delete/:IP/:portAn 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,…
  • GETList the source addresses that the agent will accept messages from./mimic/agent/:agentNum/from/listThis in effect implements source-address-indexing, where 2 agents with the same address can be configured, each accepting messages from different management…
  • GEThas the agent value space changed?/mimic/agent/:agentNum/get/changedhas the agent value space changed?
  • GEThas the lab configuration changed?/mimic/agent/:agentNum/get/config_changedhas the lab configuration changed?
  • GETone-way transit delay in msec./mimic/agent/:agentNum/get/delayThe minimum granularity is 10 msec.
  • GETdrop rate (every N-th PDU). 0 means no drops./mimic/agent/:agentNum/get/dropsdrop rate (every N-th PDU). 0 means no drops.
  • GEThost address of the agent./mimic/agent/:agentNum/get/hostCurrently, 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.
  • GETtimeout in seconds for retransmitting INFORM PDUs./mimic/agent/:agentNum/get/inform_timeoutThe agent will retransmit INFORM PDUs at this interval until it has received a reply from the manager.
  • GETnetwork interface card for the agent./mimic/agent/:agentNum/get/interfacenetwork interface card for the agent.
  • GETsubnet mask of the agent./mimic/agent/:agentNum/get/masksubnet mask of the agent.
  • GETset of MIBs, simulations and scenarios/mimic/agent/:agentNum/get/mibsset of MIBs, simulations and scenarios
  • GETnumber of starts for the agent./mimic/agent/:agentNum/get/num_startsThis count is incremented each time an agent starts. It affects the SNMPv3 EngineBoots parameter.
  • GETMIB directory of the agent./mimic/agent/:agentNum/get/oiddirMIB directory of the agent.
  • GETowner of the agent./mimic/agent/:agentNum/get/ownerowner of the agent.
  • GETmaximum PDU size./mimic/agent/:agentNum/get/pdusizeThe limit for this configurable is 65536.
  • GETport number/mimic/agent/:agentNum/get/portport number
  • GETprivate directory of the agent./mimic/agent/:agentNum/get/privdirprivate directory of the agent.
  • GETprotocols supported by agent/mimic/agent/:agentNum/get/protocolprotocols supported by agent as an array of strings
  • GETread community string/mimic/agent/:agentNum/get/readread community string
  • GETfirst scenario name/mimic/agent/:agentNum/get/scenfirst scenario name
  • GETfirst simulation name/mimic/agent/:agentNum/get/simfirst simulation name
  • GETrelative start time/mimic/agent/:agentNum/get/startrelative start time
  • GETcurrent running state of the agent/mimic/agent/:agentNum/get/state0-Unknown 1-Running 2-Stopped 3-Halted 4-Paused 5-Deleted 6-Stopping
  • GEThas the agent state changed?/mimic/agent/:agentNum/get/state_changedhas the agent state changed?
  • GETcurrent statistics of the agent instance/mimic/agent/:agentNum/get/statisticsThe statistics are returned as 64-bit decimal numbers for the following statistics, total, discarded, error, GET, GETNEXT, SET, GETBULK, trap, GET variables,…
  • GETSNMP PDU tracing/mimic/agent/:agentNum/get/traceSNMP PDU tracing
  • GETSNMP SET validation policy./mimic/agent/:agentNum/get/validateIs a bitmask in which with the following bits (from LSB) check for type, length, range, access
  • GETwrite community string/mimic/agent/:agentNum/get/writewrite community string
  • PUTHalt the current agent./mimic/agent/:agentNum/haltHalt the current agent.
  • POSTAdds a new ipalias for the agent./mimic/agent/:agentNum/ipalias/add/:IP/:port/:mask/:interfaceport defaults to 161 if not specified. mask defaults to the class-based network mask for the address. interface defaults to the default network interface. If…
  • DELETEDeletes an existing ipalias from the agent./mimic/agent/:agentNum/ipalias/delete/:IP/:portport defaults to 161 if not specified.
  • GETLists all the additional ipaliases configured for the agent./mimic/agent/:agentNum/ipalias/listThe 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.
  • PUTStarts an existing ipalias for the agent./mimic/agent/:agentNum/ipalias/start/:IP/:portport defaults to 161 if not specified.
  • GETReturns the status (0=down, 1=up) of an existing ipalias for the agent./mimic/agent/:agentNum/ipalias/status/:IP/:portport defaults to 161 if not specified.
  • PUTStops an existing ipalias for the agent./mimic/agent/:agentNum/ipalias/stop/:IP/:portport defaults to 161 if not specified.
  • PUTPause the current agent./mimic/agent/:agentNum/pausePause the current agent.
  • GETReturns the protocol's configuration./mimic/agent/:agentNum/protocol/:prot/get/configReturns the protocol's configuration.
  • PUTReload the current agent./mimic/agent/:agentNum/reloadThis only works for halted agents. The net effect is the same as restarting an agent (ie. stop, start, halt), but without disconnecting the network (and thus…
  • DELETERemove the current agent./mimic/agent/:agentNum/removeFor speed, this operation will complete asynchronously. The same synchronization considerations apply as in /mimic/agent/start.
  • PUTResume the current agent./mimic/agent/:agentNum/resumeResume the current agent.
  • PUTSave agent MIB values./mimic/agent/:agentNum/saveSave agent MIB values.
  • PUTone-way transit delay in msec/mimic/agent/:agentNum/set/delay/:delayThe minimum granularity is 10 msec.
  • PUTdrop rate (every N-th PDU)/mimic/agent/:agentNum/set/drops/:drops0 means no drops
  • PUThost address of the agent./mimic/agent/:agentNum/set/host/:hostCurrently, 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.
  • PUTtimeout in seconds for retransmitting INFORM PDUs/mimic/agent/:agentNum/set/inform_timeout/:inform_timeoutThe agent will retransmit INFORM PDUs at this interval until it has received a reply from the manager.
  • PUTnetwork interface card for the agent/mimic/agent/:agentNum/set/interface/:interfacenetwork interface card for the agent
  • PUTsubnet mask of the agent./mimic/agent/:agentNum/set/mask/:masksubnet mask of the agent.
  • PUTset of MIBs, simulations and scenarios/mimic/agent/:agentNum/set/mibsset of MIBs, simulations and scenarios
  • PUTMIB directory of the agent./mimic/agent/:agentNum/set/oiddir/:oiddirMIB directory of the agent.
  • PUTowner of the agent/mimic/agent/:agentNum/set/owner/:ownerowner of the agent
  • PUTmaximum PDU size/mimic/agent/:agentNum/set/pdusize/:pdusizeThe limit for this configurable is 65536
  • PUTport number/mimic/agent/:agentNum/set/port/:portport number
  • PUTprivate directory of the agent./mimic/agent/:agentNum/set/privdir/:privdirprivate directory of the agent.
  • PUTprotocols supported by agent as a comma-separated list/mimic/agent/:agentNum/set/protocolprotocols supported by agent as a comma-separated list
  • PUTread community string/mimic/agent/:agentNum/set/read/:readread community string
  • PUTrelative start time/mimic/agent/:agentNum/set/start/:startrelative start time
  • PUTSNMP PDU tracing/mimic/agent/:agentNum/set/trace/:traceSNMP PDU tracing
  • PUTSNMP SET validation policy/mimic/agent/:agentNum/set/validate/:validateIs a bitmask in which with the following bits (from LSB) check for type, length, range, access. A default value of 65535 does all validation checking.
  • PUTwrite community string/mimic/agent/:agentNum/set/write/:writewrite community string
  • PUTStart the current agent./mimic/agent/:agentNum/startFor speed, this operation will complete asynchronously. A successful return from this command means the starting of the agent is in progress. If you need to…
  • PUTShow the agent's primary IP address/mimic/agent/:agentNum/stopAgent primary IP address
  • PUTThis command copies the variable store from the other agent to this agent./mimic/agent/:agentNum/store/copy/:otherAgentThis command copies the variable store from the other agent to this agent.
  • GETThis command can be used as a predicate to ascertain the existence of a given variable./mimic/agent/:agentNum/store/exists/:varIt returns "1" if the variable exists, else "0".
  • GETFetches the value associated with a variable./mimic/agent/:agentNum/store/get/:varThe value will be returned as a string (like all Tcl values).
  • GETThis command will return the list of variables in the said scope./mimic/agent/:agentNum/store/listThe list will be a Tcl format list with curly braces "{}" around each list element. These elements in turn are space separated.
  • PUTThese 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./mimic/agent/:agentNum/store/lreplace/:var/:indexThese 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…
  • GETThis command can be used as a predicate to ascertain the persistence of a given variable./mimic/agent/:agentNum/store/persists/:varIt returns "1" if the variable is persistent, else "0".
  • PUTThese commands allow the creation of a new variable, or changing an existing value./mimic/agent/:agentNum/store/set/:var/:persistThe append sub-command will append the value to an existing variable, or create a new one. The set sub-command will overwrite an existing variable, or create…
  • PUTDeletes a variable which is currently defined./mimic/agent/:agentNum/store/unset/:varThis will cleanup persistent variables if needed
  • POSTAdd a new timer script to be executed at specified interval (in msec) with the specified argument./mimic/agent/:agentNum/timer/script/add/:script/:interval/:argAdd a new timer script to be executed at specified interval (in msec) with the specified argument.
  • DELETERemove a timer script from the execution list./mimic/agent/:agentNum/timer/script/delete/:script/:interval/:argThe first scheduled script that matches the script name, and optionally the interval and argument will be deleted.
  • GETList the timer scripts currently running along with the their intervals./mimic/agent/:agentNum/timer/script/listThe command mimic timer script list lists global timer scripts, the command /mimic/timer/script/{agentNum}/list is the per-agent equivalent NOTE Global timer…
  • POSTAdd a trap destination to the set of destinations./mimic/agent/:agentNum/trap/config/add/:IP/:portAdd a trap destination to the set of destinations.
  • DELETERemove a trap destination from the set of destinations./mimic/agent/:agentNum/trap/config/delete/:IP/:portRemove a trap destination from the set of destinations.
  • GETList the set of trap destinations for this agent instance./mimic/agent/:agentNum/trap/config/listEach trap destination is identified with an IP address and a port number. The default port number is the standard SNMP trap port 162.
  • GETList the outstanding asynchronous traps for this agent instance./mimic/agent/:agentNum/trap/listList the outstanding asynchronous traps for this agent instance.

COAP

  • GETShow the agent's COAP argument structure/mimic/agent/:agentNum/protocol/msg/coap/get/argsAgent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's COAP configuration/mimic/agent/:agentNum/protocol/msg/coap/get/configAgent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's COAP statistics/mimic/agent/:agentNum/protocol/msg/coap/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's COAP traffic tracing/mimic/agent/:agentNum/protocol/msg/coap/get/traceTrace 1 means enabled, 0 means not
  • PUTSet the agent's COAP configuration/mimic/agent/:agentNum/protocol/msg/coap/set/config/:argument/:valueAgent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's COAP traffic tracing/mimic/agent/:agentNum/protocol/msg/coap/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the COAP statistics headers/mimic/protocol/msg/coap/get/stats_hdrThe headers of statistics fields

DHCP

  • GETShow the agent's DHCP argument structure/mimic/agent/:agentNum/protocol/msg/dhcp/get/argsAgent's DHCP configuration particulars
  • GETShow the agent's DHCP configuration/mimic/agent/:agentNum/protocol/msg/dhcp/get/configAgent's DHCP configuration hwaddr,classid,add_options,script
  • GETShow the agent's DHCP statistics/mimic/agent/:agentNum/protocol/msg/dhcp/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's DHCP traffic tracing/mimic/agent/:agentNum/protocol/msg/dhcp/get/traceTrace 1 means enabled, 0 means not
  • GETShow the parameters configured by the server in its DHCP-OFFER message/mimic/agent/:agentNum/protocol/msg/dhcp/paramsDHCP-OFFER message parameters
  • PUTSet the agent's DHCP configuration/mimic/agent/:agentNum/protocol/msg/dhcp/set/config/:argument/:valueAgent's DHCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's DHCP traffic tracing/mimic/agent/:agentNum/protocol/msg/dhcp/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the DHCP statistics headers/mimic/protocol/msg/dhcp/get/stats_hdrThe headers of statistics fields

IPMI

  • GETShow the agent's IPMI argument structure/mimic/agent/:agentNum/protocol/msg/ipmi/get/argsAgent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's IPMI configuration/mimic/agent/:agentNum/protocol/msg/ipmi/get/configAgent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's IPMI statistics/mimic/agent/:agentNum/protocol/msg/ipmi/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's IPMI traffic tracing/mimic/agent/:agentNum/protocol/msg/ipmi/get/traceTrace 1 means enabled, 0 means not
  • GETShow the outgoing message's attributes/mimic/agent/:agentNum/protocol/msg/ipmi/get/:attrAttribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N
  • PUTSet the agent's IPMI configuration/mimic/agent/:agentNum/protocol/msg/ipmi/set/config/:argument/:valueAgent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's IPMI traffic tracing/mimic/agent/:agentNum/protocol/msg/ipmi/set/trace/:enableOrNot1 to enable, 0 to disable
  • PUTSet the outgoing message's attributes/mimic/agent/:agentNum/protocol/msg/ipmi/set/:attr/:valueAttribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N
  • GETShow the IPMI statistics headers/mimic/protocol/msg/ipmi/get/stats_hdrThe headers of statistics fields

MQTT

  • GETShow the agent's MQTT TCP connection state/mimic/agent/:agentNum/protocol/msg/mqtt/client/get/protstate0 - stopped, 2 - disconnected, 3 - connecting, 4 - connected, 5 - waiting for CONNACK, 6 - waiting for SUBACK, 7 - CONNACK received, in steady state
  • GETShow the agent's MQTT state/mimic/agent/:agentNum/protocol/msg/mqtt/client/get/state0 means stopped, 1 means running
  • GETShow the agent's current messages' cardinality/mimic/agent/:agentNum/protocol/msg/mqtt/client/message/card0 or more
  • GETShow the agent's message attributes/mimic/agent/:agentNum/protocol/msg/mqtt/client/message/get/:msgNum/:attrAttribute can be topic, interval, count, sent , pre, post, properties(list of PUBLISH properties), properties.i (i-th PUBLISH property), properties.PROP-NAME…
  • PUTSet the agent's message attributes/mimic/agent/:agentNum/protocol/msg/mqtt/client/message/set/:msgNum/:attr/:valueAttribute can not be sent or properties . Use set/{msgNum}/count/{value} together with get/{msgNum}/count to throttle the outgoing MQTT message to the broker.
  • PUTRestart receiving messages from a subcription of the agent/mimic/agent/:agentNum/protocol/msg/mqtt/client/resubscribe/:subNumRestarts a subscription
  • PUTAbort agent's MQTT TCP session without sending DISCONNECT command/mimic/agent/:agentNum/protocol/msg/mqtt/client/runtime/abortAbort a connection
  • PUTStart agent's MQTT TCP session/mimic/agent/:agentNum/protocol/msg/mqtt/client/runtime/connectStart a connection
  • PUTDisconnect agent's MQTT TCP session by sending DISCONNECT command/mimic/agent/:agentNum/protocol/msg/mqtt/client/runtime/disconnectGraceful disconnect
  • PUTSet the agent's MQTT TCP connection target broker/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/broker/:brokerAddrBroker IP address
  • PUTSet the agent's MQTT session/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/cleansession/:cleanOrNot1 for clean session , 0 not
  • PUTSet the agent's MQTT client ID/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/clientid/:clientIDMQTT client ID
  • PUTSet the agent's MQTT TCP keepalive/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/keepalive/:aliveTimeKeep alive the TCP connection
  • PUTSet the agent's MQTT disconnection action/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/on_disconnect/:actionAction to take when MQTT session is disconnected
  • PUTSet the agent's MQTT client password/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/password/:passwordClient password
  • PUTSet the agent's MQTT TCP connection target port/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/port/:porttarget TCP port
  • PUTSet the agent's MQTT client username/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/username/:usernameClient username
  • PUTSet the agent's MQTT client's will/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/willmsg/:msgWill message
  • PUTSet the agent's MQTT will message's QOS field/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/willqos/:qosQOS field
  • PUTSet the agent's MQTT retained will/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/willretain/:retainRetaining will
  • PUTSet the agent's MQTT client will's topic/mimic/agent/:agentNum/protocol/msg/mqtt/client/set/willtopic/:topicWill topic for the will message
  • GETShow the agent's current subscriptions' cardinality/mimic/agent/:agentNum/protocol/msg/mqtt/client/subscribe/card0 or more
  • GETShow the agent's subscription attributes/mimic/agent/:agentNum/protocol/msg/mqtt/client/subscribe/get/:subNum/:attrAttribute can be topic, properties(list of SUBSCRIBE properties), properties.i (i-th SUBSCRIBE property), properties.PROP-NAME (SUBSCRIBE property with name…
  • PUTSet the agent's subscribe attributes/mimic/agent/:agentNum/protocol/msg/mqtt/client/subscribe/set/:subNum/:attr/:valueAttribute can not be properties .
  • PUTStops receiving messages from a subcription of the agent/mimic/agent/:agentNum/protocol/msg/mqtt/client/unsubscribe/:subNumStops a subscription
  • GETShow the agent's MQTT argument structure/mimic/agent/:agentNum/protocol/msg/mqtt/get/argsAgent's MQTT configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's MQTT configuration/mimic/agent/:agentNum/protocol/msg/mqtt/get/configAgent's MQTT configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's MQTT statistics/mimic/agent/:agentNum/protocol/msg/mqtt/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's MQTT traffic tracing/mimic/agent/:agentNum/protocol/msg/mqtt/get/traceTrace 1 means enabled, 0 means not
  • PUTSet the agent's MQTT configuration/mimic/agent/:agentNum/protocol/msg/mqtt/set/config/:argument/:valueAgent's MQTT configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's MQTT traffic tracing/mimic/agent/:agentNum/protocol/msg/mqtt/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the MQTT statistics headers/mimic/protocol/msg/mqtt/get/stats_hdrThe headers of statistics fields

NETFLOW

  • PUTChange NETFLOW data export interval/mimic/agent/:agentNum/protocol/msg/netflow/flow/change/dfs_interval/:intervalInterval in msec .
  • PUTChange NETFLOW template export interval/mimic/agent/:agentNum/protocol/msg/netflow/flow/change/tfs_interval/:intervalInterval in msec .
  • PUTChange NETFLOW export attributes/mimic/agent/:agentNum/protocol/msg/netflow/flow/change/:flowset-uid/:field-num/:attr/:valueChange attributes
  • GETShow list of NETFLOW exports/mimic/agent/:agentNum/protocol/msg/netflow/flow/listShow list of NETFLOW exports
  • GETShow the agent's NETFLOW argument structure/mimic/agent/:agentNum/protocol/msg/netflow/get/argsAgent's NETFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's NETFLOW configuration/mimic/agent/:agentNum/protocol/msg/netflow/get/configAgent's NETFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's NETFLOW statistics/mimic/agent/:agentNum/protocol/msg/netflow/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's NETFLOW traffic tracing/mimic/agent/:agentNum/protocol/msg/netflow/get/traceTrace 1 means enabled, 0 means not
  • PUTHalt NETFLOW traffic/mimic/agent/:agentNum/protocol/msg/netflow/haltHalt NETFLOW traffic
  • PUTReload NETFLOW configuration before resuming traffic/mimic/agent/:agentNum/protocol/msg/netflow/reloadReload NETFLOW configuration before resuming traffic
  • PUTResuming traffic/mimic/agent/:agentNum/protocol/msg/netflow/resumeResuming traffic
  • PUTSwap NETFLOW collector/mimic/agent/:agentNum/protocol/msg/netflow/set/collector/:collectorIPAllow changing collector without stopping agent
  • PUTSet the agent's NETFLOW configuration/mimic/agent/:agentNum/protocol/msg/netflow/set/config/:argument/:valueAgent's NETFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSwap NETFLOW configuration file/mimic/agent/:agentNum/protocol/msg/netflow/set/filename/:fileNameAllow reloading the configuration file for an agent without stopping agent
  • PUTSet the agent's NETFLOW traffic tracing/mimic/agent/:agentNum/protocol/msg/netflow/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the NETFLOW statistics headers/mimic/protocol/msg/netflow/get/stats_hdrThe headers of statistics fields

PROXY

  • GETShow the agent's PROXY argument structure/mimic/agent/:agentNum/protocol/msg/proxy/get/argsAgent's PROXY configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's PROXY configuration/mimic/agent/:agentNum/protocol/msg/proxy/get/configAgent's PROXY configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's PROXY statistics/mimic/agent/:agentNum/protocol/msg/proxy/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's PROXY traffic tracing/mimic/agent/:agentNum/protocol/msg/proxy/get/traceTrace 1 means enabled, 0 means not
  • POSTAdd individual proxy target on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/proxy/port/add/:port/:target/:targetPortAdditional proxy target
  • GETCheck individual target/mimic/agent/:agentNum/protocol/msg/proxy/port/isStarted/:portCheck individual target
  • GETList all proxy targets/mimic/agent/:agentNum/protocol/msg/proxy/port/list
  • DELETERemove individual proxy target on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/proxy/port/remove/:portRemove proxy target
  • PUTStart additional target/mimic/agent/:agentNum/protocol/msg/proxy/port/start/:portStart additional target
  • PUTStop additional target/mimic/agent/:agentNum/protocol/msg/proxy/port/stop/:portStop additional target
  • PUTSet the agent's PROXY configuration/mimic/agent/:agentNum/protocol/msg/proxy/set/config/:argument/:valueAgent's PROXY configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's PROXY traffic tracing/mimic/agent/:agentNum/protocol/msg/proxy/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the PROXY statistics headers/mimic/protocol/msg/proxy/get/stats_hdrThe headers of statistics fields

SFLOW

  • GETShow the agent's SFLOW argument structure/mimic/agent/:agentNum/protocol/msg/sflow/get/argsAgent's SFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's SFLOW configuration/mimic/agent/:agentNum/protocol/msg/sflow/get/configAgent's SFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's SFLOW statistics/mimic/agent/:agentNum/protocol/msg/sflow/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's SFLOW traffic tracing/mimic/agent/:agentNum/protocol/msg/sflow/get/traceTrace 1 means enabled, 0 means not
  • PUTHalt SFLOW traffic/mimic/agent/:agentNum/protocol/msg/sflow/haltHalt SFLOW traffic
  • PUTReload SFLOW configuration before resuming traffic/mimic/agent/:agentNum/protocol/msg/sflow/reloadReload SFLOW configuration before resuming traffic
  • PUTResuming traffic/mimic/agent/:agentNum/protocol/msg/sflow/resumeResuming traffic
  • PUTSet the agent's SFLOW configuration/mimic/agent/:agentNum/protocol/msg/sflow/set/config/:argument/:valueAgent's SFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's SFLOW traffic tracing/mimic/agent/:agentNum/protocol/msg/sflow/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the SFLOW statistics headers/mimic/protocol/msg/sflow/get/stats_hdrThe headers of statistics fields

SNMPTCP

  • GETShow the agent's SNMPTCP argument structure/mimic/agent/:agentNum/protocol/msg/snmptcp/get/argsAgent's SNMPTCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's SNMPTCP configuration/mimic/agent/:agentNum/protocol/msg/snmptcp/get/configAgent's SNMPTCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's SNMPTCP statistics/mimic/agent/:agentNum/protocol/msg/snmptcp/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's SNMPTCP traffic tracing/mimic/agent/:agentNum/protocol/msg/snmptcp/get/traceTrace 1 means enabled, 0 means not
  • PUTDisable individual IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/snmptcp/ipalias/disable/:ipaddress/:portBy default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
  • PUTEnable individual IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/snmptcp/ipalias/enable/:ipaddress/:portBy default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
  • GETCheck individual IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/snmptcp/ipalias/isenabled/:ipaddress/:portBy default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
  • GETList all IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/snmptcp/ipalias/listBy default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
  • PUTSet the agent's SNMPTCP configuration/mimic/agent/:agentNum/protocol/msg/snmptcp/set/config/:argument/:valueAgent's SNMPTCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's SNMPTCP traffic tracing/mimic/agent/:agentNum/protocol/msg/snmptcp/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the SNMPTCP statistics headers/mimic/protocol/msg/snmptcp/get/stats_hdrThe headers of statistics fields

SNMPv3

  • POSTAdds a new access entry with the specified parameters./mimic/agent/:agentNum/protocol/msg/snmpv3/access/add/:groupName/:prefix/:securityModel/:securityLevel/:contextMatch/:readView/:writeView/:notifyViewAdds a new access entry with the specified parameters.
  • DELETEClears all access entries./mimic/agent/:agentNum/protocol/msg/snmpv3/access/clearClears all access entries.
  • DELETEDeletes the specified access entry./mimic/agent/:agentNum/protocol/msg/snmpv3/access/del/:accessNameDeletes the specified access entry.
  • GETReturns the current acccess entries as an array of strings./mimic/agent/:agentNum/protocol/msg/snmpv3/access/listReturns the current acccess entries as an array of strings.
  • GETReturns the SNMPv3 configuration./mimic/agent/:agentNum/protocol/msg/snmpv3/get/configReturns the SNMPv3 configuration.
  • GETRetrieves the contextEngineID for the agent instance./mimic/agent/:agentNum/protocol/msg/snmpv3/get/context_engineidRetrieves the contextEngineID for the agent instance.
  • GETRetrieves the number of times the agent has been restarted./mimic/agent/:agentNum/protocol/msg/snmpv3/get/enginebootsRetrieves the number of times the agent has been restarted.
  • GETFor started agents, retrieves the current engineID in use by the snmpv3 module./mimic/agent/:agentNum/protocol/msg/snmpv3/get/engineidFor stopped agents, this operation is meaningless. If not explicitly set by the user then the autogenerated engineID is returned. The format of the engineID…
  • GETRetrieves the time in seconds for which the agent has been running./mimic/agent/:agentNum/protocol/msg/snmpv3/get/enginetimeRetrieves the time in seconds for which the agent has been running.
  • POSTAdds a new group entry with the specified parameters./mimic/agent/:agentNum/protocol/msg/snmpv3/group/add/:groupName/:securityModel/:securityNameAdds a new group entry with the specified parameters.
  • DELETEClears all group entries./mimic/agent/:agentNum/protocol/msg/snmpv3/group/clearClears all group entries.
  • DELETEDeletes the specified group entry./mimic/agent/:agentNum/protocol/msg/snmpv3/group/del/:groupNameDeletes the specified group entry.
  • GETReturns the current group entries as an array of strings./mimic/agent/:agentNum/protocol/msg/snmpv3/group/listReturns the current group entries as an array of strings.
  • PUTChanges the SNMPv3 configuration./mimic/agent/:agentNum/protocol/msg/snmpv3/set/config/:parameter/:valueChanges the SNMPv3 configuration.
  • POSTAdds a new user entry with the specified parameters./mimic/agent/:agentNum/protocol/msg/snmpv3/user/add/:userName/:securityName/:authProtocol/:authKey/:privProtocol/:privKeyAdds a new user entry with the specified parameters.
  • DELETEClears all user entries./mimic/agent/:agentNum/protocol/msg/snmpv3/user/clearClears all user entries.
  • DELETEDeletes the specified user entry./mimic/agent/:agentNum/protocol/msg/snmpv3/user/del/:userNameDeletes the specified user entry.
  • GETReturns the current user entries as a Tcl list./mimic/agent/:agentNum/protocol/msg/snmpv3/user/listReturns the current user entries as a Tcl list.
  • PUTSaves current user settings in the currently loaded USM config file./mimic/agent/:agentNum/protocol/msg/snmpv3/usm/saveSaves current user settings in the currently loaded USM config file.
  • PUTSaves current user settings in the specified USM config file./mimic/agent/:agentNum/protocol/msg/snmpv3/usm/saveas/:filenameSaves current user settings in the specified USM config file.
  • PUTSaves current group, access, view settings in the currently loaded VACM config file./mimic/agent/:agentNum/protocol/msg/snmpv3/vacm/saveSaves current group, access, view settings in the currently loaded VACM config file.
  • PUTSaves current group, access, view settings in the specified VACM config file./mimic/agent/:agentNum/protocol/msg/snmpv3/vacm/saveas/:filenameSaves current group, access, view settings in the specified VACM config file.
  • POSTAdds a new view entry with the specified parameters./mimic/agent/:agentNum/protocol/msg/snmpv3/view/add/:viewName/:viewType/:subtree/:maskAdds a new view entry with the specified parameters.
  • DELETEClears all view entries./mimic/agent/:agentNum/protocol/msg/snmpv3/view/clearClears all view entries.
  • DELETEDeletes the specified view entry./mimic/agent/:agentNum/protocol/msg/snmpv3/view/del/:viewNameDeletes the specified view entry.
  • GETReturns the current view entries as an array of strings./mimic/agent/:agentNum/protocol/msg/snmpv3/view/listReturns the current view entries as an array of strings.

SSH

  • GETShow the agent's SSH argument structure/mimic/agent/:agentNum/protocol/msg/ssh/get/argsAgent's SSH configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's SSH configuration/mimic/agent/:agentNum/protocol/msg/ssh/get/configAgent's SSH configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's SSH statistics/mimic/agent/:agentNum/protocol/msg/ssh/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's SSH traffic tracing/mimic/agent/:agentNum/protocol/msg/ssh/get/traceTrace 1 means enabled, 0 means not
  • PUTDisable individual IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/ssh/ipalias/disable/:ipaddress/:portBy default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
  • PUTEnable individual IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/ssh/ipalias/enable/:ipaddress/:portBy default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
  • GETCheck individual IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/ssh/ipalias/isenabled/:ipaddress/:portBy default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
  • GETList all IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/ssh/ipalias/listBy default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
  • PUTSet the agent's SSH configuration/mimic/agent/:agentNum/protocol/msg/ssh/set/config/:argument/:valueAgent's SSH configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's SSH traffic tracing/mimic/agent/:agentNum/protocol/msg/ssh/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the SSH statistics headers/mimic/protocol/msg/ssh/get/stats_hdrThe headers of statistics fields

SYSLOG

  • GETShow the agent's SYSLOG argument structure/mimic/agent/:agentNum/protocol/msg/syslog/get/argsAgent's SYSLOG configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's SYSLOG configuration/mimic/agent/:agentNum/protocol/msg/syslog/get/configAgent's SYSLOG configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's SYSLOG statistics/mimic/agent/:agentNum/protocol/msg/syslog/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's SYSLOG traffic tracing/mimic/agent/:agentNum/protocol/msg/syslog/get/traceTrace 1 means enabled, 0 means not
  • GETShow the outgoing message's attributes/mimic/agent/:agentNum/protocol/msg/syslog/get/:attrAttribute can be server , sequence , separator , hostname , timestamp
  • POSTSet the agent's SYSLOG traffic tracing/mimic/agent/:agentNum/protocol/msg/syslog/send/:pri1 to enable, 0 to disable
  • PUTSet the agent's SYSLOG configuration/mimic/agent/:agentNum/protocol/msg/syslog/set/config/:argument/:valueAgent's SYSLOG configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's SYSLOG traffic tracing/mimic/agent/:agentNum/protocol/msg/syslog/set/trace/:enableOrNot1 to enable, 0 to disable
  • PUTSet the outgoing message's attributes/mimic/agent/:agentNum/protocol/msg/syslog/set/:attr/:valueAttribute can be server , sequence , separator , hostname , timestamp
  • GETShow the SYSLOG statistics headers/mimic/protocol/msg/syslog/get/stats_hdrThe headers of statistics fields

TELNET

  • PUTChanges the connection's current logon./mimic/agent/:agentNum/protocol/msg/telnet/connection/logon/:connectionID/:user/:passwordLogon change allows (hidden) commands for a different access mode to run.
  • PUTExecutes the command asynchronously ./mimic/agent/:agentNum/protocol/msg/telnet/connection/request/:connectionID/:commandEquivalent of the command typed in by the user.
  • PUTTriggers the asynchronous signal event with the specified signal name/mimic/agent/:agentNum/protocol/msg/telnet/connection/signal/:connectionID/:signalNameSignal name is either connect or idle
  • GETShow the agent's TELNET argument structure/mimic/agent/:agentNum/protocol/msg/telnet/get/argsAgent's TELNET configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's TELNET configuration/mimic/agent/:agentNum/protocol/msg/telnet/get/configAgent's TELNET configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's TELNET statistics/mimic/agent/:agentNum/protocol/msg/telnet/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's TELNET traffic tracing/mimic/agent/:agentNum/protocol/msg/telnet/get/traceTrace 1 means enabled, 0 means not
  • PUTDisable individual IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/telnet/ipalias/disable/:ipaddress/:portBy default, the MIMIC TELNET server listens on all the IP addresses (aliases) that are configured for an agent
  • PUTEnable individual IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/telnet/ipalias/enable/:ipaddress/:portBy default, the MIMIC TELNET server listens on all the IP addresses (aliases) that are configured for an agent
  • GETCheck individual IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/telnet/ipalias/isenabled/:ipaddress/:portBy default, the MIMIC TELNET server listens on all the IP addresses (aliases) that are configured for an agent
  • GETList all IP aliases on the agent and the simulator host/mimic/agent/:agentNum/protocol/msg/telnet/ipalias/listBy default, the MIMIC TELNET server listens on all the IP addresses (aliases) that are configured for an agent
  • GETShow the agent's TELNET connections/mimic/agent/:agentNum/protocol/msg/telnet/server/get/connectionsIDs of all connected connections
  • GETShow the agent's TELNET keymap file name/mimic/agent/:agentNum/protocol/msg/telnet/server/get/keymapKeymap file name
  • GETShow the agent's TELNET rules db file name/mimic/agent/:agentNum/protocol/msg/telnet/server/get/rulesdbRules db file name
  • GETShow the agent's TELNET server state/mimic/agent/:agentNum/protocol/msg/telnet/server/get/stateReturn 1 means accepting connections, 0 not
  • GETShow the agent's TELNET user db file name/mimic/agent/:agentNum/protocol/msg/telnet/server/get/userdbUser db file name
  • GETShow the agent's TELNET users/mimic/agent/:agentNum/protocol/msg/telnet/server/get/usersList of users
  • PUTSet the agent's TELNET configuration/mimic/agent/:agentNum/protocol/msg/telnet/set/config/:argument/:valueAgent's TELNET configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's TELNET traffic tracing/mimic/agent/:agentNum/protocol/msg/telnet/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the TELNET statistics headers/mimic/protocol/msg/telnet/get/stats_hdrThe headers of statistics fields

TFTP

  • GETShow the agent's TFTP argument structure/mimic/agent/:agentNum/protocol/msg/tftp/get/argsAgent's TFTP configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's TFTP configuration/mimic/agent/:agentNum/protocol/msg/tftp/get/configAgent's TFTP configuration
  • GETShow the agent's TFTP statistics/mimic/agent/:agentNum/protocol/msg/tftp/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's TFTP traffic tracing/mimic/agent/:agentNum/protocol/msg/tftp/get/traceTrace 1 means enabled, 0 means not
  • POSTCreate a read session to download srcfile from server/mimic/agent/:agentNum/protocol/msg/tftp/session/read/server/:srcfileSession ID is returned
  • POSTCreate a read session to upload srcfile to server/mimic/agent/:agentNum/protocol/msg/tftp/session/write/server/:srcfileSession ID is returned
  • PUTSet the agent's TFTP configuration/mimic/agent/:agentNum/protocol/msg/tftp/set/config/:argument/:valueAgent's TFTP configuration
  • PUTSet the agent's TFTP traffic tracing/mimic/agent/:agentNum/protocol/msg/tftp/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow a parameter of a TFTP sesssion/mimic/agent/:agentNum/protocol/msg/tftp/:sessionID/get/:parameterParameter is server , port , or dstfile
  • PUTSet a parameter of a TFTP sesssion/mimic/agent/:agentNum/protocol/msg/tftp/:sessionID/set/:parameter/:valueParameter is server , port , or dstfile
  • PUTStart a TFTP sesssion/mimic/agent/:agentNum/protocol/msg/tftp/:sessionID/startStart uploading or downloading the file
  • GETCheck a TFTP sesssion's status/mimic/agent/:agentNum/protocol/msg/tftp/:sessionID/statusStatus includes running state, bytes transfered, and time elapsed
  • PUTStop a TFTP sesssion/mimic/agent/:agentNum/protocol/msg/tftp/:sessionID/stopStop uploading or downloading the file
  • GETShow the TFTP statistics headers/mimic/protocol/msg/tftp/get/stats_hdrThe headers of statistics fields

TOD

  • GETShow the agent's TOD argument structure/mimic/agent/:agentNum/protocol/msg/tod/get/argsAgent's TOD configuration
  • GETShow the agent's TOD configuration/mimic/agent/:agentNum/protocol/msg/tod/get/configAgent's TOD configuration
  • GETShow the agent's TOD statistics/mimic/agent/:agentNum/protocol/msg/tod/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's TOD traffic tracing/mimic/agent/:agentNum/protocol/msg/tod/get/traceTrace 1 means enabled, 0 means not
  • GETRetrieve TOD time/mimic/agent/:agentNum/protocol/msg/tod/gettime/server/:serverAddr/port/:portNum/script/:scriptName/timeout/:timeSec/retries/:numRetriesRetrive time from server
  • PUTSet the agent's TOD configuration/mimic/agent/:agentNum/protocol/msg/tod/set/config/:argument/:valueAgent's TOD configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's TOD traffic tracing/mimic/agent/:agentNum/protocol/msg/tod/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the TOD statistics headers/mimic/protocol/msg/tod/get/stats_hdrThe headers of statistics fields

WEB

  • GETShow the agent's WEB argument structure/mimic/agent/:agentNum/protocol/msg/web/get/argsAgent's WEB configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's WEB configuration/mimic/agent/:agentNum/protocol/msg/web/get/configAgent's WEB configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • GETShow the agent's WEB statistics/mimic/agent/:agentNum/protocol/msg/web/get/statisticsStatistics of fields indicated in the headers
  • GETShow the agent's WEB traffic tracing/mimic/agent/:agentNum/protocol/msg/web/get/traceTrace 1 means enabled, 0 means not
  • POSTAdd the agent's WEB port/mimic/agent/:agentNum/protocol/msg/web/port/add/:portAdd port
  • GETShow the agent's WEB port/mimic/agent/:agentNum/protocol/msg/web/port/exists/:portCheck the port. 1 means existing, 0 means not
  • DELETERemove the agent's WEB port/mimic/agent/:agentNum/protocol/msg/web/port/remove/:portRemove port
  • PUTSet the agent's WEB port attribute/mimic/agent/:agentNum/protocol/msg/web/port/set/:port/:protocol/:versionSet port
  • PUTStart the agent's WEB port/mimic/agent/:agentNum/protocol/msg/web/port/start/:portStart port
  • PUTStop the agent's WEB port/mimic/agent/:agentNum/protocol/msg/web/port/stop/:portStop port
  • PUTSet the agent's WEB configuration/mimic/agent/:agentNum/protocol/msg/web/set/config/:argument/:valueAgent's WEB configuration with port,rule,prompt,paging_prompt,userdb,keymap
  • PUTSet the agent's WEB traffic tracing/mimic/agent/:agentNum/protocol/msg/web/set/trace/:enableOrNot1 to enable, 0 to disable
  • GETShow the WEB statistics headers/mimic/protocol/msg/web/get/stats_hdrThe headers of statistics fields

Valuespace

  • POSTAdd an entry to a table./mimic/agent/:agentNum/value/add/:object/:instanceThe object needs to specify the MIB object with the INDEX clause, usually an object whose name ends with Entry.
  • GETEvaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests./mimic/agent/:agentNum/value/eval/:object/:instanceEvaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.
  • GETGet a variable in the Value Space./mimic/agent/:agentNum/value/get/:object/:instance/:variableGet a variable in the Value Space.

Showing 300 of 356 endpoints. Fork the collection to see all of them.

API details

Base URL
http://gambitcomm.local
http://127.0.0.1
Authentication
HTTP Basic authentication (username and password)
Operations
356 operations on 356 pathsGET 186PUT 135DELETE 18POST 17
Main resources
Agent 78Daemon 39MQTT 32SNMPv3 26TELNET 20Valuespace 20NETFLOW 16TFTP 14PROXY 13WEB 13
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 21.00
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the MIMIC REST API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the MIMIC REST API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Adds/Overwrites the user entry in the access control database.” (POST /mimic/access/add/:user/:agents/:mask), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the MIMIC REST API?

This is the API for MIMIC client to connect to MIMIC daemon. It is listed under IoT & devices and has 356 endpoints.

Who publishes the MIMIC REST API?

It is listed from Gambit Communications's public API description (an OpenAPI document), not published by Gambit Communications on Swastik Codes. Anyone who controls its domain can claim the profile by adding a DNS TXT record.

What is the base URL of the MIMIC REST API?

Its description lists 2 base URLs: http://gambitcomm.local, http://127.0.0.1. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the MIMIC REST API?

With HTTP Basic authentication (username and password).

How many endpoints does the MIMIC REST API have?

356 operations on 356 paths (186 GET, 135 PUT, 18 DELETE, 17 POST). The largest groups are Agent, Daemon, MQTT, SNMPv3.

Is forking the MIMIC REST API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.