integrations.sh
← all integrations

gambitcomm.local – mimic

OpenAPI apis-guru iot

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.accessAdd

    Adds/Overwrites the user entry in the access control database.

  • access.accessDel

    Using '' for user clears all the users.

  • access.accessGetAcldb

    If nothing is specified then this returns "".

  • access.accessGetAdmindir

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

  • access.accessGetAdminuser

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

  • access.accessGetEnabled

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

  • access.accessList

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

  • access.accessLoad

    If filename is not specified then the currently set 'acldb' parameter is used.

  • access.accessSave

    If filename is not specified then the currently set 'acldb' parameter is used.

  • access.accessSetAcldb

    This will be used for subsequent load and save operations.

  • access.accessSetEnabled

    0 indicates disabled, 1 indicates enabled.

  • agent.addIpalias

    port 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.addTimerScript

    Add a new timer script to be executed at specified interval (in msec) with the specified argument.

  • agent.agentRemove

    For speed, this operation will complete asynchronously. The same synchronization considerations apply as in /mimic/agent/start.

  • agent.agentStoreCopy

    This command copies the variable store from the other agent to this agent.

  • agent.agentStoreExists

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

  • agent.agentStoreGet

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

  • agent.agentStoreList

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

  • agent.agentStoreLreplace

    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.

  • agent.agentStorePersists

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

  • agent.agentStoreSet

    The 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.agentStoreUnset

    This will cleanup persistent variables if needed

  • agent.delIpalias

    port defaults to 161 if not specified.

  • agent.delTimerScript

    The first scheduled script that matches the script name, and optionally the interval and argument will be deleted.

  • agent.fromAdd

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

  • agent.fromDel

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

  • agent.fromList

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

  • agent.getAgentState

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

  • agent.getChanged

    has the agent value space changed?

  • agent.getConfigChanged

    has the lab configuration changed?

  • agent.getDelay

    The minimum granularity is 10 msec.

  • agent.getDrops

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

  • agent.getHost

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

  • agent.getInformTimeout

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

  • agent.getInterface

    network interface card for the agent.

  • agent.getMask

    subnet mask of the agent.

  • agent.getMibs

    set of MIBs, simulations and scenarios

  • agent.getNumberStarts

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

  • agent.getOiddir

    MIB directory of the agent.

  • agent.getOwner

    owner of the agent.

  • agent.getPdusize

    The limit for this configurable is 65536.

  • agent.getPort

    port number

  • agent.getPrivdir

    private directory of the agent.

  • agent.getProtocols

    protocols supported by agent as an array of strings

  • agent.getReadCommunity

    read community string

  • agent.getScen

    first scenario name

  • agent.getSim

    first simulation name

  • agent.getStarttime

    relative start time

  • agent.getStateChanged

    has the agent state changed?

  • agent.getStatistics

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

  • agent.getTrace

    SNMP PDU tracing

  • agent.getValidate

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

  • agent.getWriteCommunity

    write community string

  • agent.halt

    Halt the current agent.

  • agent.listIpaliases

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

  • agent.listTimerScripts

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

  • agent.new

    Add an agent.

  • agent.pauseNow

    Pause the current agent.

  • agent.protocolGetConfig

    Returns the protocol's configuration.

  • agent.reload

    This 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.resume

    Resume the current agent.

  • agent.save

    Save agent MIB values.

  • agent.setDelay

    The minimum granularity is 10 msec.

  • agent.setDrops

    0 means no drops

  • agent.setHost

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

  • agent.setInformTimeout

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

  • agent.setInterface

    network interface card for the agent

  • agent.setMask

    subnet mask of the agent.

  • agent.setMibs

    set of MIBs, simulations and scenarios

  • agent.setOiddir

    MIB directory of the agent.

  • agent.setOwner

    owner of the agent

  • agent.setPdusize

    The limit for this configurable is 65536

  • agent.setPort

    port number

  • agent.setPrivdir

    private directory of the agent.

  • agent.setProtocols

    protocols supported by agent as a comma-separated list

  • agent.setReadCommunity

    read community string

  • agent.setStarttime

    relative start time

  • agent.setTrace

    SNMP PDU tracing

  • agent.setValidate

    Is 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.setWriteCommunity

    write community string

  • agent.start

    For 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.startIpalias

    port defaults to 161 if not specified.

  • agent.statusIpalias

    port defaults to 161 if not specified.

  • agent.stop

    Agent primary IP address

  • agent.stopIpalias

    port defaults to 161 if not specified.

  • agent.trapConfigAdd

    Add a trap destination to the set of destinations.

  • agent.trapConfigDel

    Remove a trap destination from the set of destinations.

  • agent.trapConfigList

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

  • agent.trapList

    List the outstanding asynchronous traps for this agent instance.

  • coap.protocolCoapGetArgs

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

  • coap.protocolCoapGetConfig

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

  • coap.protocolCoapGetStatistics

    Statistics of fields indicated in the headers

  • coap.protocolCoapGetStatsHdr

    The headers of statistics fields

  • coap.protocolCoapGetTrace

    Trace 1 means enabled, 0 means not

  • coap.protocolCoapSetConfig

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

  • coap.protocolCoapSetTrace

    1 to enable, 0 to disable

  • daemon.addDaemonTimerScript

    Add a new timer script to be executed at specified interval (in msec) with the specified argument.

  • daemon.cfgLoad

    Load agents in cfgFile from firstAgentNum to lastAgentNum on startAgentNum of current configuration

  • daemon.cfgNew

    Clear the lab configuration.

  • daemon.cfgSave

    Save the lab configuration.

  • daemon.cfgSaveas

    Save the lab configuration in file.

  • daemon.delDaemonTimerScript

    The first scheduled script that matches the script name, and optionally the interval and argument will be deleted.

  • daemon.getActiveDataList

    This list is guaranteed to be sorted into increasing order.

  • daemon.getActiveList

    This list is guaranteed to be sorted into increasing order.

  • daemon.getCfgfile

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

  • daemon.getCfgFileChanged

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

  • daemon.getChangedConfigList

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

  • daemon.getChangedStateList

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

  • daemon.getClients

    The number of clients currently connected to the daemon.

  • daemon.getConfiguredList

    This list is guaranteed to be sorted into increasing order.

  • daemon.getDaemonProtocols

    The set of protocols supported by the Simulator.

  • daemon.getInterfaces

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

  • daemon.getLast

    The last configured agent instance.

  • daemon.getLog

    The current log file for the Simulator.

  • daemon.getMax

    The maximum number of agent instances.

  • daemon.getNetaddr

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

  • daemon.getNetdev

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

  • daemon.getProduct

    The product number that is licensed.

  • daemon.getReturn

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

  • daemon.getVersion

    The version of the MIMIC command interface.

  • daemon.listDaemonTimerScripts

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

  • daemon.mgetInfo

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

  • daemon.setLog

    The current log file for the Simulator.

  • daemon.setNetdev

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

  • daemon.startAllAgents

    Start MIMIC.

  • daemon.stopAllAgents

    Stop MIMIC.

  • daemon.storeExists

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

  • daemon.storeGet

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

  • daemon.storeList

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

  • daemon.storeLreplace

    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.

  • daemon.storePersists

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

  • daemon.storeSave

    The 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.storeSet

    Persist 1 means persistent , 0 means non-persistent

  • daemon.storeUnset

    This will cleanup persistent variables if needed

  • daemon.terminate

    Terminate the MIMIC daemon.

  • dhcp.protocolDhcpGetArgs

    Agent's DHCP configuration particulars

  • dhcp.protocolDhcpGetConfig

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

  • dhcp.protocolDhcpGetStatistics

    Statistics of fields indicated in the headers

  • dhcp.protocolDhcpGetStatsHdr

    The headers of statistics fields

  • dhcp.protocolDhcpGetTrace

    Trace 1 means enabled, 0 means not

  • dhcp.protocolDhcpParams

    DHCP-OFFER message parameters

  • dhcp.protocolDhcpSetConfig

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

  • dhcp.protocolDhcpSetTrace

    1 to enable, 0 to disable

  • ipmi.protocolIpmiGetArgs

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

  • ipmi.protocolIpmiGetAttr

    Attribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N

  • ipmi.protocolIpmiGetConfig

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

  • ipmi.protocolIpmiGetStatistics

    Statistics of fields indicated in the headers

  • ipmi.protocolIpmiGetStatsHdr

    The headers of statistics fields

  • ipmi.protocolIpmiGetTrace

    Trace 1 means enabled, 0 means not

  • ipmi.protocolIpmiSetAttr

    Attribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N

  • ipmi.protocolIpmiSetConfig

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

  • ipmi.protocolIpmiSetTrace

    1 to enable, 0 to disable

  • mqtt.protocolMqttClientGetProtstate

    0 - stopped, 2 - disconnected, 3 - connecting, 4 - connected, 5 - waiting for CONNACK, 6 - waiting for SUBACK, 7 - CONNACK received, in steady state

  • mqtt.protocolMqttClientGetState

    0 means stopped, 1 means running

  • mqtt.protocolMqttClientMessageCard

    0 or more

  • mqtt.protocolMqttClientMessageGet

    Attribute 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.protocolMqttClientMessageSet

    Attribute 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.protocolMqttClientResubscribe

    Restarts a subscription

  • mqtt.protocolMqttClientRuntimeAbort

    Abort a connection

  • mqtt.protocolMqttClientRuntimeConnect

    Start a connection

  • mqtt.protocolMqttClientRuntimeDisconnect

    Graceful disconnect

  • mqtt.protocolMqttClientSetBroker

    Broker IP address

  • mqtt.protocolMqttClientSetCleansession

    1 for clean session , 0 not

  • mqtt.protocolMqttClientSetClientid

    MQTT client ID

  • mqtt.protocolMqttClientSetKeepalive

    Keep alive the TCP connection

  • mqtt.protocolMqttClientSetOnDisconnect

    Action to take when MQTT session is disconnected

  • mqtt.protocolMqttClientSetPassword

    Client password

  • mqtt.protocolMqttClientSetPort

    target TCP port

  • mqtt.protocolMqttClientSetUsername

    Client username

  • mqtt.protocolMqttClientSetWillmsg

    Will message

  • mqtt.protocolMqttClientSetWillqos

    QOS field

  • mqtt.protocolMqttClientSetWillretain

    Retaining will

  • mqtt.protocolMqttClientSetWilltopic

    Will topic for the will message

  • mqtt.protocolMqttClientSubscribeCard

    0 or more

  • mqtt.protocolMqttClientSubscribeGet

    Attribute can be topic, properties(list of SUBSCRIBE properties), properties.i (i-th SUBSCRIBE property), properties.PROP-NAME (SUBSCRIBE property with name PROP-NAME)

  • mqtt.protocolMqttClientSubscribeSet

    Attribute can not be properties .

  • mqtt.protocolMqttClientUnsubscribe

    Stops a subscription

  • mqtt.protocolMqttGetArgs

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

  • mqtt.protocolMqttGetConfig

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

  • mqtt.protocolMqttGetStatistics

    Statistics of fields indicated in the headers

  • mqtt.protocolMqttGetStatsHdr

    The headers of statistics fields

  • mqtt.protocolMqttGetTrace

    Trace 1 means enabled, 0 means not

  • mqtt.protocolMqttSetConfig

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

  • mqtt.protocolMqttSetTrace

    1 to enable, 0 to disable

  • netflow.protocolNetflowChangeAttr

    Change attributes

  • netflow.protocolNetflowChangeDfs

    Interval in msec .

  • netflow.protocolNetflowChangeTfs

    Interval in msec .

  • netflow.protocolNetflowGetArgs

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

  • netflow.protocolNetflowGetConfig

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

  • netflow.protocolNetflowGetStatistics

    Statistics of fields indicated in the headers

  • netflow.protocolNetflowGetStatsHdr

    The headers of statistics fields

  • netflow.protocolNetflowGetTrace

    Trace 1 means enabled, 0 means not

  • netflow.protocolNetflowHalt

    Halt NETFLOW traffic

  • netflow.protocolNetflowList

    Show list of NETFLOW exports

  • netflow.protocolNetflowReload

    Reload NETFLOW configuration before resuming traffic

  • netflow.protocolNetflowResume

    Resuming traffic

  • netflow.protocolNetflowSetCollector

    Allow changing collector without stopping agent

  • netflow.protocolNetflowSetConfig

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

  • netflow.protocolNetflowSetFileName

    Allow reloading the configuration file for an agent without stopping agent

  • netflow.protocolNetflowSetTrace

    1 to enable, 0 to disable

  • proxy.protocolProxyGetArgs

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

  • proxy.protocolProxyGetConfig

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

  • proxy.protocolProxyGetStatistics

    Statistics of fields indicated in the headers

  • proxy.protocolProxyGetStatsHdr

    The headers of statistics fields

  • proxy.protocolProxyGetTrace

    Trace 1 means enabled, 0 means not

  • proxy.protocolProxyPortAdd

    Additional proxy target

  • proxy.protocolProxyPortIsstarted

    Check individual target

  • proxy.protocolProxyPortList

    List all proxy targets

  • proxy.protocolProxyPortRemove

    Remove proxy target

  • proxy.protocolProxyPortStart

    Start additional target

  • proxy.protocolProxyPortStop

    Stop additional target

  • proxy.protocolProxySetConfig

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

  • proxy.protocolProxySetTrace

    1 to enable, 0 to disable

  • sflow.protocolSflowGetArgs

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

  • sflow.protocolSflowGetConfig

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

  • sflow.protocolSflowGetStatistics

    Statistics of fields indicated in the headers

  • sflow.protocolSflowGetStatsHdr

    The headers of statistics fields

  • sflow.protocolSflowGetTrace

    Trace 1 means enabled, 0 means not

  • sflow.protocolSflowHalt

    Halt SFLOW traffic

  • sflow.protocolSflowReload

    Reload SFLOW configuration before resuming traffic

  • sflow.protocolSflowResume

    Resuming traffic

  • sflow.protocolSflowSetConfig

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

  • sflow.protocolSflowSetTrace

    1 to enable, 0 to disable

  • snmptcp.protocolSnmptcpGetArgs

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

  • snmptcp.protocolSnmptcpGetConfig

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

  • snmptcp.protocolSnmptcpGetStatistics

    Statistics of fields indicated in the headers

  • snmptcp.protocolSnmptcpGetStatsHdr

    The headers of statistics fields

  • snmptcp.protocolSnmptcpGetTrace

    Trace 1 means enabled, 0 means not

  • snmptcp.protocolSnmptcpIpaliasDisable

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

  • snmptcp.protocolSnmptcpIpaliasEnable

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

  • snmptcp.protocolSnmptcpIpaliasIsenabled

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

  • snmptcp.protocolSnmptcpIpaliasList

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

  • snmptcp.protocolSnmptcpSetConfig

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

  • snmptcp.protocolSnmptcpSetTrace

    1 to enable, 0 to disable

  • snmPv3.protocolSnmpv3AccessAdd

    Adds a new access entry with the specified parameters.

  • snmPv3.protocolSnmpv3AccessClear

    Clears all access entries.

  • snmPv3.protocolSnmpv3AccessDel

    Deletes the specified access entry.

  • snmPv3.protocolSnmpv3AccessList

    Returns the current acccess entries as an array of strings.

  • snmPv3.protocolSnmpv3GetConfig

    Returns the SNMPv3 configuration.

  • snmPv3.protocolSnmpv3GetContextEngineid

    Retrieves the contextEngineID for the agent instance.

  • snmPv3.protocolSnmpv3GetEngineboots

    Retrieves the number of times the agent has been restarted.

  • snmPv3.protocolSnmpv3GetEngineid

    For 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.protocolSnmpv3GetEnginetime

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

  • snmPv3.protocolSnmpv3GroupAdd

    Adds a new group entry with the specified parameters.

  • snmPv3.protocolSnmpv3GroupClear

    Clears all group entries.

  • snmPv3.protocolSnmpv3GroupDel

    Deletes the specified group entry.

  • snmPv3.protocolSnmpv3GroupList

    Returns the current group entries as an array of strings.

  • snmPv3.protocolSnmpv3SetConfig

    Changes the SNMPv3 configuration.

  • snmPv3.protocolSnmpv3UserAdd

    Adds a new user entry with the specified parameters.

  • snmPv3.protocolSnmpv3UserClear

    Clears all user entries.

  • snmPv3.protocolSnmpv3UserDel

    Deletes the specified user entry.

  • snmPv3.protocolSnmpv3UserList

    Returns the current user entries as a Tcl list.

  • snmPv3.protocolSnmpv3UsmSave

    Saves current user settings in the currently loaded USM config file.

  • snmPv3.protocolSnmpv3UsmSaveas

    Saves current user settings in the specified USM config file.

  • snmPv3.protocolSnmpv3VacmSave

    Saves current group, access, view settings in the currently loaded VACM config file.

  • snmPv3.protocolSnmpv3VacmSaveas

    Saves current group, access, view settings in the specified VACM config file.

  • snmPv3.protocolSnmpv3ViewAdd

    Adds a new view entry with the specified parameters.

  • snmPv3.protocolSnmpv3ViewClear

    Clears all view entries.

  • snmPv3.protocolSnmpv3ViewDel

    Deletes the specified view entry.

  • snmPv3.protocolSnmpv3ViewList

    Returns the current view entries as an array of strings.

  • ssh.protocolSshGetArgs

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

  • ssh.protocolSshGetConfig

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

  • ssh.protocolSshGetStatistics

    Statistics of fields indicated in the headers

  • ssh.protocolSshGetStatsHdr

    The headers of statistics fields

  • ssh.protocolSshGetTrace

    Trace 1 means enabled, 0 means not

  • ssh.protocolSshIpaliasDisable

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

  • ssh.protocolSshIpaliasEnable

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

  • ssh.protocolSshIpaliasIsenabled

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

  • ssh.protocolSshIpaliasList

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

  • ssh.protocolSshSetConfig

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

  • ssh.protocolSshSetTrace

    1 to enable, 0 to disable

  • syslog.protocolSyslogGetArgs

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

  • syslog.protocolSyslogGetAttr

    Attribute can be server , sequence , separator , hostname , timestamp

  • syslog.protocolSyslogGetConfig

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

  • syslog.protocolSyslogGetStatistics

    Statistics of fields indicated in the headers

  • syslog.protocolSyslogGetStatsHdr

    The headers of statistics fields

  • syslog.protocolSyslogGetTrace

    Trace 1 means enabled, 0 means not

  • syslog.protocolSyslogSend

    1 to enable, 0 to disable

  • syslog.protocolSyslogSetAttr

    Attribute can be server , sequence , separator , hostname , timestamp

  • syslog.protocolSyslogSetConfig

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

  • syslog.protocolSyslogSetTrace

    1 to enable, 0 to disable

  • telnet.protocolTelnetConnectionLogon

    Logon change allows (hidden) commands for a different access mode to run.

  • telnet.protocolTelnetConnectionRequest

    Equivalent of the command typed in by the user.

  • telnet.protocolTelnetConnectionSignal

    Signal name is either connect or idle

  • telnet.protocolTelnetGetArgs

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

  • telnet.protocolTelnetGetConfig

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

  • telnet.protocolTelnetGetStatistics

    Statistics of fields indicated in the headers

  • telnet.protocolTelnetGetStatsHdr

    The headers of statistics fields

  • telnet.protocolTelnetGetTrace

    Trace 1 means enabled, 0 means not

  • telnet.protocolTelnetIpaliasDisable

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

  • telnet.protocolTelnetIpaliasEnable

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

  • telnet.protocolTelnetIpaliasIsenabled

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

  • telnet.protocolTelnetIpaliasList

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

  • telnet.protocolTelnetServerGetConnections

    IDs of all connected connections

  • telnet.protocolTelnetServerGetKeymap

    Keymap file name

  • telnet.protocolTelnetServerGetRulesdb

    Rules db file name

  • telnet.protocolTelnetServerGetState

    Return 1 means accepting connections, 0 not

  • telnet.protocolTelnetServerGetUserdb

    User db file name

  • telnet.protocolTelnetServerGetUsers

    List of users

  • telnet.protocolTelnetSetConfig

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

  • telnet.protocolTelnetSetTrace

    1 to enable, 0 to disable

  • tftp.protocolTftpGetArgs

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

  • tftp.protocolTftpGetConfig

    Agent's TFTP configuration

  • tftp.protocolTftpGetStatistics

    Statistics of fields indicated in the headers

  • tftp.protocolTftpGetStatsHdr

    The headers of statistics fields

  • tftp.protocolTftpGetTrace

    Trace 1 means enabled, 0 means not

  • tftp.protocolTftpSessionGetParameter

    Parameter is server , port , or dstfile

  • tftp.protocolTftpSessionRead

    Session ID is returned

  • tftp.protocolTftpSessionSetParameter

    Parameter is server , port , or dstfile

  • tftp.protocolTftpSessionStart

    Start uploading or downloading the file

  • tftp.protocolTftpSessionStatus

    Status includes running state, bytes transfered, and time elapsed

  • tftp.protocolTftpSessionStop

    Stop uploading or downloading the file

  • tftp.protocolTftpSessionWrite

    Session ID is returned

  • tftp.protocolTftpSetConfig

    Agent's TFTP configuration

  • tftp.protocolTftpSetTrace

    1 to enable, 0 to disable

  • tod.protocolTodGetArgs

    Agent's TOD configuration

  • tod.protocolTodGetConfig

    Agent's TOD configuration

  • tod.protocolTodGetStatistics

    Statistics of fields indicated in the headers

  • tod.protocolTodGetStatsHdr

    The headers of statistics fields

  • tod.protocolTodGettime

    Retrive time from server

  • tod.protocolTodGetTrace

    Trace 1 means enabled, 0 means not

  • tod.protocolTodSetConfig

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

  • tod.protocolTodSetTrace

    1 to enable, 0 to disable

  • valuespace.add

    The object needs to specify the MIB object with the INDEX clause, usually an object whose name ends with Entry.

  • valuespace.evalValue

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

  • valuespace.getInfo

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

  • valuespace.getInstances

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

  • valuespace.getMib

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

  • valuespace.getName

    Return the symbolic name of the specified object identifier.

  • valuespace.getObjects

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

  • valuespace.getOid

    Return the numeric OID of the specified object.

  • valuespace.getState

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

  • valuespace.getValue

    Get a variable in the Value Space.

  • valuespace.getVariables

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

  • valuespace.mevalValue

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

  • valuespace.mgetValue

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

  • valuespace.msetValue

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

  • valuespace.munsetValue

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

  • valuespace.remove

    The object needs to specify the MIB object with the INDEX clause, usually an object whose name ends with Entry.

  • valuespace.setState

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

  • valuespace.setValue

    NOTE 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.splitOid

    This is useful if you have an OID which is a combination of object and instance.

  • valuespace.unsetValue

    Only variables that have previously been set can be unset.

  • web.protocolWebGetArgs

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

  • web.protocolWebGetConfig

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

  • web.protocolWebGetStatistics

    Statistics of fields indicated in the headers

  • web.protocolWebGetStatsHdr

    The headers of statistics fields

  • web.protocolWebGetTrace

    Trace 1 means enabled, 0 means not

  • web.protocolWebPortAdd

    Add port

  • web.protocolWebPortExists

    Check the port. 1 means existing, 0 means not

  • web.protocolWebPortRemove

    Remove port

  • web.protocolWebPortSet

    Set port

  • web.protocolWebPortStart

    Start port

  • web.protocolWebPortStop

    Stop port

  • web.protocolWebSetConfig

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

  • web.protocolWebSetTrace

    1 to enable, 0 to disable

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools