gambitcomm.local – mimic
This is the API for MIMIC client to connect to MIMIC daemon.
- Homepage
- https://api.apis.guru/v2/specs/gambitcomm.local:mimic/21.00.json
- Provider
- gambitcomm.local:mimic / mimic
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/gambitcomm.local/mimic/21.00/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/gambitcomm.local/mimic/21.00/openapi.yaml
Tools (358)
Extracted live via the executor SDK.
-
access.accessAddAdds/Overwrites the user entry in the access control database.
-
access.accessDelUsing '' for user clears all the users.
-
access.accessGetAcldbIf nothing is specified then this returns "".
-
access.accessGetAdmindirIf 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. )
-
access.accessGetAdminuserIf nothing is specified in admin/settings.cfg then returns "".
-
access.accessGetEnabled0 indicates that it is disabled, 1 indicates it is enabled.
-
access.accessListEach entry consists of user, agents (in minimal range representation) and access mask (not used currently).
-
access.accessLoadIf filename is not specified then the currently set 'acldb' parameter is used.
-
access.accessSaveIf filename is not specified then the currently set 'acldb' parameter is used.
-
access.accessSetAcldbThis will be used for subsequent load and save operations.
-
access.accessSetEnabled0 indicates disabled, 1 indicates enabled.
-
agent.addIpaliasport 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 port is set to 0, the system will automatically select a port number. This is useful for client-mode protocols, such as TFTP or TOD. Upon start of an IP alias with a 0 (auto-assigned) port number, its port will change to contain the value of the selected system port.
-
agent.addTimerScriptAdd a new timer script to be executed at specified interval (in msec) with the specified argument.
-
agent.agentRemoveFor speed, this operation will complete asynchronously. The same synchronization considerations apply as in /mimic/agent/start.
-
agent.agentStoreCopyThis command copies the variable store from the other agent to this agent.
-
agent.agentStoreExistsIt returns "1" if the variable exists, else "0".
-
agent.agentStoreGetThe value will be returned as a string (like all Tcl values).
-
agent.agentStoreListThe list will be a Tcl format list with curly braces "{}" around each list element. These elements in turn are space separated.
-
agent.agentStoreLreplaceThese 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.
-
agent.agentStorePersistsIt returns "1" if the variable is persistent, else "0".
-
agent.agentStoreSetThe 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 a new one. The optional persist flag can be used to indicate if the variable is to be persistent as described above. By default a value of '0' will be implied for the persist flag. To avoid mistakes, for existing variables the persist flag can only be set. If you want to reset it, you first need to unset the variable.
-
agent.agentStoreUnsetThis will cleanup persistent variables if needed
-
agent.delIpaliasport defaults to 161 if not specified.
-
agent.delTimerScriptThe first scheduled script that matches the script name, and optionally the interval and argument will be deleted.
-
agent.fromAddAn 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.
-
agent.fromDelAn 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.
-
agent.fromListThis in effect implements source-address-indexing, where 2 agents with the same address can be configured, each accepting messages from different management stations.
-
agent.getAgentState0-Unknown 1-Running 2-Stopped 3-Halted 4-Paused 5-Deleted 6-Stopping
-
agent.getChangedhas the agent value space changed?
-
agent.getConfigChangedhas the lab configuration changed?
-
agent.getDelayThe minimum granularity is 10 msec.
-
agent.getDropsdrop rate (every N-th PDU). 0 means no drops.
-
agent.getHostCurrently, 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.
-
agent.getInformTimeoutThe agent will retransmit INFORM PDUs at this interval until it has received a reply from the manager.
-
agent.getInterfacenetwork interface card for the agent.
-
agent.getMasksubnet mask of the agent.
-
agent.getMibsset of MIBs, simulations and scenarios
-
agent.getNumberStartsThis count is incremented each time an agent starts. It affects the SNMPv3 EngineBoots parameter.
-
agent.getOiddirMIB directory of the agent.
-
agent.getOwnerowner of the agent.
-
agent.getPdusizeThe limit for this configurable is 65536.
-
agent.getPortport number
-
agent.getPrivdirprivate directory of the agent.
-
agent.getProtocolsprotocols supported by agent as an array of strings
-
agent.getReadCommunityread community string
-
agent.getScenfirst scenario name
-
agent.getSimfirst simulation name
-
agent.getStarttimerelative start time
-
agent.getStateChangedhas the agent state changed?
-
agent.getStatisticsThe 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
-
agent.getTraceSNMP PDU tracing
-
agent.getValidateIs a bitmask in which with the following bits (from LSB) check for type, length, range, access
-
agent.getWriteCommunitywrite community string
-
agent.haltHalt the current agent.
-
agent.listIpaliasesThe 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.
-
agent.listTimerScriptsThe 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}.
-
agent.newAdd an agent.
-
agent.pauseNowPause the current agent.
-
agent.protocolGetConfigReturns the protocol's configuration.
-
agent.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 existing connections).
-
agent.resumeResume the current agent.
-
agent.saveSave agent MIB values.
-
agent.setDelayThe minimum granularity is 10 msec.
-
agent.setDrops0 means no drops
-
agent.setHostCurrently, 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.
-
agent.setInformTimeoutThe agent will retransmit INFORM PDUs at this interval until it has received a reply from the manager.
-
agent.setInterfacenetwork interface card for the agent
-
agent.setMasksubnet mask of the agent.
-
agent.setMibsset of MIBs, simulations and scenarios
-
agent.setOiddirMIB directory of the agent.
-
agent.setOwnerowner of the agent
-
agent.setPdusizeThe limit for this configurable is 65536
-
agent.setPortport number
-
agent.setPrivdirprivate directory of the agent.
-
agent.setProtocolsprotocols supported by agent as a comma-separated list
-
agent.setReadCommunityread community string
-
agent.setStarttimerelative start time
-
agent.setTraceSNMP PDU tracing
-
agent.setValidateIs 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.
-
agent.setWriteCommunitywrite community string
-
agent.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 rely on the agent to have completed startup, you should wait for it's state to become RUNNING.
-
agent.startIpaliasport defaults to 161 if not specified.
-
agent.statusIpaliasport defaults to 161 if not specified.
-
agent.stopAgent primary IP address
-
agent.stopIpaliasport defaults to 161 if not specified.
-
agent.trapConfigAddAdd a trap destination to the set of destinations.
-
agent.trapConfigDelRemove a trap destination from the set of destinations.
-
agent.trapConfigListEach trap destination is identified with an IP address and a port number. The default port number is the standard SNMP trap port 162.
-
agent.trapListList the outstanding asynchronous traps for this agent instance.
-
coap.protocolCoapGetArgsAgent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
coap.protocolCoapGetConfigAgent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
coap.protocolCoapGetStatisticsStatistics of fields indicated in the headers
-
coap.protocolCoapGetStatsHdrThe headers of statistics fields
-
coap.protocolCoapGetTraceTrace 1 means enabled, 0 means not
-
coap.protocolCoapSetConfigAgent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
coap.protocolCoapSetTrace1 to enable, 0 to disable
-
daemon.addDaemonTimerScriptAdd a new timer script to be executed at specified interval (in msec) with the specified argument.
-
daemon.cfgLoadLoad agents in cfgFile from firstAgentNum to lastAgentNum on startAgentNum of current configuration
-
daemon.cfgNewClear the lab configuration.
-
daemon.cfgSaveSave the lab configuration.
-
daemon.cfgSaveasSave the lab configuration in file.
-
daemon.delDaemonTimerScriptThe first scheduled script that matches the script name, and optionally the interval and argument will be deleted.
-
daemon.getActiveDataListThis list is guaranteed to be sorted into increasing order.
-
daemon.getActiveListThis list is guaranteed to be sorted into increasing order.
-
daemon.getCfgfileIn the case of multi-user access this command returns a different configuration file loaded for each user.
-
daemon.getCfgFileChangedWhether 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.
-
daemon.getChangedConfigListThis list contains at most 5000 agent(s), and is guaranteed to be sorted into increasing order.
-
daemon.getChangedStateListThis list contains at most 5000 agent(s), and is guaranteed to be sorted into increasing order.
-
daemon.getClientsThe number of clients currently connected to the daemon.
-
daemon.getConfiguredListThis list is guaranteed to be sorted into increasing order.
-
daemon.getDaemonProtocolsThe set of protocols supported by the Simulator.
-
daemon.getInterfacesThe set of network interfaces that can be used for simulations.
-
daemon.getLastThe last configured agent instance.
-
daemon.getLogThe current log file for the Simulator.
-
daemon.getMaxThe maximum number of agent instances.
-
daemon.getNetaddrThe network address of the host where the MIMIC simulator is running.
-
daemon.getNetdevThe default network device to be used for agent addresses if the interface is not explicitly specified for an agent.
-
daemon.getProductThe product number that is licensed.
-
daemon.getReturnThe 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)
-
daemon.getVersionThe version of the MIMIC command interface.
-
daemon.listDaemonTimerScriptsThe 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}.
-
daemon.mgetInfoGet multiple sets of information about MIMIC, where infoArray is one of the parameters defined in the mimic get command.
-
daemon.setLogThe current log file for the Simulator.
-
daemon.setNetdevThe network address of the host where the MIMIC simulator is running.
-
daemon.startAllAgentsStart MIMIC.
-
daemon.stopAllAgentsStop MIMIC.
-
daemon.storeExistsIt returns "1" if the variable exists, else "0".
-
daemon.storeGetThe value will be returned as a string (like all Tcl values).
-
daemon.storeListThe list will be a Tcl format list with curly braces "{}" around each list element. These elements in turn are space separated.
-
daemon.storeLreplaceThese 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.
-
daemon.storePersistsIt returns "1" if the variable is persistent, else "0".
-
daemon.storeSaveThe MIMIC daemon caches persistent objects and their changes, and writes them to disk at program termination. If it were to crash, these changes would be lost. This operation allows to checkpoint the cache, ie. write changes to persistent objects to disk. To save the lab configuration with per-agent persistent information the mimic save operation needs to be used.
-
daemon.storeSetPersist 1 means persistent , 0 means non-persistent
-
daemon.storeUnsetThis will cleanup persistent variables if needed
-
daemon.terminateTerminate the MIMIC daemon.
-
dhcp.protocolDhcpGetArgsAgent's DHCP configuration particulars
-
dhcp.protocolDhcpGetConfigAgent's DHCP configuration hwaddr,classid,add_options,script
-
dhcp.protocolDhcpGetStatisticsStatistics of fields indicated in the headers
-
dhcp.protocolDhcpGetStatsHdrThe headers of statistics fields
-
dhcp.protocolDhcpGetTraceTrace 1 means enabled, 0 means not
-
dhcp.protocolDhcpParamsDHCP-OFFER message parameters
-
dhcp.protocolDhcpSetConfigAgent's DHCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
dhcp.protocolDhcpSetTrace1 to enable, 0 to disable
-
ipmi.protocolIpmiGetArgsAgent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
ipmi.protocolIpmiGetAttrAttribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N
-
ipmi.protocolIpmiGetConfigAgent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
ipmi.protocolIpmiGetStatisticsStatistics of fields indicated in the headers
-
ipmi.protocolIpmiGetStatsHdrThe headers of statistics fields
-
ipmi.protocolIpmiGetTraceTrace 1 means enabled, 0 means not
-
ipmi.protocolIpmiSetAttrAttribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N
-
ipmi.protocolIpmiSetConfigAgent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
ipmi.protocolIpmiSetTrace1 to enable, 0 to disable
-
mqtt.protocolMqttClientGetProtstate0 - stopped, 2 - disconnected, 3 - connecting, 4 - connected, 5 - waiting for CONNACK, 6 - waiting for SUBACK, 7 - CONNACK received, in steady state
-
mqtt.protocolMqttClientGetState0 means stopped, 1 means running
-
mqtt.protocolMqttClientMessageCard0 or more
-
mqtt.protocolMqttClientMessageGetAttribute can be topic, interval, count, sent , pre, post, properties(list of PUBLISH properties), properties.i (i-th PUBLISH property), properties.PROP-NAME (PUBLISH property with name PROP-NAME)
-
mqtt.protocolMqttClientMessageSetAttribute 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.
-
mqtt.protocolMqttClientResubscribeRestarts a subscription
-
mqtt.protocolMqttClientRuntimeAbortAbort a connection
-
mqtt.protocolMqttClientRuntimeConnectStart a connection
-
mqtt.protocolMqttClientRuntimeDisconnectGraceful disconnect
-
mqtt.protocolMqttClientSetBrokerBroker IP address
-
mqtt.protocolMqttClientSetCleansession1 for clean session , 0 not
-
mqtt.protocolMqttClientSetClientidMQTT client ID
-
mqtt.protocolMqttClientSetKeepaliveKeep alive the TCP connection
-
mqtt.protocolMqttClientSetOnDisconnectAction to take when MQTT session is disconnected
-
mqtt.protocolMqttClientSetPasswordClient password
-
mqtt.protocolMqttClientSetPorttarget TCP port
-
mqtt.protocolMqttClientSetUsernameClient username
-
mqtt.protocolMqttClientSetWillmsgWill message
-
mqtt.protocolMqttClientSetWillqosQOS field
-
mqtt.protocolMqttClientSetWillretainRetaining will
-
mqtt.protocolMqttClientSetWilltopicWill topic for the will message
-
mqtt.protocolMqttClientSubscribeCard0 or more
-
mqtt.protocolMqttClientSubscribeGetAttribute can be topic, properties(list of SUBSCRIBE properties), properties.i (i-th SUBSCRIBE property), properties.PROP-NAME (SUBSCRIBE property with name PROP-NAME)
-
mqtt.protocolMqttClientSubscribeSetAttribute can not be properties .
-
mqtt.protocolMqttClientUnsubscribeStops a subscription
-
mqtt.protocolMqttGetArgsAgent's MQTT configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
mqtt.protocolMqttGetConfigAgent's MQTT configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
mqtt.protocolMqttGetStatisticsStatistics of fields indicated in the headers
-
mqtt.protocolMqttGetStatsHdrThe headers of statistics fields
-
mqtt.protocolMqttGetTraceTrace 1 means enabled, 0 means not
-
mqtt.protocolMqttSetConfigAgent's MQTT configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
mqtt.protocolMqttSetTrace1 to enable, 0 to disable
-
netflow.protocolNetflowChangeAttrChange attributes
-
netflow.protocolNetflowChangeDfsInterval in msec .
-
netflow.protocolNetflowChangeTfsInterval in msec .
-
netflow.protocolNetflowGetArgsAgent's NETFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
netflow.protocolNetflowGetConfigAgent's NETFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
netflow.protocolNetflowGetStatisticsStatistics of fields indicated in the headers
-
netflow.protocolNetflowGetStatsHdrThe headers of statistics fields
-
netflow.protocolNetflowGetTraceTrace 1 means enabled, 0 means not
-
netflow.protocolNetflowHaltHalt NETFLOW traffic
-
netflow.protocolNetflowListShow list of NETFLOW exports
-
netflow.protocolNetflowReloadReload NETFLOW configuration before resuming traffic
-
netflow.protocolNetflowResumeResuming traffic
-
netflow.protocolNetflowSetCollectorAllow changing collector without stopping agent
-
netflow.protocolNetflowSetConfigAgent's NETFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
netflow.protocolNetflowSetFileNameAllow reloading the configuration file for an agent without stopping agent
-
netflow.protocolNetflowSetTrace1 to enable, 0 to disable
-
proxy.protocolProxyGetArgsAgent's PROXY configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
proxy.protocolProxyGetConfigAgent's PROXY configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
proxy.protocolProxyGetStatisticsStatistics of fields indicated in the headers
-
proxy.protocolProxyGetStatsHdrThe headers of statistics fields
-
proxy.protocolProxyGetTraceTrace 1 means enabled, 0 means not
-
proxy.protocolProxyPortAddAdditional proxy target
-
proxy.protocolProxyPortIsstartedCheck individual target
-
proxy.protocolProxyPortListList all proxy targets
-
proxy.protocolProxyPortRemoveRemove proxy target
-
proxy.protocolProxyPortStartStart additional target
-
proxy.protocolProxyPortStopStop additional target
-
proxy.protocolProxySetConfigAgent's PROXY configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
proxy.protocolProxySetTrace1 to enable, 0 to disable
-
sflow.protocolSflowGetArgsAgent's SFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
sflow.protocolSflowGetConfigAgent's SFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
sflow.protocolSflowGetStatisticsStatistics of fields indicated in the headers
-
sflow.protocolSflowGetStatsHdrThe headers of statistics fields
-
sflow.protocolSflowGetTraceTrace 1 means enabled, 0 means not
-
sflow.protocolSflowHaltHalt SFLOW traffic
-
sflow.protocolSflowReloadReload SFLOW configuration before resuming traffic
-
sflow.protocolSflowResumeResuming traffic
-
sflow.protocolSflowSetConfigAgent's SFLOW configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
sflow.protocolSflowSetTrace1 to enable, 0 to disable
-
snmptcp.protocolSnmptcpGetArgsAgent's SNMPTCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
snmptcp.protocolSnmptcpGetConfigAgent's SNMPTCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
snmptcp.protocolSnmptcpGetStatisticsStatistics of fields indicated in the headers
-
snmptcp.protocolSnmptcpGetStatsHdrThe headers of statistics fields
-
snmptcp.protocolSnmptcpGetTraceTrace 1 means enabled, 0 means not
-
snmptcp.protocolSnmptcpIpaliasDisableBy default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
-
snmptcp.protocolSnmptcpIpaliasEnableBy default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
-
snmptcp.protocolSnmptcpIpaliasIsenabledBy default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
-
snmptcp.protocolSnmptcpIpaliasListBy default, the MIMIC SNMPTCP server listens on all the IP addresses (aliases) that are configured for an agent
-
snmptcp.protocolSnmptcpSetConfigAgent's SNMPTCP configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
snmptcp.protocolSnmptcpSetTrace1 to enable, 0 to disable
-
snmPv3.protocolSnmpv3AccessAddAdds a new access entry with the specified parameters.
-
snmPv3.protocolSnmpv3AccessClearClears all access entries.
-
snmPv3.protocolSnmpv3AccessDelDeletes the specified access entry.
-
snmPv3.protocolSnmpv3AccessListReturns the current acccess entries as an array of strings.
-
snmPv3.protocolSnmpv3GetConfigReturns the SNMPv3 configuration.
-
snmPv3.protocolSnmpv3GetContextEngineidRetrieves the contextEngineID for the agent instance.
-
snmPv3.protocolSnmpv3GetEnginebootsRetrieves the number of times the agent has been restarted.
-
snmPv3.protocolSnmpv3GetEngineidFor stopped agents, this operation is meaningless. If not explicitly set by the user then the autogenerated engineID is returned. The format of the engineID is in the familiar hex format, eg. \x01 23 45 67 89...
-
snmPv3.protocolSnmpv3GetEnginetimeRetrieves the time in seconds for which the agent has been running.
-
snmPv3.protocolSnmpv3GroupAddAdds a new group entry with the specified parameters.
-
snmPv3.protocolSnmpv3GroupClearClears all group entries.
-
snmPv3.protocolSnmpv3GroupDelDeletes the specified group entry.
-
snmPv3.protocolSnmpv3GroupListReturns the current group entries as an array of strings.
-
snmPv3.protocolSnmpv3SetConfigChanges the SNMPv3 configuration.
-
snmPv3.protocolSnmpv3UserAddAdds a new user entry with the specified parameters.
-
snmPv3.protocolSnmpv3UserClearClears all user entries.
-
snmPv3.protocolSnmpv3UserDelDeletes the specified user entry.
-
snmPv3.protocolSnmpv3UserListReturns the current user entries as a Tcl list.
-
snmPv3.protocolSnmpv3UsmSaveSaves current user settings in the currently loaded USM config file.
-
snmPv3.protocolSnmpv3UsmSaveasSaves current user settings in the specified USM config file.
-
snmPv3.protocolSnmpv3VacmSaveSaves current group, access, view settings in the currently loaded VACM config file.
-
snmPv3.protocolSnmpv3VacmSaveasSaves current group, access, view settings in the specified VACM config file.
-
snmPv3.protocolSnmpv3ViewAddAdds a new view entry with the specified parameters.
-
snmPv3.protocolSnmpv3ViewClearClears all view entries.
-
snmPv3.protocolSnmpv3ViewDelDeletes the specified view entry.
-
snmPv3.protocolSnmpv3ViewListReturns the current view entries as an array of strings.
-
ssh.protocolSshGetArgsAgent's SSH configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
ssh.protocolSshGetConfigAgent's SSH configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
ssh.protocolSshGetStatisticsStatistics of fields indicated in the headers
-
ssh.protocolSshGetStatsHdrThe headers of statistics fields
-
ssh.protocolSshGetTraceTrace 1 means enabled, 0 means not
-
ssh.protocolSshIpaliasDisableBy default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
-
ssh.protocolSshIpaliasEnableBy default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
-
ssh.protocolSshIpaliasIsenabledBy default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
-
ssh.protocolSshIpaliasListBy default, the MIMIC SSH server listens on all the IP addresses (aliases) that are configured for an agent
-
ssh.protocolSshSetConfigAgent's SSH configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
ssh.protocolSshSetTrace1 to enable, 0 to disable
-
syslog.protocolSyslogGetArgsAgent's SYSLOG configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
syslog.protocolSyslogGetAttrAttribute can be server , sequence , separator , hostname , timestamp
-
syslog.protocolSyslogGetConfigAgent's SYSLOG configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
syslog.protocolSyslogGetStatisticsStatistics of fields indicated in the headers
-
syslog.protocolSyslogGetStatsHdrThe headers of statistics fields
-
syslog.protocolSyslogGetTraceTrace 1 means enabled, 0 means not
-
syslog.protocolSyslogSend1 to enable, 0 to disable
-
syslog.protocolSyslogSetAttrAttribute can be server , sequence , separator , hostname , timestamp
-
syslog.protocolSyslogSetConfigAgent's SYSLOG configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
syslog.protocolSyslogSetTrace1 to enable, 0 to disable
-
telnet.protocolTelnetConnectionLogonLogon change allows (hidden) commands for a different access mode to run.
-
telnet.protocolTelnetConnectionRequestEquivalent of the command typed in by the user.
-
telnet.protocolTelnetConnectionSignalSignal name is either connect or idle
-
telnet.protocolTelnetGetArgsAgent's TELNET configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
telnet.protocolTelnetGetConfigAgent's TELNET configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
telnet.protocolTelnetGetStatisticsStatistics of fields indicated in the headers
-
telnet.protocolTelnetGetStatsHdrThe headers of statistics fields
-
telnet.protocolTelnetGetTraceTrace 1 means enabled, 0 means not
-
telnet.protocolTelnetIpaliasDisableBy default, the MIMIC TELNET server listens on all the IP addresses (aliases) that are configured for an agent
-
telnet.protocolTelnetIpaliasEnableBy default, the MIMIC TELNET server listens on all the IP addresses (aliases) that are configured for an agent
-
telnet.protocolTelnetIpaliasIsenabledBy default, the MIMIC TELNET server listens on all the IP addresses (aliases) that are configured for an agent
-
telnet.protocolTelnetIpaliasListBy default, the MIMIC TELNET server listens on all the IP addresses (aliases) that are configured for an agent
-
telnet.protocolTelnetServerGetConnectionsIDs of all connected connections
-
telnet.protocolTelnetServerGetKeymapKeymap file name
-
telnet.protocolTelnetServerGetRulesdbRules db file name
-
telnet.protocolTelnetServerGetStateReturn 1 means accepting connections, 0 not
-
telnet.protocolTelnetServerGetUserdbUser db file name
-
telnet.protocolTelnetServerGetUsersList of users
-
telnet.protocolTelnetSetConfigAgent's TELNET configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
telnet.protocolTelnetSetTrace1 to enable, 0 to disable
-
tftp.protocolTftpGetArgsAgent's TFTP configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
tftp.protocolTftpGetConfigAgent's TFTP configuration
-
tftp.protocolTftpGetStatisticsStatistics of fields indicated in the headers
-
tftp.protocolTftpGetStatsHdrThe headers of statistics fields
-
tftp.protocolTftpGetTraceTrace 1 means enabled, 0 means not
-
tftp.protocolTftpSessionGetParameterParameter is server , port , or dstfile
-
tftp.protocolTftpSessionReadSession ID is returned
-
tftp.protocolTftpSessionSetParameterParameter is server , port , or dstfile
-
tftp.protocolTftpSessionStartStart uploading or downloading the file
-
tftp.protocolTftpSessionStatusStatus includes running state, bytes transfered, and time elapsed
-
tftp.protocolTftpSessionStopStop uploading or downloading the file
-
tftp.protocolTftpSessionWriteSession ID is returned
-
tftp.protocolTftpSetConfigAgent's TFTP configuration
-
tftp.protocolTftpSetTrace1 to enable, 0 to disable
-
tod.protocolTodGetArgsAgent's TOD configuration
-
tod.protocolTodGetConfigAgent's TOD configuration
-
tod.protocolTodGetStatisticsStatistics of fields indicated in the headers
-
tod.protocolTodGetStatsHdrThe headers of statistics fields
-
tod.protocolTodGettimeRetrive time from server
-
tod.protocolTodGetTraceTrace 1 means enabled, 0 means not
-
tod.protocolTodSetConfigAgent's TOD configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
tod.protocolTodSetTrace1 to enable, 0 to disable
-
valuespace.addThe object needs to specify the MIB object with the INDEX clause, usually an object whose name ends with Entry.
-
valuespace.evalValueEvaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.
-
valuespace.getInfoReturn the syntactical information for the specified object, such as type, size, range, enumerations, and ACCESS.
-
valuespace.getInstancesThis enables MIB browsing of the MIB on the current agent.
-
valuespace.getMibThis will only return a MIB name if the object is unmistakeably defined in a MIB.
-
valuespace.getNameReturn the symbolic name of the specified object identifier.
-
valuespace.getObjectsThis command is similar to the ls or dir operating system commands to list filesystem directories.
-
valuespace.getOidReturn the numeric OID of the specified object.
-
valuespace.getStateTo disable traversal into a MIB object and any subtree underneath, set the state to 0, else set the state to 1.
-
valuespace.getValueGet a variable in the Value Space.
-
valuespace.getVariablesThis enables variable browsing of the MIB on the current agent.
-
valuespace.mevalValueEvaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.
-
valuespace.mgetValueThis is a performance optimization of the mimic value get command, to be used when many variables are requested.
-
valuespace.msetValueThis is a performance optimization of the mimic value set command, to be used when many variables are to be set.
-
valuespace.munsetValueThis is a performance optimization of the mimic value unset command, to be used when many variables are to be unset.
-
valuespace.removeThe object needs to specify the MIB object with the INDEX clause, usually an object whose name ends with Entry.
-
valuespace.setStateTo disable traversal into a MIB object and any subtree underneath, set the state to 0, else set the state to 1.
-
valuespace.setValueNOTE to set a binary string value, specify a string starting with \x followed by pairs of hexadecimal digits, eg. "\x 01 23 45". This command also assigns SNMP PDU action scripts for GET* and SET requests on a MIB object. The instance parameter must be 0. The following variables enable actions, g - The specified TCL script will be run on GET or GETNEXT requests. It has to exist under the simulation directory. s - The specified script will be run on SET requests. It has to exist under the simulation directory. This command also controls advanced trap generation functionality. The following variables control trap generation r, tu, c - These variables together represent the rate settings for the trap. r and tu is the actual per second rate and c represents the total duration in seconds for which the trap is sent. As soon as the c variable is set, the trap generation begins, for this reason it should be the last variable set for a particular trap. The following variables have to be set before setting the c variable to modify the behavior of the generated trap(s). OBJECT - An object name when used as a variable is looked up during the trap send and the value of that variable is included in the PDU. OBJECT.i - This type of variable will be used to assign an optional instance for the specified object in the traps varbind. The value of this variable identifies the index. e.g. The commands below will send ifIndex.2 with a value of 5 in the linkUp trap PDU. i - This variable is used to specify any extra version specific information to the trap generation code. Here is what it can be used to represent for various SNMP versions SNMPv1 - [community_string][,[enterprise][,agent_addr]] SNMPv2c - community_string SNMPv2 - source_party,destination_party,context SNMPv3 - user_name,context v - This variable lets the user override the version of the PDU being generated. The possible values are - "1", "2c", "2" and "3". o - This variable is used for traps that need extra variables to be added to the PDU along with the ones defined in the MIB as its variables. This lets the user force extra objects (along with instances if needed). All variables to be sent need to be assigned to the o variable. O - To omit any variables which are defined in the MIB you can use the O (capital o) variable. This needs to be set to the list of OIDs of the variable bindings in the order defined in the MIB. ip - The variable ip is used for generating the trap from the N-th IP alias address. a - This variable associates an action script to the trap or INFORM request. The action script specified in the value of this variable has to exist in the simulation directory. It will be executed before each instance of the trap is sent out. I - This optional variable controls the generation of INFORM PDUs. An INFORM is sent only if the variable is non-zero, else a TRAP is generated. R, T, E - This variable associates an action script to the INFORM request. The action script specified in the value of this variable has to exist in the simulation directory. The action script associated with the R variable will be executed on receiving a INFORM RESPONSE, the one associated with the T variable on a timeout (ie. no response), the one associated with the E variable on a report PDU. eid.IP-ADDRESS.PORT - control variable allows to configure message authoritative engine id for the destination specified by IP-ADDRESS and optionally by PORT. eb.IP-ADDRESS.PORT - control variable allows to configure message authoritative engine boots. et.IP-ADDRESS.PORT - control variable allows to configure message authoritative engine time.*
-
valuespace.splitOidThis is useful if you have an OID which is a combination of object and instance.
-
valuespace.unsetValueOnly variables that have previously been set can be unset.
-
web.protocolWebGetArgsAgent's WEB configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
web.protocolWebGetConfigAgent's WEB configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
web.protocolWebGetStatisticsStatistics of fields indicated in the headers
-
web.protocolWebGetStatsHdrThe headers of statistics fields
-
web.protocolWebGetTraceTrace 1 means enabled, 0 means not
-
web.protocolWebPortAddAdd port
-
web.protocolWebPortExistsCheck the port. 1 means existing, 0 means not
-
web.protocolWebPortRemoveRemove port
-
web.protocolWebPortSetSet port
-
web.protocolWebPortStartStart port
-
web.protocolWebPortStopStop port
-
web.protocolWebSetConfigAgent's WEB configuration with port,rule,prompt,paging_prompt,userdb,keymap
-
web.protocolWebSetTrace1 to enable, 0 to disable
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools