{"note":"OpenAPI conversion -- returning structured metadata","name":"gambitcomm-local-mimic","description":"MIMIC REST API","version":"21.00","base_url":"http://127.0.0.1","endpoints":356,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api MIMIC REST API\n@base http://127.0.0.1\n@version 21.00\n@auth Bearer basic\n@endpoints 356\n@hint download_for_search\n@toc mimic(356)\n\n@endpoint GET /mimic/get/max\n@desc The maximum number of agent instances.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/last\n@desc The last configured agent instance.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/version\n@desc The version of the MIMIC command interface.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/clients\n@desc The number of clients currently connected to the daemon.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/cfgfile\n@desc The currently loaded lab configuration file for the particular user.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/cfgfile_changed\n@desc This predicate indicates if the currently loaded agent configuration file has changed.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/return\n@desc The return mode.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/log\n@desc The current log file for the Simulator.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/protocols\n@desc The set of protocols supported by the Simulator.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/interfaces\n@desc The set of network interfaces that can be used for simulations.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/product\n@desc The product number that is licensed.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/netaddr\n@desc The network address of the host where the MIMIC simulator is running.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/netdev\n@desc The default network device to be used for agent addresses.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/configured_list\n@desc The list of {agentnum} that are currently configured.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/active_list\n@desc The list of {agentnum} that are currently active (running or paused).\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/active_data_list\n@desc The list of {agentnum {statistics}} for agents that are currently active and whose statistics have changed since the last invocation of this command.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/changed_config_list\n@desc The list of {agentnum} for which a configurable parameter changed.\n@returns(200) successful operation\n\n@endpoint GET /mimic/get/changed_state_list\n@desc The list of {agentnum state} for which the state changed.\n@returns(200) successful operation\n\n@endpoint GET /mimic/mget/{infoArray}\n@desc Get multiple sets of information about MIMIC, where infoArray is one of the parameters defined in the mimic get command.\n@required {infoArray: [str] # Multiple strings of info.}\n@returns(200) successful operation\n@errors {400: Invalid info string}\n\n@endpoint PUT /mimic/set/log\n@desc The current log file for the Simulator.\n@returns(200) successful operation\n\n@endpoint PUT /mimic/set/netdev\n@desc The network address of the host where the MIMIC simulator is running.\n@returns(200) successful operation\n\n@endpoint PUT /mimic/set/persistent\n@desc This operation flushes all global objects which need to be made persistent to disk.\n@returns(200) successful operation\n\n@endpoint PUT /mimic/load/{cfgFile}/{firstAgentNum}/{lastAgentNum}/{startAgentNum}\n@desc Load the lab configuration file file.\n@required {cfgFile: str # MIMIC agent configuration file to load, firstAgentNum: int(int32) # Agent number in cfgFile to start the loading, lastAgentNum: int(int32) # Agent number in cfgFile to end the loading, startAgentNum: int(int32) # Agent number in current configuration to start placing the new agents}\n@returns(200) successful operation\n\n@endpoint PUT /mimic/clear/{firstAgentNum}/{lastAgentNum}\n@desc Clear the lab configuration.\n@required {firstAgentNum: int(int32) # Agent number to start clearing, lastAgentNum: int(int32) # Agent number to end the clearing}\n@returns(200) successful operation\n\n@endpoint PUT /mimic/saveas/{cfgFile}/{firstAgentNum}/{lastAgentNum}\n@desc Save the lab configuration in file.\n@required {cfgFile: str # MIMIC agent configuration file to save, firstAgentNum: int(int32) # Agent number in cfgFile to start the loading, lastAgentNum: int(int32) # Agent number in cfgFile to end the loading}\n@returns(200) successful operation\n\n@endpoint PUT /mimic/save\n@desc Save the lab configuration.\n@returns(200) successful operation\n\n@endpoint PUT /mimic/start\n@desc Start MIMIC.\n@returns(200) successful operation\n\n@endpoint PUT /mimic/stop\n@desc Stop MIMIC.\n@returns(200) successful operation\n\n@endpoint PUT /mimic/terminate\n@desc Terminate the MIMIC daemon.\n@returns(200) successful operation\n\n@endpoint POST /mimic/agent/{agentNum}/add/{IP}\n@desc Add an agent.\n@required {agentNum: int(int32) # Agent to return the primary IP, IP: str # Primary IP}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/remove\n@desc Remove the current agent.\n@required {agentNum: int(int32) # Agent to return the primary IP}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/start\n@desc Start the current agent.\n@required {agentNum: int(int32) # Agent to return the primary IP}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/stop\n@desc Show the agent's primary IP address\n@required {agentNum: int(int32) # Agent to return the primary IP}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/pause\n@desc Pause the current agent.\n@required {agentNum: int(int32) # Agent to return the primary IP}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/halt\n@desc Halt the current agent.\n@required {agentNum: int(int32) # Agent to return the primary IP}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/reload\n@desc Reload the current agent.\n@required {agentNum: int(int32) # Agent to return the primary IP}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/resume\n@desc Resume the current agent.\n@required {agentNum: int(int32) # Agent to return the primary IP}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/interface\n@desc network interface card for the agent.\n@required {agentNum: int(string) # Agent to return the primary interface}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/host\n@desc host address of the agent.\n@required {agentNum: int(string) # Agent to return the primary IP}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/mask\n@desc subnet mask of the agent.\n@required {agentNum: int(string) # Agent to return the primary interface}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/port\n@desc port number\n@required {agentNum: int(int32) # Agent to return the primary SNMP port}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/protocol\n@desc protocols supported by agent\n@required {agentNum: int(int32) # Agent to return the protocols arrary}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/read\n@desc read community string\n@required {agentNum: int(int32) # Agent to return the SNMP read community string}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/write\n@desc write community string\n@required {agentNum: int(int32) # Agent to return the SNMP write community string}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/delay\n@desc one-way transit delay in msec.\n@required {agentNum: int(int32) # Agent to return the delay time}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/start\n@desc relative start time\n@required {agentNum: int(int32) # Agent to return the relative start time}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/mibs\n@desc set of MIBs, simulations and scenarios\n@required {agentNum: int(int32) # Agent to return the MIB triplets}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/sim\n@desc first simulation name\n@required {agentNum: int(int32) # Agent to return the first simulation name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/scen\n@desc first scenario name\n@required {agentNum: int(int32) # Agent to return the first scenario number}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/state\n@desc current running state of the agent\n@required {agentNum: int(int32) # Agent to return the state}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/statistics\n@desc current statistics of the agent instance\n@required {agentNum: int(int32) # Agent to return the statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/changed\n@desc has the agent value space changed?\n@required {agentNum: int(int32) # Agent to return the indicator}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/config_changed\n@desc has the lab configuration changed?\n@required {agentNum: int(int32) # Agent to return the indicator}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/state_changed\n@desc has the agent state changed?\n@required {agentNum: int(int32) # Agent to return the indicator}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/trace\n@desc SNMP PDU tracing\n@required {agentNum: int(int32) # Agent to return the indicator}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/pdusize\n@desc maximum PDU size.\n@required {agentNum: int(int32) # Agent to return the PDU size}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/drops\n@desc drop rate (every N-th PDU). 0 means no drops.\n@required {agentNum: int(int32) # Agent to return the drop rate}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/owner\n@desc owner of the agent.\n@required {agentNum: int(int32) # Agent to return the owner}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/privdir\n@desc private directory of the agent.\n@required {agentNum: int(int32) # Agent to return the directory path}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/oiddir\n@desc MIB directory of the agent.\n@required {agentNum: int(int32) # Agent to return the directory path}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/validate\n@desc SNMP SET validation policy.\n@required {agentNum: int(int32) # Agent to return the bitmask integer}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/inform_timeout\n@desc timeout in seconds for retransmitting INFORM PDUs.\n@required {agentNum: int(int32) # Agent to return the timeout setting}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/get/num_starts\n@desc number of starts for the agent.\n@required {agentNum: int(int32) # Agent to return the count}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/interface/{interface}\n@desc network interface card for the agent\n@required {agentNum: int(string) # Agent to set the primary interface, interface: str # Primary interface of the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/host/{host}\n@desc host address of the agent.\n@required {agentNum: int(string) # Agent to set the primary IP, host: str # Primary IP of the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/mask/{mask}\n@desc subnet mask of the agent.\n@required {agentNum: int(string) # Agent to set the primary IP address mask, mask: str # Mask to set for the agent primary IP address}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/port/{port}\n@desc port number\n@required {agentNum: int(int32) # Agent to set the primary SNMP port, port: int(int32) # Primary SNMP port of the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/protocol\n@desc protocols supported by agent as a comma-separated list\n@required {agentNum: int(int32) # Agent to return the protocols arrary}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/read/{read}\n@desc read community string\n@required {agentNum: int(int32) # Agent to return the SNMP read community string, read: str # SNMP read community string}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/write/{write}\n@desc write community string\n@required {agentNum: int(int32) # Agent to set the SNMP write community string, write: str # SNMP write community string}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/delay/{delay}\n@desc one-way transit delay in msec\n@required {agentNum: int(int32) # Agent to set the delay time, delay: int(int32) # Delay time of the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/start/{start}\n@desc relative start time\n@required {agentNum: int(int32) # Agent to return the relative start time, start: int(int32) # Relative start time of the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/mibs\n@desc set of MIBs, simulations and scenarios\n@required {agentNum: int(int32) # Agent to return the MIB triplets}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/trace/{trace}\n@desc SNMP PDU tracing\n@required {agentNum: int(int32) # Agent to set trace setting, trace: int(int32) # Trace setting for the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/pdusize/{pdusize}\n@desc maximum PDU size\n@required {agentNum: int(int32) # Agent to return the PDU size, pdusize: int(int32) # PDU size setting for the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/drops/{drops}\n@desc drop rate (every N-th PDU)\n@required {agentNum: int(int32) # Agent to set the drop rate, drops: int(int32) # Drop rate of the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/owner/{owner}\n@desc owner of the agent\n@required {agentNum: int(int32) # Agent to set the owner, owner: str # Owner of the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/privdir/{privdir}\n@desc private directory of the agent.\n@required {agentNum: int(int32) # Agent to set the directory path, privdir: str # Directory path for the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/oiddir/{oiddir}\n@desc MIB directory of the agent.\n@required {agentNum: int(int32) # Agent to set the directory path, oiddir: str # Directory path for the agent}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/validate/{validate}\n@desc SNMP SET validation policy\n@required {agentNum: int(int32) # Agent to set the bitmask integer, validate: int(int32) # Bitmask integer to set}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/set/inform_timeout/{inform_timeout}\n@desc timeout in seconds for retransmitting INFORM PDUs\n@required {agentNum: int(int32) # Agent to set the timeout setting, inform_timeout: int(int32) # Tmeout setting}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/save\n@desc Save agent MIB values.\n@required {agentNum: int(int32) # Agent to save}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/ipalias/list\n@desc Lists all the additional ipaliases configured for the agent.\n@required {agentNum: int(int32) # Agent to show the IP alias list}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}\n@desc Adds a new ipalias for the agent.\n@required {agentNum: int(int32) # Agent to add the IP alias, IP: str # IP address , IPv4 or IPv6, port: int(int32) # SNMP port , 0 or empty for default, mask: str # Netmask, empty for default, interface: str # Interface. Empty for default}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/ipalias/delete/{IP}/{port}\n@desc Deletes an existing ipalias from the agent.\n@required {agentNum: int(int32) # Agent to delete the IP alias, IP: str # IP address , IPv4 or IPv6, port: int(int32) # SNMP port , 0 or empty for default}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/ipalias/start/{IP}/{port}\n@desc Starts an existing ipalias for the agent.\n@required {agentNum: int(int32) # Agent to start the IP alias, IP: str # IP address , IPv4 or IPv6, port: int(int32) # SNMP port , 0 or empty for default}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/ipalias/stop/{IP}/{port}\n@desc Stops an existing ipalias for the agent.\n@required {agentNum: int(int32) # Agent to stop the IP alias, IP: str # IP address , IPv4 or IPv6, port: int(int32) # SNMP port , 0 or empty for default}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/ipalias/status/{IP}/{port}\n@desc Returns the status (0=down, 1=up) of an existing ipalias for the agent.\n@required {agentNum: int(int32) # Agent to show status of the IP alias, IP: str # IP address , IPv4 or IPv6, port: int(int32) # SNMP port , 0 or empty for default}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/trap/config/list\n@desc List the set of trap destinations for this agent instance.\n@required {agentNum: int(int32) # Agent to show the IP alias list}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/trap/config/add/{IP}/{port}\n@desc Add a trap destination to the set of destinations.\n@required {agentNum: int(int32) # Agent to add the destination, IP: str # IP of the destination, port: int(int32) # port of the destination}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/trap/config/delete/{IP}/{port}\n@desc Remove a trap destination from the set of destinations.\n@required {agentNum: int(int32) # Agent to delete the destination, IP: str # IP of the destination, port: int(int32) # port of the destination}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/trap/list\n@desc List the outstanding asynchronous traps for this agent instance.\n@required {agentNum: int(int32) # Agent to list the traps}\n@returns(200) successful operation\n\n@endpoint GET /mimic/agent/{agentNum}/from/list\n@desc List the source addresses that the agent will accept messages from.\n@required {agentNum: int(int32) # Agent to show the IP sources}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/from/add/{IP}/{port}\n@desc Add a source address that the agent will accept messages from.\n@required {agentNum: int(int32) # Agent to add the IP source, IP: str # IP of the port, 0.0.0.0 for any, port: int(int32) # port of the source, 0 for any}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/from/delete/{IP}/{port}\n@desc delete a source address that the agent will accept messages from.\n@required {agentNum: int(int32) # Agent to delete the IP source, IP: str # IP of the source, port: int(int32) # port of the source}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/{prot}/get/config\n@desc Returns the protocol's configuration.\n@required {agentNum: int(int32) # Agent to show the protocol configuration, prot: str # Protocol to show configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/list/{OID}\n@desc Display the MIB objects below the current position\n@required {agentNum: int(int32) # Agent to show the OID branches, OID: str # Current OID}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/oid/{object}\n@desc Return the numeric OID of the specified object.\n@required {agentNum: int(int32) # Agent to show the OID, object: str # Object}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/name/{OID}\n@desc Return the symbolic name of the specified object identifier.\n@required {agentNum: int(int32) # Agent to show the object, OID: str # OID}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/mib/{object}\n@desc Return the MIB that defines the specified object.\n@required {agentNum: int(int32) # Agent to show the MIB, object: str # Object}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/info/{object}\n@desc Return the syntactical information for the specified object, such as type, size, range, enumerations, and ACCESS.\n@required {agentNum: int(int32) # Agent to show the information of the object, object: str # Object}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/instances/{object}\n@desc Display the MIB object instances for the specified object.\n@required {agentNum: int(int32) # Agent of the value space, object: str # Object (column) of the table in the agent's value space}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/eval/{object}/{instance}\n@desc Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.\n@required {agentNum: int(int32) # Agent of the value space, object: str # Single instance object or object (column) of the table in the agent's value space., instance: str # Row of the table in the agent's value space. 0 for single instance objects}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/variables/{object}/{instance}\n@desc Display the variables for the specified instance instance for the specified MIB object object\n@required {agentNum: int(int32) # Agent of the value space, object: str # Single instance object or object (column) of the table in the agent's value space., instance: str # Row of the table in the agent's value space. 0 for single instance objects}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/split/{OID}\n@desc Split the numerical OID into the object OID and instance OID.\n@required {agentNum: int(int32) # Agent of the value space, OID: str # OID}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/get/{object}/{instance}/{variable}\n@desc Get a variable in the Value Space.\n@required {agentNum: int(int32) # Agent of the value space, object: str # Object (column) of the table in the agent's value space, instance: str # Object (column) of the table in the agent's value space, variable: str # Object (column) of the table in the agent's value space}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/value/set/{object}/{instance}/{variable}\n@desc Set a variable in the Value Space.\n@required {agentNum: int(int32) # Agent of the value space, object: str # Single instance object or object (column) of the table in the agent's value space., instance: str # Row of the table in the agent's value space. 0 for single instance objects, variable: str # Variable}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/meval/{objInsArray}\n@desc Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests.\n@required {agentNum: int(int32) # Agent of the value space, objInsArray: [[str]] # Multiple objects or object (column) of the table in the agent's value space.}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/value/mset\n@desc Set multiple variables in the Value Space.\n@required {agentNum: int(int32) # Agent of the value space}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/value/munset\n@desc Unset multiple variables in the Value Space\n@required {agentNum: int(int32) # Agent of the value space}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/mget/{objInsVarArray}\n@desc Get multiple variables in the Value Space.\n@required {agentNum: int(int32) # Agent of the value space, objInsVarArray: [[str]] # Multiple objects or object (column) of the table in the agent's value space.}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/value/unset/{object}/{instance}/{variable}\n@desc Unset a variable in the Value Space in order to free its memory.\n@required {agentNum: int(int32) # Agent of the value space, object: str # Single instance object or object (column) of the table in the agent's value space., instance: str # Row of the table in the agent's value space. 0 for single instance objects, variable: str # Variable}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/value/add/{object}/{instance}\n@desc Add an entry to a table.\n@required {agentNum: int(int32) # Agent of the value space, object: str # Object (column) of the table in the agent's value space, instance: str # Object (column) of the table in the agent's value space}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/value/remove/{object}/{instance}\n@desc Remove an entry from a table.\n@required {agentNum: int(int32) # Agent of the value space, object: str # Object (column) of the table in the agent's value space, instance: str # Object (column) of the table in the agent's value space}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/value/state/get/{object}\n@desc Get the state of a MIB object object.\n@required {agentNum: int(int32) # Agent of the value space, object: str # Object}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/value/state/set/{object}/{state}\n@desc Set the state of a MIB object object\n@required {agentNum: int(int32) # Agent of the value space, object: str # Object, state: int(int32) # State}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/store/set/{var}/{persist}\n@desc Set the variable store for the global storage\n@required {var: str # Variable name, persist: int(int32) # Persistent setting}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/store/set/{var}/{persist}\n@desc These commands allow the creation of a new variable, or changing an existing value.\n@required {agentNum: int(int32) # Agent of the value space, var: str # Variable name, persist: int(int32) # Persistent setting}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/store/lreplace/{var}/{index}\n@desc 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.\n@required {var: str # Variable name, index: int(int32) # Index}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/store/lreplace/{var}/{index}\n@desc 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.\n@required {agentNum: int(int32) # Agent of the value space, var: str # Variable name, index: int(int32) # Index}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/store/unset/{var}\n@desc Deletes a variable which is currently defined.\n@required {var: str # Variable name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/store/unset/{var}\n@desc Deletes a variable which is currently defined.\n@required {agentNum: int(int32) # Agent of the value space, var: str # Variable name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/store/get/{var}\n@desc Fetches the value associated with a variable.\n@required {var: str # Variable name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/store/get/{var}\n@desc Fetches the value associated with a variable.\n@required {agentNum: int(int32) # Agent of the value space, var: str # Variable name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/store/exists/{var}\n@desc This command can be used as a predicate to ascertain the existence of a given variable.\n@required {var: str # Variable name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/store/exists/{var}\n@desc This command can be used as a predicate to ascertain the existence of a given variable.\n@required {agentNum: int(int32) # Agent of the value space, var: str # Variable name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/store/persists/{var}\n@desc This command can be used as a predicate to ascertain the persistence of a given variable.\n@required {var: str # Variable name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/store/persists/{var}\n@desc This command can be used as a predicate to ascertain the persistence of a given variable.\n@required {agentNum: int(int32) # Agent of the value space, var: str # Variable name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/store/list\n@desc This command will return the list of variables in the said scope.\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/store/list\n@desc This command will return the list of variables in the said scope.\n@required {agentNum: int(int32) # Agent of the value space}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/store/copy/{otherAgent}\n@desc This command copies the variable store from the other agent to this agent.\n@required {agentNum: int(int32) # Agent of the value space, otherAgent: int(int32) # Agent of the value space}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/timer/script/list\n@desc List the timer scripts currently running along with the their intervals.\n@required {agentNum: int(int32) # Agent to return the timer script list}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/timer/script/list\n@desc List the timer scripts currently running along with the their intervals.\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/timer/script/add/{script}/{interval}/{arg}\n@desc Add a new timer script to be executed at specified interval (in msec) with the specified argument.\n@required {agentNum: int(int32) # Agent to return the timer script list, script: str # Script name, interval: int(int32) # Interval in msec, arg: str # Arguments to the script}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/timer/script/add/{script}/{interval}/{arg}\n@desc Add a new timer script to be executed at specified interval (in msec) with the specified argument.\n@required {script: str # Script name, interval: int(int32) # Interval in msec, arg: str # Arguments to the script}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/timer/script/delete/{script}/{interval}/{arg}\n@desc Remove a timer script from the execution list.\n@required {agentNum: int(int32) # Agent to return the timer script list, script: str # Script name, interval: int(int32) # Interval in msec, arg: str # Arguments to the script}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/timer/script/delete/{script}/{interval}/{arg}\n@desc Remove a timer script from the execution list.\n@required {script: str # Script name, interval: int(int32) # Interval in msec, arg: str # Arguments to the script}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmpv3/get/config\n@desc Returns the SNMPv3 configuration.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration}\n@returns(200) {engine_id: str, context_engine_id: str, usm_db: str, vacm_db: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/snmpv3/set/config/{parameter}/{value}\n@desc Changes the SNMPv3 configuration.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration, parameter: str # SNMPv3 configuration parameter, value: str # SNMPv3 parameter value}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmpv3/get/engineid\n@desc For started agents, retrieves the current engineID in use by the snmpv3 module.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmpv3/get/engineboots\n@desc Retrieves the number of times the agent has been restarted.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 engine}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmpv3/get/enginetime\n@desc Retrieves the time in seconds for which the agent has been running.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 engine}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmpv3/get/context_engineid\n@desc Retrieves the contextEngineID for the agent instance.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 engine}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmpv3/user/list\n@desc Returns the current user entries as a Tcl list.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/protocol/msg/snmpv3/user/add/{userName}/{securityName}/{authProtocol}/{authKey}/{privProtocol}/{privKey}\n@desc Adds a new user entry with the specified parameters.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 user, userName: str # SNMPv3 user name, securityName: str # SNMPv3 user security name, authProtocol: str # SNMPv3 user authentication protocol, authKey: str # SNMPv3 user authentication key, privProtocol: str # SNMPv3 user privacy encryption protocol, privKey: str # SNMPv3 user privacy encryption key}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/snmpv3/user/del/{userName}\n@desc Deletes the specified user entry.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 user, userName: str # SNMPv3 user name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/snmpv3/user/clear\n@desc Clears all user entries.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 user}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmpv3/group/list\n@desc Returns the current group entries as an array of strings.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/protocol/msg/snmpv3/group/add/{groupName}/{securityModel}/{securityName}\n@desc Adds a new group entry with the specified parameters.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 group, groupName: str # SNMPv3 group name, securityModel: str # SNMPv3 group security model, securityName: str # SNMPv3 group security name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/snmpv3/group/del/{groupName}\n@desc Deletes the specified group entry.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 group, groupName: str # SNMPv3 group name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/snmpv3/group/clear\n@desc Clears all group entries.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 group}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmpv3/access/list\n@desc Returns the current acccess entries as an array of strings.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/protocol/msg/snmpv3/access/add/{groupName}/{prefix}/{securityModel}/{securityLevel}/{contextMatch}/{readView}/{writeView}/{notifyView}\n@desc Adds a new access entry with the specified parameters.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 access, groupName: str # SNMPv3 access name, prefix: str # SNMPv3 prefix, securityModel: str # SNMPv3 access security model, securityLevel: str # SNMPv3 access security level, contextMatch: str # SNMPv3 access context match, readView: str # SNMPv3 access read view, writeView: str # SNMPv3 access write view, notifyView: str # SNMPv3 access notify view}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/snmpv3/access/del/{accessName}\n@desc Deletes the specified access entry.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 access, accessName: str # SNMPv3 access name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/snmpv3/access/clear\n@desc Clears all access entries.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 access}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmpv3/view/list\n@desc Returns the current view entries as an array of strings.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/protocol/msg/snmpv3/view/add/{viewName}/{viewType}/{subtree}/{mask}\n@desc Adds a new view entry with the specified parameters.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 view, viewName: str # SNMPv3 view name, viewType: str # SNMPv3 view type, subtree: str # SNMPv3 view subtree, mask: str # SNMPv3 view mask}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/snmpv3/view/del/{viewName}\n@desc Deletes the specified view entry.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 view, viewName: str # SNMPv3 view name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/snmpv3/view/clear\n@desc Clears all view entries.\n@required {agentNum: int(int32) # Agent to add the SNMPv3 view}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/snmpv3/usm/save\n@desc Saves current user settings in the currently loaded USM config file.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/snmpv3/usm/saveas/{filename}\n@desc Saves current user settings in the specified USM config file.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration, filename: str # Filename to save}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/snmpv3/vacm/save\n@desc Saves current group, access, view settings in the currently loaded VACM config file.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/snmpv3/vacm/saveas/{filename}\n@desc Saves current group, access, view settings in the specified VACM config file.\n@required {agentNum: int(int32) # Agent to show the SNMPv3 configuration, filename: str # Filename to save}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/dhcp/get/args\n@desc Show the agent's DHCP argument structure\n@required {agentNum: int(int32) # Agent to show the DHCP argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/dhcp/get/config\n@desc Show the agent's DHCP configuration\n@required {agentNum: int(int32) # Agent to show the DHCP configuration}\n@returns(200) {hwaddr: str, classid: str, add_options: str, script: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/dhcp/set/config/{argument}/{value}\n@desc Set the agent's DHCP configuration\n@required {agentNum: int(int32) # Agent to set the DHCP configuration, argument: str # Parameter to set the DHCP configuration, value: str # Value to set the DHCP configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/dhcp/get/trace\n@desc Show the agent's DHCP traffic tracing\n@required {agentNum: int(int32) # Agent to show whether DHCP tracing is enabled}\n@returns(200) {hwaddr: str, classid: str, add_options: str, script: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/dhcp/set/trace/{enableOrNot}\n@desc Set the agent's DHCP traffic tracing\n@required {agentNum: int(int32) # Agent to set the DHCP tracing, enableOrNot: str # Value to set the DHCP tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/dhcp/get/stats_hdr\n@desc Show the DHCP statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/dhcp/get/statistics\n@desc Show the agent's DHCP statistics\n@required {agentNum: int(int32) # Agent to show DHCP statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/dhcp/params\n@desc Show the parameters configured by the server in its DHCP-OFFER message\n@required {agentNum: int(int32) # Agent to show DHCP DHCP-OFFER message}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tftp/get/args\n@desc Show the agent's TFTP argument structure\n@required {agentNum: int(int32) # Agent to show the TFTP argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tftp/get/config\n@desc Show the agent's TFTP configuration\n@required {agentNum: int(int32) # Agent to show the TFTP configuration}\n@returns(200) {server: str, port: int(int32), client: str, srcfile: str, dstfile: str, script: str, mode: str, timeout: int(int32), retries: int(int32), trace: str, cache: int(int32)} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/tftp/set/config/{argument}/{value}\n@desc Set the agent's TFTP configuration\n@required {agentNum: int(int32) # Agent to set the TFTP configuration, argument: str # Parameter to set the TFTP configuration, value: str # Value to set the TFTP configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tftp/get/trace\n@desc Show the agent's TFTP traffic tracing\n@required {agentNum: int(int32) # Agent to show whether TFTP tracing is enabled}\n@returns(200) {server: str, port: int(int32), client: str, srcfile: str, dstfile: str, script: str, mode: str, timeout: int(int32), retries: int(int32), trace: str, cache: int(int32)} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/tftp/set/trace/{enableOrNot}\n@desc Set the agent's TFTP traffic tracing\n@required {agentNum: int(int32) # Agent to set the TFTP tracing, enableOrNot: str # Value to set the TFTP tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/tftp/get/stats_hdr\n@desc Show the TFTP statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tftp/get/statistics\n@desc Show the agent's TFTP statistics\n@required {agentNum: int(int32) # Agent to show TFTP statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/protocol/msg/tftp/session/read/server/{srcfile}\n@desc Create a read session to download srcfile from server\n@required {agentNum: int(int32) # Agent to show TFTP statistics, srcfile: str # File name to retrieve from server}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/protocol/msg/tftp/session/write/server/{srcfile}\n@desc Create a read session to upload srcfile to server\n@required {agentNum: int(int32) # Agent to show TFTP statistics, srcfile: str # File name to upload to server}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tftp/{sessionID}/get/{parameter}\n@desc Show a parameter of a TFTP sesssion\n@required {agentNum: int(int32) # Agent to show TFTP parameter, sessionID: str # SessionID, parameter: str # Parameter to show}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/tftp/{sessionID}/set/{parameter}/{value}\n@desc Set a parameter of a TFTP sesssion\n@required {agentNum: int(int32) # Agent to set TFTP parameter, sessionID: str # SessionID, parameter: str # Parameter to set, value: str # Value to set}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/tftp/{sessionID}/start\n@desc Start a TFTP sesssion\n@required {agentNum: int(int32) # Agent to start TFTP transaction, sessionID: str # SessionID}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tftp/{sessionID}/status\n@desc Check a TFTP sesssion's status\n@required {agentNum: int(int32) # Agent to show TFTP transaction, sessionID: str # SessionID}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/tftp/{sessionID}/stop\n@desc Stop a TFTP sesssion\n@required {agentNum: int(int32) # Agent to stop TFTP transaction, sessionID: str # SessionID}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tod/get/args\n@desc Show the agent's TOD argument structure\n@required {agentNum: int(int32) # Agent to show the TOD argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tod/get/config\n@desc Show the agent's TOD configuration\n@required {agentNum: int(int32) # Agent to show the TOD configuration}\n@returns(200) {server: str, port: int(int32), script: str, timeout: int(int32), retries: int(int32)} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/tod/set/config/{argument}/{value}\n@desc Set the agent's TOD configuration\n@required {agentNum: int(int32) # Agent to set the TOD configuration, argument: str # Parameter to set the TOD configuration, value: str # Value to set the TOD configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tod/get/trace\n@desc Show the agent's TOD traffic tracing\n@required {agentNum: int(int32) # Agent to show whether TOD tracing is enabled}\n@returns(200) {server: str, port: int(int32), script: str, timeout: int(int32), retries: int(int32)} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/tod/set/trace/{enableOrNot}\n@desc Set the agent's TOD traffic tracing\n@required {agentNum: int(int32) # Agent to set the TOD tracing, enableOrNot: str # Value to set the TOD tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/tod/get/stats_hdr\n@desc Show the TOD statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tod/get/statistics\n@desc Show the agent's TOD statistics\n@required {agentNum: int(int32) # Agent to show TOD statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/tod/gettime/server/{serverAddr}/port/{portNum}/script/{scriptName}/timeout/{timeSec}/retries/{numRetries}\n@desc Retrieve TOD time\n@required {agentNum: int(int32) # Agent to show TOD return, serverAddr: str # serverAddr, portNum: int(int32) # portNum, scriptName: str # scriptName, timeSec: int(int32) # timeSec, numRetries: int(int32) # numRetries}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/get/args\n@desc Show the agent's TELNET argument structure\n@required {agentNum: int(int32) # Agent to show the TELNET argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/get/config\n@desc Show the agent's TELNET configuration\n@required {agentNum: int(int32) # Agent to show the TELNET configuration}\n@returns(200) {port: int(int32), rule: str, prompt: str, paging_prompt: str, userdb: str, keymap: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/telnet/set/config/{argument}/{value}\n@desc Set the agent's TELNET configuration\n@required {agentNum: int(int32) # Agent to set the TELNET configuration, argument: str # Parameter to set the TELNET configuration, value: str # Value to set the TELNET configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/get/trace\n@desc Show the agent's TELNET traffic tracing\n@required {agentNum: int(int32) # Agent to show whether TELNET tracing is enabled}\n@returns(200) {port: int(int32), rule: str, prompt: str, paging_prompt: str, userdb: str, keymap: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/telnet/set/trace/{enableOrNot}\n@desc Set the agent's TELNET traffic tracing\n@required {agentNum: int(int32) # Agent to set the TELNET tracing, enableOrNot: str # Value to set the TELNET tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/telnet/get/stats_hdr\n@desc Show the TELNET statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/get/statistics\n@desc Show the agent's TELNET statistics\n@required {agentNum: int(int32) # Agent to show TELNET statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/server/get/state\n@desc Show the agent's TELNET server state\n@required {agentNum: int(int32) # Agent to show TELNET statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/server/get/rulesdb\n@desc Show the agent's TELNET rules db file name\n@required {agentNum: int(int32) # Agent to show TELNET statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/server/get/userdb\n@desc Show the agent's TELNET user db file name\n@required {agentNum: int(int32) # Agent to show TELNET statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/server/get/keymap\n@desc Show the agent's TELNET keymap file name\n@required {agentNum: int(int32) # Agent to show TELNET statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/server/get/users\n@desc Show the agent's TELNET users\n@required {agentNum: int(int32) # Agent to show TELNET configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/server/get/connections\n@desc Show the agent's TELNET connections\n@required {agentNum: int(int32) # Agent to show TELNET configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/telnet/connection/logon/{connectionID}/{user}/{password}\n@desc Changes the connection's current logon.\n@required {agentNum: int(int32) # Agent to manipulate TELNET connection, connectionID: int(int32), user: str, password: str}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/telnet/connection/request/{connectionID}/{command}\n@desc Executes the command asynchronously .\n@required {agentNum: int(int32) # Agent to manipulate TELNET connection, connectionID: int(int32), command: str}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/telnet/connection/signal/{connectionID}/{signalName}\n@desc Triggers the asynchronous signal event with the specified signal name\n@required {agentNum: int(int32) # Agent to manipulate TELNET connection, connectionID: int(int32), signalName: str}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/telnet/ipalias/enable/{ipaddress}/{port}\n@desc Enable individual IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate TELNET IP alias, ipaddress: str, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/telnet/ipalias/disable/{ipaddress}/{port}\n@desc Disable individual IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate TELNET IP alias, ipaddress: str, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/ipalias/isenabled/{ipaddress}/{port}\n@desc Check individual IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate TELNET IP alias, ipaddress: str, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/telnet/ipalias/list\n@desc List all IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate TELNET IP alias}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ssh/get/args\n@desc Show the agent's SSH argument structure\n@required {agentNum: int(int32) # Agent to show the SSH argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ssh/get/config\n@desc Show the agent's SSH configuration\n@required {agentNum: int(int32) # Agent to show the SSH configuration}\n@returns(200) {port: int(int32), version: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/ssh/set/config/{argument}/{value}\n@desc Set the agent's SSH configuration\n@required {agentNum: int(int32) # Agent to set the SSH configuration, argument: str # Parameter to set the SSH configuration, value: str # Value to set the SSH configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ssh/get/trace\n@desc Show the agent's SSH traffic tracing\n@required {agentNum: int(int32) # Agent to show whether SSH tracing is enabled}\n@returns(200) {port: int(int32), version: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/ssh/set/trace/{enableOrNot}\n@desc Set the agent's SSH traffic tracing\n@required {agentNum: int(int32) # Agent to set the SSH tracing, enableOrNot: str # Value to set the SSH tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/ssh/get/stats_hdr\n@desc Show the SSH statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ssh/get/statistics\n@desc Show the agent's SSH statistics\n@required {agentNum: int(int32) # Agent to show SSH statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/ssh/ipalias/enable/{ipaddress}/{port}\n@desc Enable individual IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate SSH IP alias, ipaddress: str, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/ssh/ipalias/disable/{ipaddress}/{port}\n@desc Disable individual IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate SSH IP alias, ipaddress: str, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ssh/ipalias/isenabled/{ipaddress}/{port}\n@desc Check individual IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate SSH IP alias, ipaddress: str, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ssh/ipalias/list\n@desc List all IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate SSH IP alias}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmptcp/get/args\n@desc Show the agent's SNMPTCP argument structure\n@required {agentNum: int(int32) # Agent to show the SNMPTCP argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmptcp/get/config\n@desc Show the agent's SNMPTCP configuration\n@required {agentNum: int(int32) # Agent to show the SNMPTCP configuration}\n@returns(200) {connections: int(int32)} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/snmptcp/set/config/{argument}/{value}\n@desc Set the agent's SNMPTCP configuration\n@required {agentNum: int(int32) # Agent to set the SNMPTCP configuration, argument: str # Parameter to set the SNMPTCP configuration, value: str # Value to set the SNMPTCP configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmptcp/get/trace\n@desc Show the agent's SNMPTCP traffic tracing\n@required {agentNum: int(int32) # Agent to show whether SNMPTCP tracing is enabled}\n@returns(200) {connections: int(int32)} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/snmptcp/set/trace/{enableOrNot}\n@desc Set the agent's SNMPTCP traffic tracing\n@required {agentNum: int(int32) # Agent to set the SNMPTCP tracing, enableOrNot: str # Value to set the SNMPTCP tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/snmptcp/get/stats_hdr\n@desc Show the SNMPTCP statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmptcp/get/statistics\n@desc Show the agent's SNMPTCP statistics\n@required {agentNum: int(int32) # Agent to show SNMPTCP statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/snmptcp/ipalias/enable/{ipaddress}/{port}\n@desc Enable individual IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate SNMPTCP IP alias, ipaddress: str, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/snmptcp/ipalias/disable/{ipaddress}/{port}\n@desc Disable individual IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate SNMPTCP IP alias, ipaddress: str, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmptcp/ipalias/isenabled/{ipaddress}/{port}\n@desc Check individual IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate SNMPTCP IP alias, ipaddress: str, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/snmptcp/ipalias/list\n@desc List all IP aliases on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate SNMPTCP IP alias}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/syslog/get/args\n@desc Show the agent's SYSLOG argument structure\n@required {agentNum: int(int32) # Agent to show the SYSLOG argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/syslog/get/config\n@desc Show the agent's SYSLOG configuration\n@required {agentNum: int(int32) # Agent to show the SYSLOG configuration}\n@returns(200) {server: str, serverport: int(int32), client: str, localport: int(int32), sequence: int(int32), separator: str, timestamp: str, hostname: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/syslog/set/config/{argument}/{value}\n@desc Set the agent's SYSLOG configuration\n@required {agentNum: int(int32) # Agent to set the SYSLOG configuration, argument: str # Parameter to set the SYSLOG configuration, value: str # Value to set the SYSLOG configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/syslog/get/trace\n@desc Show the agent's SYSLOG traffic tracing\n@required {agentNum: int(int32) # Agent to show whether SYSLOG tracing is enabled}\n@returns(200) {server: str, serverport: int(int32), client: str, localport: int(int32), sequence: int(int32), separator: str, timestamp: str, hostname: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/syslog/set/trace/{enableOrNot}\n@desc Set the agent's SYSLOG traffic tracing\n@required {agentNum: int(int32) # Agent to set the SYSLOG tracing, enableOrNot: str # Value to set the SYSLOG tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/syslog/get/stats_hdr\n@desc Show the SYSLOG statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/syslog/get/statistics\n@desc Show the agent's SYSLOG statistics\n@required {agentNum: int(int32) # Agent to show SYSLOG statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/protocol/msg/syslog/send/{pri}\n@desc Set the agent's SYSLOG traffic tracing\n@required {agentNum: int(int32) # Agent to set the SYSLOG tracing, pri: int(int32) # Message Priority}\n@optional {sequence: str, separator: str, timestamp: str, hostname: str, message: str}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/syslog/get/{attr}\n@desc Show the outgoing message's attributes\n@required {agentNum: int(int32) # Agent to set the SYSLOG tracing, attr: str # Attribute}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/syslog/set/{attr}/{value}\n@desc Set the outgoing message's attributes\n@required {agentNum: int(int32) # Agent to set the SYSLOG tracing, attr: str # Attribute, value: str}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ipmi/get/args\n@desc Show the agent's IPMI argument structure\n@required {agentNum: int(int32) # Agent to show the IPMI argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ipmi/get/config\n@desc Show the agent's IPMI configuration\n@required {agentNum: int(int32) # Agent to show the IPMI configuration}\n@returns(200) {primary_port: int(int32), secure_port: int(int32), version: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/ipmi/set/config/{argument}/{value}\n@desc Set the agent's IPMI configuration\n@required {agentNum: int(int32) # Agent to set the IPMI configuration, argument: str # Parameter to set the IPMI configuration, value: str # Value to set the IPMI configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ipmi/get/trace\n@desc Show the agent's IPMI traffic tracing\n@required {agentNum: int(int32) # Agent to show whether IPMI tracing is enabled}\n@returns(200) {primary_port: int(int32), secure_port: int(int32), version: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/ipmi/set/trace/{enableOrNot}\n@desc Set the agent's IPMI traffic tracing\n@required {agentNum: int(int32) # Agent to set the IPMI tracing, enableOrNot: str # Value to set the IPMI tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/ipmi/get/stats_hdr\n@desc Show the IPMI statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ipmi/get/statistics\n@desc Show the agent's IPMI statistics\n@required {agentNum: int(int32) # Agent to show IPMI statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/ipmi/get/{attr}\n@desc Show the outgoing message's attributes\n@required {agentNum: int(int32) # Agent to set the IPMI tracing, attr: str # Attribute}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/ipmi/set/{attr}/{value}\n@desc Set the outgoing message's attributes\n@required {agentNum: int(int32) # Agent to set the IPMI tracing, attr: str # Attribute, value: str}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/proxy/get/args\n@desc Show the agent's PROXY argument structure\n@required {agentNum: int(int32) # Agent to show the PROXY argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/proxy/get/config\n@desc Show the agent's PROXY configuration\n@required {agentNum: int(int32) # Agent to show the PROXY configuration}\n@returns(200) {portno: int(int32), target: str, transport: str, max_connects: int(int32), TCP_NODELAY: int(int32), disconnect_delay: int(int32), pre_connect: str, client_to_server: str, server_to_client: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/proxy/set/config/{argument}/{value}\n@desc Set the agent's PROXY configuration\n@required {agentNum: int(int32) # Agent to set the PROXY configuration, argument: str # Parameter to set the PROXY configuration, value: str # Value to set the PROXY configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/proxy/get/trace\n@desc Show the agent's PROXY traffic tracing\n@required {agentNum: int(int32) # Agent to show whether PROXY tracing is enabled}\n@returns(200) {portno: int(int32), target: str, transport: str, max_connects: int(int32), TCP_NODELAY: int(int32), disconnect_delay: int(int32), pre_connect: str, client_to_server: str, server_to_client: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/proxy/set/trace/{enableOrNot}\n@desc Set the agent's PROXY traffic tracing\n@required {agentNum: int(int32) # Agent to set the PROXY tracing, enableOrNot: str # Value to set the PROXY tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/proxy/get/stats_hdr\n@desc Show the PROXY statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/proxy/get/statistics\n@desc Show the agent's PROXY statistics\n@required {agentNum: int(int32) # Agent to show PROXY statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/protocol/msg/proxy/port/add/{port}/{target}/{targetPort}\n@desc Add individual proxy target on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate PROXY target, port: int(int32), target: str, targetPort: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/proxy/port/remove/{port}\n@desc Remove individual proxy target on the agent and the simulator host\n@required {agentNum: int(int32) # Agent to manipulate PROXY target, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/proxy/port/list\n@desc List all proxy targets\n@required {agentNum: int(int32) # Agent to manipulate PROXY target}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/proxy/port/start/{port}\n@desc Start additional target\n@required {agentNum: int(int32) # Agent to manipulate PROXY target, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/proxy/port/stop/{port}\n@desc Stop additional target\n@required {agentNum: int(int32) # Agent to manipulate PROXY target, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/proxy/port/isStarted/{port}\n@desc Check individual target\n@required {agentNum: int(int32) # Agent to manipulate PROXY target, port: int(int32)}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/netflow/get/args\n@desc Show the agent's NETFLOW argument structure\n@required {agentNum: int(int32) # Agent to show the NETFLOW argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/netflow/get/config\n@desc Show the agent's NETFLOW configuration\n@required {agentNum: int(int32) # Agent to show the NETFLOW configuration}\n@returns(200) {filename: str, collector: str, collectorport: int(int32), bundleflowsets: int(int32)} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/set/config/{argument}/{value}\n@desc Set the agent's NETFLOW configuration\n@required {agentNum: int(int32) # Agent to set the NETFLOW configuration, argument: str # Parameter to set the NETFLOW configuration, value: str # Value to set the NETFLOW configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/netflow/get/trace\n@desc Show the agent's NETFLOW traffic tracing\n@required {agentNum: int(int32) # Agent to show whether NETFLOW tracing is enabled}\n@returns(200) {filename: str, collector: str, collectorport: int(int32), bundleflowsets: int(int32)} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/set/trace/{enableOrNot}\n@desc Set the agent's NETFLOW traffic tracing\n@required {agentNum: int(int32) # Agent to set the NETFLOW tracing, enableOrNot: str # Value to set the NETFLOW tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/netflow/get/stats_hdr\n@desc Show the NETFLOW statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/netflow/get/statistics\n@desc Show the agent's NETFLOW statistics\n@required {agentNum: int(int32) # Agent to show NETFLOW statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/halt\n@desc Halt NETFLOW traffic\n@required {agentNum: int(int32) # Agent to set the NETFLOW}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/set/filename/{fileName}\n@desc Swap NETFLOW configuration file\n@required {agentNum: int(int32) # Agent to set the NETFLOW, fileName: str # file name to load config}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/set/collector/{collectorIP}\n@desc Swap NETFLOW collector\n@required {agentNum: int(int32) # Agent to set the NETFLOW, collectorIP: str # file name to load config}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/reload\n@desc Reload NETFLOW configuration before resuming traffic\n@required {agentNum: int(int32) # Agent to set the NETFLOW}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/resume\n@desc Resuming traffic\n@required {agentNum: int(int32) # Agent to set the NETFLOW}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/netflow/flow/list\n@desc Show list of NETFLOW exports\n@required {agentNum: int(int32) # Agent to show NETFLOW statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/flow/change/tfs_interval/{interval}\n@desc Change NETFLOW template export interval\n@required {agentNum: int(int32) # Agent to set the NETFLOW, interval: int(int32) # NETFLOW export interval}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/flow/change/dfs_interval/{interval}\n@desc Change NETFLOW data export interval\n@required {agentNum: int(int32) # Agent to set the NETFLOW, interval: int(int32) # NETFLOW export interval}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/netflow/flow/change/{flowset-uid}/{field-num}/{attr}/{value}\n@desc Change NETFLOW export attributes\n@required {agentNum: int(int32) # Agent to set the NETFLOW, flowset-uid: int(int32), field-num: int(int32), attr: str, value: str}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/sflow/get/args\n@desc Show the agent's SFLOW argument structure\n@required {agentNum: int(int32) # Agent to show the SFLOW argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/sflow/get/config\n@desc Show the agent's SFLOW configuration\n@required {agentNum: int(int32) # Agent to show the SFLOW configuration}\n@returns(200) {filename: str, collector: str, collectorport: int(int32), flows_per_min: int(int32), encoding_type: str, include_samples: str, records_per_sample: str, samples_per_datagram: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/sflow/set/config/{argument}/{value}\n@desc Set the agent's SFLOW configuration\n@required {agentNum: int(int32) # Agent to set the SFLOW configuration, argument: str # Parameter to set the SFLOW configuration, value: str # Value to set the SFLOW configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/sflow/get/trace\n@desc Show the agent's SFLOW traffic tracing\n@required {agentNum: int(int32) # Agent to show whether SFLOW tracing is enabled}\n@returns(200) {filename: str, collector: str, collectorport: int(int32), flows_per_min: int(int32), encoding_type: str, include_samples: str, records_per_sample: str, samples_per_datagram: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/sflow/set/trace/{enableOrNot}\n@desc Set the agent's SFLOW traffic tracing\n@required {agentNum: int(int32) # Agent to set the SFLOW tracing, enableOrNot: str # Value to set the SFLOW tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/sflow/get/stats_hdr\n@desc Show the SFLOW statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/sflow/get/statistics\n@desc Show the agent's SFLOW statistics\n@required {agentNum: int(int32) # Agent to show SFLOW statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/sflow/halt\n@desc Halt SFLOW traffic\n@required {agentNum: int(int32) # Agent to set the SFLOW}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/sflow/reload\n@desc Reload SFLOW configuration before resuming traffic\n@required {agentNum: int(int32) # Agent to set the SFLOW}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/sflow/resume\n@desc Resuming traffic\n@required {agentNum: int(int32) # Agent to set the SFLOW}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/web/get/args\n@desc Show the agent's WEB argument structure\n@required {agentNum: int(int32) # Agent to show the WEB argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/web/get/config\n@desc Show the agent's WEB configuration\n@required {agentNum: int(int32) # Agent to show the WEB configuration}\n@returns(200) {port: int(int32), is_persistent_connections: int(int32), rule: str, wsdl: str, username: str, password: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/web/set/config/{argument}/{value}\n@desc Set the agent's WEB configuration\n@required {agentNum: int(int32) # Agent to set the WEB configuration, argument: str # Parameter to set the WEB configuration, value: str # Value to set the WEB configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/web/get/trace\n@desc Show the agent's WEB traffic tracing\n@required {agentNum: int(int32) # Agent to show whether WEB tracing is enabled}\n@returns(200) {port: int(int32), is_persistent_connections: int(int32), rule: str, wsdl: str, username: str, password: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/web/set/trace/{enableOrNot}\n@desc Set the agent's WEB traffic tracing\n@required {agentNum: int(int32) # Agent to set the WEB tracing, enableOrNot: str # Value to set the WEB tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/web/get/stats_hdr\n@desc Show the WEB statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/web/get/statistics\n@desc Show the agent's WEB statistics\n@required {agentNum: int(int32) # Agent to show WEB statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/web/port/exists/{port}\n@desc Show the agent's WEB port\n@required {agentNum: int(int32) # Agent to show WEB configuration, port: int(int32) # TCP port}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/agent/{agentNum}/protocol/msg/web/port/add/{port}\n@desc Add the agent's WEB port\n@required {agentNum: int(int32) # Agent to add WEB port, port: int(int32) # TCP port}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/web/port/set/{port}/{protocol}/{version}\n@desc Set the agent's WEB port attribute\n@required {agentNum: int(int32) # Agent to set WEB port, port: int(int32) # TCP port, protocol: str # Encryption or related protocol, version: str # Encryption or related protocol version}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/web/port/start/{port}\n@desc Start the agent's WEB port\n@required {agentNum: int(int32) # Agent to start WEB port, port: int(int32) # TCP port}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/web/port/stop/{port}\n@desc Stop the agent's WEB port\n@required {agentNum: int(int32) # Agent to stop WEB port, port: int(int32) # TCP port}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/agent/{agentNum}/protocol/msg/web/port/remove/{port}\n@desc Remove the agent's WEB port\n@required {agentNum: int(int32) # Agent to remove WEB port, port: int(int32) # TCP port}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/get/args\n@desc Show the agent's MQTT argument structure\n@required {agentNum: int(int32) # Agent to show the MQTT argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/get/config\n@desc Show the agent's MQTT configuration\n@required {agentNum: int(int32) # Agent to show the MQTT configuration}\n@returns(200) {filename: str, broker: str, port: int(int32), clientid: str, username: str, password: str, version: str, is_tls: str, tls_conf_filename: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/set/config/{argument}/{value}\n@desc Set the agent's MQTT configuration\n@required {agentNum: int(int32) # Agent to set the MQTT configuration, argument: str # Parameter to set the MQTT configuration, value: str # Value to set the MQTT configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/get/trace\n@desc Show the agent's MQTT traffic tracing\n@required {agentNum: int(int32) # Agent to show whether MQTT tracing is enabled}\n@returns(200) {filename: str, broker: str, port: int(int32), clientid: str, username: str, password: str, version: str, is_tls: str, tls_conf_filename: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/set/trace/{enableOrNot}\n@desc Set the agent's MQTT traffic tracing\n@required {agentNum: int(int32) # Agent to set the MQTT tracing, enableOrNot: str # Value to set the MQTT tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/mqtt/get/stats_hdr\n@desc Show the MQTT statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/get/statistics\n@desc Show the agent's MQTT statistics\n@required {agentNum: int(int32) # Agent to show MQTT statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/client/get/state\n@desc Show the agent's MQTT state\n@required {agentNum: int(int32) # Agent to show MQTT state}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/client/get/protstate\n@desc Show the agent's MQTT TCP connection state\n@required {agentNum: int(int32) # Agent to show MQTT state}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/broker/{brokerAddr}\n@desc Set the agent's MQTT TCP connection target broker\n@required {agentNum: int(int32) # Agent to set MQTT config, brokerAddr: str # Broker address}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/port/{port}\n@desc Set the agent's MQTT TCP connection target port\n@required {agentNum: int(int32) # Agent to set MQTT config, port: str # TCP port}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/clientid/{clientID}\n@desc Set the agent's MQTT client ID\n@required {agentNum: int(int32) # Agent to set MQTT config, clientID: str # Client ID}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/username/{username}\n@desc Set the agent's MQTT client username\n@required {agentNum: int(int32) # Agent to set MQTT config, username: str # User name}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/password/{password}\n@desc Set the agent's MQTT client password\n@required {agentNum: int(int32) # Agent to set MQTT config, password: str # Password}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/willtopic/{topic}\n@desc Set the agent's MQTT client will's topic\n@required {agentNum: int(int32) # Agent to set MQTT config, topic: str # topic}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/willmsg/{msg}\n@desc Set the agent's MQTT client's will\n@required {agentNum: int(int32) # Agent to set MQTT config, msg: str # Will message}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/willretain/{retain}\n@desc Set the agent's MQTT retained will\n@required {agentNum: int(int32) # Agent to set MQTT config, retain: str # Retaining will}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/willqos/{qos}\n@desc Set the agent's MQTT will message's QOS field\n@required {agentNum: int(int32) # Agent to set MQTT config, qos: str # Quality of service field}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/cleansession/{cleanOrNot}\n@desc Set the agent's MQTT session\n@required {agentNum: int(int32) # Agent to set MQTT config, cleanOrNot: int(int32) # Clean session}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/keepalive/{aliveTime}\n@desc Set the agent's MQTT TCP keepalive\n@required {agentNum: int(int32) # Agent to set MQTT config, aliveTime: int(int32) # period to send keepalive messages}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/set/on_disconnect/{action}\n@desc Set the agent's MQTT disconnection action\n@required {agentNum: int(int32) # Agent to set MQTT config, action: str # Action to take}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/runtime/abort\n@desc Abort agent's MQTT TCP session without sending DISCONNECT command\n@required {agentNum: int(int32) # Agent to set MQTT behavior}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/runtime/disconnect\n@desc Disconnect agent's MQTT TCP session by sending DISCONNECT command\n@required {agentNum: int(int32) # Agent to set MQTT behavior}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/runtime/connect\n@desc Start agent's MQTT TCP session\n@required {agentNum: int(int32) # Agent to set MQTT behavior}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/client/message/card\n@desc Show the agent's current messages' cardinality\n@required {agentNum: int(int32) # Agent to show MQTT message state}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/client/message/get/{msgNum}/{attr}\n@desc Show the agent's message attributes\n@required {agentNum: int(int32) # Agent to show MQTT state, msgNum: int(int32) # Message Number, attr: str # Attribute}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/message/set/{msgNum}/{attr}/{value}\n@desc Set the agent's message attributes\n@required {agentNum: int(int32) # Agent to show MQTT state, msgNum: int(int32) # Message Number, attr: str # Attribute, value: str # Value}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/client/subscribe/card\n@desc Show the agent's current subscriptions' cardinality\n@required {agentNum: int(int32) # Agent to show MQTT subscription state}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/mqtt/client/subscribe/get/{subNum}/{attr}\n@desc Show the agent's subscription attributes\n@required {agentNum: int(int32) # Agent to show MQTT state, subNum: int(int32) # Subscribe Number, attr: str # Attribute}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/unsubscribe/{subNum}\n@desc Stops receiving messages from a subcription of the agent\n@required {agentNum: int(int32) # Agent to change MQTT state, subNum: int(int32) # Subscription Number}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/resubscribe/{subNum}\n@desc Restart receiving messages from a subcription of the agent\n@required {agentNum: int(int32) # Agent to change MQTT state, subNum: int(int32) # Subscription Number}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/mqtt/client/subscribe/set/{subNum}/{attr}/{value}\n@desc Set the agent's subscribe attributes\n@required {agentNum: int(int32) # Agent to show MQTT state, subNum: int(int32) # Subscribe Number, attr: str # Attribute, value: str # Value}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/coap/get/args\n@desc Show the agent's COAP argument structure\n@required {agentNum: int(int32) # Agent to show the COAP argument structure}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/coap/get/config\n@desc Show the agent's COAP configuration\n@required {agentNum: int(int32) # Agent to show the COAP configuration}\n@returns(200) {primary_port: int(int32), rule: str, secure_port: int(int32), keystore: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/coap/set/config/{argument}/{value}\n@desc Set the agent's COAP configuration\n@required {agentNum: int(int32) # Agent to set the COAP configuration, argument: str # Parameter to set the COAP configuration, value: str # Value to set the COAP configuration}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/coap/get/trace\n@desc Show the agent's COAP traffic tracing\n@required {agentNum: int(int32) # Agent to show whether COAP tracing is enabled}\n@returns(200) {primary_port: int(int32), rule: str, secure_port: int(int32), keystore: str} # successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/agent/{agentNum}/protocol/msg/coap/set/trace/{enableOrNot}\n@desc Set the agent's COAP traffic tracing\n@required {agentNum: int(int32) # Agent to set the COAP tracing, enableOrNot: str # Value to set the COAP tracing}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/protocol/msg/coap/get/stats_hdr\n@desc Show the COAP statistics headers\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/agent/{agentNum}/protocol/msg/coap/get/statistics\n@desc Show the agent's COAP statistics\n@required {agentNum: int(int32) # Agent to show COAP statistics}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/access/get/adminuser\n@desc Returns the current administrator.\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/access/get/admindir\n@desc Returns the current admin directory.\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/access/get/acldb\n@desc Returns the current access control database in use.\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/access/set/acldb/{databaseName}\n@desc Allows setting the name of the current access control database.\n@required {databaseName: str # Database name to use}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/access/get/enabled\n@desc Returns the state of access control checking.\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/access/set/enabled/{enabledOrNot}\n@desc Allows the user to enable/disable the access control check.\n@required {enabledOrNot: str # indicator}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/access/load/{filename}\n@desc Loads the specified file for access control data.\n@required {filename: str # Filename to load}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint PUT /mimic/access/save/{filename}\n@desc Saves current access control data in specified file.\n@required {filename: str # Filename to save}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint GET /mimic/access/list\n@desc Returns an array of entries.\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint POST /mimic/access/add/{user}/{agents}/{mask}\n@desc Adds/Overwrites the user entry in the access control database.\n@required {user: str # Username of the simulator hosting system, agents: str # Agent range in minimal range representation, mask: str # Currently not used}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@endpoint DELETE /mimic/access/del/{user}\n@desc Clears a users entry from access control database.\n@required {user: str # username of the simulator hosting system}\n@returns(200) successful operation\n@errors {400: Invalid agent number value}\n\n@end\n"}