openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 248 kB
JSON
{"openapi":"3.0.0","servers":[{"url":"http://gambitcomm.local"},{"description":"Gambit Communications MIMIC simulator REST API","url":"http://127.0.0.1"}],"info":{"contact":{"email":"support@gambitcomm.com"},"description":"This is the API for MIMIC client to connect to MIMIC daemon.","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"https://www.gambitcomm.com/terms/","title":"MIMIC REST API","version":"21.00","x-apisguru-categories":["iot"],"x-logo":{"url":"https://www.gambitcomm.com/site/images/logo.png"},"x-origin":[{"format":"openapi","url":"https://www.gambitcomm.com/docs/mimic.yaml","version":"3.0"}],"x-providerName":"gambitcomm.local","x-serviceName":"mimic"},"externalDocs":{"description":"Find out more about Gambit","url":"https://www.gambitcomm.com/site/about.php"},"security":[{"basicAuth":[]}],"paths":{"/mimic/access/add/{user}/{agents}/{mask}":{"post":{"description":"Adds/Overwrites the user entry in the access control database.","operationId":"access_add","parameters":[{"description":"Username of the simulator hosting system","in":"path","name":"user","required":true,"schema":{"type":"string"}},{"description":"Agent range in minimal range representation","in":"path","name":"agents","required":true,"schema":{"type":"string"}},{"description":"Currently not used","in":"path","name":"mask","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Adds/Overwrites the user entry in the access control database.","tags":["Access"]}},"/mimic/access/del/{user}":{"delete":{"description":"Using '*' for user clears all the users.","operationId":"access_del","parameters":[{"description":"username of the simulator hosting system","in":"path","name":"user","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Clears a users entry from access control database.","tags":["Access"]}},"/mimic/access/get/acldb":{"get":{"description":"If nothing is specified then this returns \"\".","operationId":"access_get_acldb","responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Returns the current access control database in use.","tags":["Access"]}},"/mimic/access/get/admindir":{"get":{"description":"If nothing is specified in admin/settings.cfg then returns \"\". If no admin directory is specified then the shared area will be used where needed (e.g. for persistent info, access control data files etc. )","operationId":"access_get_admindir","responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Returns the current admin directory.","tags":["Access"]}},"/mimic/access/get/adminuser":{"get":{"description":"If nothing is specified in admin/settings.cfg then returns \"\".","operationId":"access_get_adminuser","responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Returns the current administrator.","tags":["Access"]}},"/mimic/access/get/enabled":{"get":{"description":"0 indicates that it is disabled, 1 indicates it is enabled.","operationId":"access_get_enabled","responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Returns the state of access control checking.","tags":["Access"]}},"/mimic/access/list":{"get":{"description":"Each entry consists of user, agents (in minimal range representation) and access mask (not used currently).","operationId":"access_list","responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AccessEntry"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Returns an array of entries.","tags":["Access"]}},"/mimic/access/load/{filename}":{"put":{"description":"If filename is not specified then the currently set 'acldb' parameter is used.","operationId":"access_load","parameters":[{"description":"Filename to load","in":"path","name":"filename","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Loads the specified file for access control data.","tags":["Access"]}},"/mimic/access/save/{filename}":{"put":{"description":"If filename is not specified then the currently set 'acldb' parameter is used.","operationId":"access_save","parameters":[{"description":"Filename to save","in":"path","name":"filename","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Saves current access control data in specified file.","tags":["Access"]}},"/mimic/access/set/acldb/{databaseName}":{"put":{"description":"This will be used for subsequent load and save operations.","operationId":"access_set_acldb","parameters":[{"description":"Database name to use","in":"path","name":"databaseName","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Allows setting the name of the current access control database.","tags":["Access"]}},"/mimic/access/set/enabled/{enabledOrNot}":{"put":{"description":"0 indicates disabled, 1 indicates enabled.","operationId":"access_set_enabled","parameters":[{"description":"indicator","in":"path","name":"enabledOrNot","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Allows the user to enable/disable the access control check.","tags":["Access"]}},"/mimic/agent/{agentNum}/add/{IP}":{"post":{"description":"Add an agent.","operationId":"new","parameters":[{"description":"Agent to return the primary IP","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Primary IP","in":"path","name":"IP","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"description":"Triplet array","items":{"$ref":"#/components/schemas/Triplet"},"type":"array"}}},"description":"Created agent object","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Add an agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/from/add/{IP}/{port}":{"post":{"description":"An empty ipaddress or 0.0.0.0 both imply any address. Similarly an empty port or 0 both imply any port. For agents with source-address-indexing enabled, messages which do not match any source address will be discarded with an ERROR message, similar to community string mismatches.","operationId":"from_add","parameters":[{"description":"Agent to add the IP source","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"IP of the port, 0.0.0.0 for any","in":"path","name":"IP","required":true,"schema":{"type":"string"}},{"description":"port of the source, 0 for any","in":"path","name":"port","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Add a source address that the agent will accept messages from.","tags":["Agent"]}},"/mimic/agent/{agentNum}/from/delete/{IP}/{port}":{"delete":{"description":"An empty ipaddress or 0.0.0.0 both imply any address. Similarly an empty port or 0 both imply any port. For agents with source-address-indexing enabled, messages which do not match any source address will be discarded with an ERROR message, similar to community string mismatches.","operationId":"from_del","parameters":[{"description":"Agent to delete the IP source","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"IP of the source","in":"path","name":"IP","required":true,"schema":{"type":"string"}},{"description":"port of the source","in":"path","name":"port","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"delete a source address that the agent will accept messages from.","tags":["Agent"]}},"/mimic/agent/{agentNum}/from/list":{"get":{"description":"This in effect implements source-address-indexing, where 2 agents with the same address can be configured, each accepting messages from different management stations.","operationId":"from_list","parameters":[{"description":"Agent to show the IP sources","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/IPSource"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"List the source addresses that the agent will accept messages from.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/changed":{"get":{"description":"has the agent value space changed?","operationId":"get_changed","parameters":[{"description":"Agent to return the indicator","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"has the agent value space changed?","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/config_changed":{"get":{"description":"has the lab configuration changed?","operationId":"get_config_changed","parameters":[{"description":"Agent to return the indicator","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"has the lab configuration changed?","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/delay":{"get":{"description":"The minimum granularity is 10 msec.","operationId":"get_delay","parameters":[{"description":"Agent to return the delay time","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/get/start","parameters":{"agentNum":"$request.body#/agentNum"}}}},"400":{"description":"Invalid agent number value"}},"summary":"one-way transit delay in msec.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/drops":{"get":{"description":"drop rate (every N-th PDU). 0 means no drops.","operationId":"get_drops","parameters":[{"description":"Agent to return the drop rate","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"drop rate (every N-th PDU). 0 means no drops.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/host":{"get":{"description":"Currently, only IPv4 addresses are allowed as the main address of the agent, but both IPv4 and IPv6 addresses are allowed as IP aliases for the agent.","operationId":"get_host","parameters":[{"description":"Agent to return the primary IP","in":"path","name":"agentNum","required":true,"schema":{"format":"string","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/value/get/{object}/{instance}/{variable}","parameters":{"agentNum":"$request.body#/agentNum","instance":"$response.body#","object":"ipAdEntIfIndex","variable":"v"}}}},"400":{"description":"Invalid agent number value"}},"summary":"host address of the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/inform_timeout":{"get":{"description":"The agent will retransmit INFORM PDUs at this interval until it has received a reply from the manager.","operationId":"get_inform_timeout","parameters":[{"description":"Agent to return the timeout setting","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"timeout in seconds for retransmitting INFORM PDUs.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/interface":{"get":{"description":"network interface card for the agent.","operationId":"get_interface","parameters":[{"description":"Agent to return the primary interface","in":"path","name":"agentNum","required":true,"schema":{"format":"string","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/get/mask","parameters":{"agentNum":"$request.body#/agentNum"}}}},"400":{"description":"Invalid agent number value"}},"summary":"network interface card for the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/mask":{"get":{"description":"subnet mask of the agent.","operationId":"get_mask","parameters":[{"description":"Agent to return the primary interface","in":"path","name":"agentNum","required":true,"schema":{"format":"string","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/get/port","parameters":{"agentNum":"$request.body#/agentNum"}}}},"400":{"description":"Invalid agent number value"}},"summary":"subnet mask of the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/mibs":{"get":{"description":"set of MIBs, simulations and scenarios","operationId":"get_mibs","parameters":[{"description":"Agent to return the MIB triplets","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Triplet"},"type":"array"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/get/sim","parameters":{"agentNum":"$request.body#/agentNum"}}}},"400":{"description":"Invalid agent number value"}},"summary":"set of MIBs, simulations and scenarios","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/num_starts":{"get":{"description":"This count is incremented each time an agent starts. It affects the SNMPv3 EngineBoots parameter.","operationId":"get_number_starts","parameters":[{"description":"Agent to return the count","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"number of starts for the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/oiddir":{"get":{"description":"MIB directory of the agent.","operationId":"get_oiddir","parameters":[{"description":"Agent to return the directory path","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"MIB directory of the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/owner":{"get":{"description":"owner of the agent.","operationId":"get_owner","parameters":[{"description":"Agent to return the owner","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"owner of the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/pdusize":{"get":{"description":"The limit for this configurable is 65536.","operationId":"get_pdusize","parameters":[{"description":"Agent to return the PDU size","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"maximum PDU size.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/port":{"get":{"description":"port number","operationId":"get_port","parameters":[{"description":"Agent to return the primary SNMP port","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/get/protocol","parameters":{"agentNum":"$request.body#/agentNum"}}}},"400":{"description":"Invalid agent number value"}},"summary":"port number","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/privdir":{"get":{"description":"private directory of the agent.","operationId":"get_privdir","parameters":[{"description":"Agent to return the directory path","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"private directory of the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/protocol":{"get":{"description":"protocols supported by agent as an array of strings","operationId":"get_protocols","parameters":[{"description":"Agent to return the protocols arrary","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/protocol/{prot}/get/config","parameters":{"agentNum":"$request.body#/agentNum","prot":"$response.body#"}}}},"400":{"description":"Invalid agent number value"}},"summary":"protocols supported by agent","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/read":{"get":{"description":"read community string","operationId":"get_read_community","parameters":[{"description":"Agent to return the SNMP read community string","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/get/write","parameters":{"agentNum":"$request.body#/agentNum"}}}},"400":{"description":"Invalid agent number value"}},"summary":"read community string","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/scen":{"get":{"description":"first scenario name","operationId":"get_scen","parameters":[{"description":"Agent to return the first scenario number","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"first scenario name","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/sim":{"get":{"description":"first simulation name","operationId":"get_sim","parameters":[{"description":"Agent to return the first simulation name","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/get/scen","parameters":{"agentNum":"$request.body#/agentNum"}}}},"400":{"description":"Invalid agent number value"}},"summary":"first simulation name","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/start":{"get":{"description":"relative start time","operationId":"get_starttime","parameters":[{"description":"Agent to return the relative start time","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/get/mibs","parameters":{"agentNum":"$request.body#/agentNum"}}}},"400":{"description":"Invalid agent number value"}},"summary":"relative start time","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/state":{"get":{"description":"0-Unknown 1-Running 2-Stopped 3-Halted 4-Paused 5-Deleted 6-Stopping","operationId":"get_agent_state","parameters":[{"description":"Agent to return the state","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"current running state of the agent","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/state_changed":{"get":{"description":"has the agent state changed?","operationId":"get_state_changed","parameters":[{"description":"Agent to return the indicator","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"has the agent state changed?","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/statistics":{"get":{"description":"The statistics are returned as 64-bit decimal numbers for the following statistics, total, discarded, error, GET, GETNEXT, SET, GETBULK, trap, GET variables, GETNEXT variables, SET variables, GETBULK variables, INFORM sent, INFORM re-sent, INFORM timed out, INFORM acked, INFORM REPORT","operationId":"get_statistics","parameters":[{"description":"Agent to return the statistics","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"format":"int32","type":"integer"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"current statistics of the agent instance","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/trace":{"get":{"description":"SNMP PDU tracing","operationId":"get_trace","parameters":[{"description":"Agent to return the indicator","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"SNMP PDU tracing","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/validate":{"get":{"description":"Is a bitmask in which with the following bits (from LSB) check for type, length, range, access","operationId":"get_validate","parameters":[{"description":"Agent to return the bitmask integer","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"int32","type":"integer"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"SNMP SET validation policy.","tags":["Agent"]}},"/mimic/agent/{agentNum}/get/write":{"get":{"description":"write community string","operationId":"get_write_community","parameters":[{"description":"Agent to return the SNMP write community string","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation","links":{"address":{"operationRef":"#/mimic/agent/{agentNum}/get/delay","parameters":{"agentNum":"$request.body#/agentNum"}}}},"400":{"description":"Invalid agent number value"}},"summary":"write community string","tags":["Agent"]}},"/mimic/agent/{agentNum}/halt":{"put":{"description":"Halt the current agent.","operationId":"halt","parameters":[{"description":"Agent to return the primary IP","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Halt the current agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface}":{"post":{"description":"port defaults to 161 if not specified. mask defaults to the class-based network mask for the address. interface defaults to the default network interface. If port is set to 0, the system will automatically select a port number. This is useful for client-mode protocols, such as TFTP or TOD. Upon start of an IP alias with a 0 (auto-assigned) port number, its port will change to contain the value of the selected system port.","operationId":"add_ipalias","parameters":[{"description":"Agent to add the IP alias","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"IP address , IPv4 or IPv6","in":"path","name":"IP","required":true,"schema":{"type":"string"}},{"description":"SNMP port , 0 or empty for default","in":"path","name":"port","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Netmask, empty for default","in":"path","name":"mask","required":true,"schema":{"type":"string"}},{"description":"Interface. Empty for default","in":"path","name":"interface","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Adds a new ipalias for the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/ipalias/delete/{IP}/{port}":{"delete":{"description":"port defaults to 161 if not specified.","operationId":"del_ipalias","parameters":[{"description":"Agent to delete the IP alias","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"IP address , IPv4 or IPv6","in":"path","name":"IP","required":true,"schema":{"type":"string"}},{"description":"SNMP port , 0 or empty for default","in":"path","name":"port","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Deletes an existing ipalias from the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/ipalias/list":{"get":{"description":"The agent host address (set with mimic agent set host) is not in this list, since it is already accessible separately with mimic agent get host.","operationId":"list_ipaliases","parameters":[{"description":"Agent to show the IP alias list","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/IPAlias"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Lists all the additional ipaliases configured for the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/ipalias/start/{IP}/{port}":{"put":{"description":"port defaults to 161 if not specified.","operationId":"start_ipalias","parameters":[{"description":"Agent to start the IP alias","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"IP address , IPv4 or IPv6","in":"path","name":"IP","required":true,"schema":{"type":"string"}},{"description":"SNMP port , 0 or empty for default","in":"path","name":"port","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Starts an existing ipalias for the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/ipalias/status/{IP}/{port}":{"get":{"description":"port defaults to 161 if not specified.","operationId":"status_ipalias","parameters":[{"description":"Agent to show status of the IP alias","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"IP address , IPv4 or IPv6","in":"path","name":"IP","required":true,"schema":{"type":"string"}},{"description":"SNMP port , 0 or empty for default","in":"path","name":"port","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Returns the status (0=down, 1=up) of an existing ipalias for the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/ipalias/stop/{IP}/{port}":{"put":{"description":"port defaults to 161 if not specified.","operationId":"stop_ipalias","parameters":[{"description":"Agent to stop the IP alias","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"IP address , IPv4 or IPv6","in":"path","name":"IP","required":true,"schema":{"type":"string"}},{"description":"SNMP port , 0 or empty for default","in":"path","name":"port","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Stops an existing ipalias for the agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/pause":{"put":{"description":"Pause the current agent.","operationId":"pause_now","parameters":[{"description":"Agent to return the primary IP","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Pause the current agent.","tags":["Agent"]}},"/mimic/agent/{agentNum}/protocol/msg/coap/get/args":{"get":{"description":"Agent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap","operationId":"protocol_coap_get_args","parameters":[{"description":"Agent to show the COAP argument structure","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's COAP argument structure","tags":["COAP"]}},"/mimic/agent/{agentNum}/protocol/msg/coap/get/config":{"get":{"description":"Agent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap","operationId":"protocol_coap_get_config","parameters":[{"description":"Agent to show the COAP configuration","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigCOAP"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's COAP configuration","tags":["COAP"]}},"/mimic/agent/{agentNum}/protocol/msg/coap/get/statistics":{"get":{"description":"Statistics of fields indicated in the headers","operationId":"protocol_coap_get_statistics","parameters":[{"description":"Agent to show COAP statistics","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"format":"int32","type":"integer"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's COAP statistics","tags":["COAP"]}},"/mimic/agent/{agentNum}/protocol/msg/coap/get/trace":{"get":{"description":"Trace 1 means enabled, 0 means not","operationId":"protocol_coap_get_trace","parameters":[{"description":"Agent to show whether COAP tracing is enabled","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigCOAP"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's COAP traffic tracing","tags":["COAP"]}},"/mimic/agent/{agentNum}/protocol/msg/coap/set/config/{argument}/{value}":{"put":{"description":"Agent's COAP configuration with port,rule,prompt,paging_prompt,userdb,keymap","operationId":"protocol_coap_set_config","parameters":[{"description":"Agent to set the COAP configuration","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Parameter to set the COAP configuration","in":"path","name":"argument","required":true,"schema":{"type":"string"}},{"description":"Value to set the COAP configuration","in":"path","name":"value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Set the agent's COAP configuration","tags":["COAP"]}},"/mimic/agent/{agentNum}/protocol/msg/coap/set/trace/{enableOrNot}":{"put":{"description":"1 to enable, 0 to disable","operationId":"protocol_coap_set_trace","parameters":[{"description":"Agent to set the COAP tracing","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Value to set the COAP tracing","in":"path","name":"enableOrNot","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Set the agent's COAP traffic tracing","tags":["COAP"]}},"/mimic/agent/{agentNum}/protocol/msg/dhcp/get/args":{"get":{"description":"Agent's DHCP configuration particulars","operationId":"protocol_dhcp_get_args","parameters":[{"description":"Agent to show the DHCP argument structure","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's DHCP argument structure","tags":["DHCP"]}},"/mimic/agent/{agentNum}/protocol/msg/dhcp/get/config":{"get":{"description":"Agent's DHCP configuration hwaddr,classid,add_options,script","operationId":"protocol_dhcp_get_config","parameters":[{"description":"Agent to show the DHCP configuration","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigDHCP"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's DHCP configuration","tags":["DHCP"]}},"/mimic/agent/{agentNum}/protocol/msg/dhcp/get/statistics":{"get":{"description":"Statistics of fields indicated in the headers","operationId":"protocol_dhcp_get_statistics","parameters":[{"description":"Agent to show DHCP statistics","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"format":"int32","type":"integer"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's DHCP statistics","tags":["DHCP"]}},"/mimic/agent/{agentNum}/protocol/msg/dhcp/get/trace":{"get":{"description":"Trace 1 means enabled, 0 means not","operationId":"protocol_dhcp_get_trace","parameters":[{"description":"Agent to show whether DHCP tracing is enabled","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigDHCP"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's DHCP traffic tracing","tags":["DHCP"]}},"/mimic/agent/{agentNum}/protocol/msg/dhcp/params":{"get":{"description":"DHCP-OFFER message parameters","operationId":"protocol_dhcp_params","parameters":[{"description":"Agent to show DHCP DHCP-OFFER message","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"object"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the parameters configured by the server in its DHCP-OFFER message","tags":["DHCP"]}},"/mimic/agent/{agentNum}/protocol/msg/dhcp/set/config/{argument}/{value}":{"put":{"description":"Agent's DHCP configuration with port,rule,prompt,paging_prompt,userdb,keymap","operationId":"protocol_dhcp_set_config","parameters":[{"description":"Agent to set the DHCP configuration","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Parameter to set the DHCP configuration","in":"path","name":"argument","required":true,"schema":{"type":"string"}},{"description":"Value to set the DHCP configuration","in":"path","name":"value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Set the agent's DHCP configuration","tags":["DHCP"]}},"/mimic/agent/{agentNum}/protocol/msg/dhcp/set/trace/{enableOrNot}":{"put":{"description":"1 to enable, 0 to disable","operationId":"protocol_dhcp_set_trace","parameters":[{"description":"Agent to set the DHCP tracing","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Value to set the DHCP tracing","in":"path","name":"enableOrNot","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Set the agent's DHCP traffic tracing","tags":["DHCP"]}},"/mimic/agent/{agentNum}/protocol/msg/ipmi/get/args":{"get":{"description":"Agent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap","operationId":"protocol_ipmi_get_args","parameters":[{"description":"Agent to show the IPMI argument structure","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's IPMI argument structure","tags":["IPMI"]}},"/mimic/agent/{agentNum}/protocol/msg/ipmi/get/config":{"get":{"description":"Agent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap","operationId":"protocol_ipmi_get_config","parameters":[{"description":"Agent to show the IPMI configuration","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIPMI"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's IPMI configuration","tags":["IPMI"]}},"/mimic/agent/{agentNum}/protocol/msg/ipmi/get/statistics":{"get":{"description":"Statistics of fields indicated in the headers","operationId":"protocol_ipmi_get_statistics","parameters":[{"description":"Agent to show IPMI statistics","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"format":"int32","type":"integer"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's IPMI statistics","tags":["IPMI"]}},"/mimic/agent/{agentNum}/protocol/msg/ipmi/get/trace":{"get":{"description":"Trace 1 means enabled, 0 means not","operationId":"protocol_ipmi_get_trace","parameters":[{"description":"Agent to show whether IPMI tracing is enabled","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfigIPMI"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's IPMI traffic tracing","tags":["IPMI"]}},"/mimic/agent/{agentNum}/protocol/msg/ipmi/get/{attr}":{"get":{"description":"Attribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N","operationId":"protocol_ipmi_get_attr","parameters":[{"description":"Agent to set the IPMI tracing","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Attribute","in":"path","name":"attr","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the outgoing message's attributes","tags":["IPMI"]}},"/mimic/agent/{agentNum}/protocol/msg/ipmi/set/config/{argument}/{value}":{"put":{"description":"Agent's IPMI configuration with port,rule,prompt,paging_prompt,userdb,keymap","operationId":"protocol_ipmi_set_config","parameters":[{"description":"Agent to set the IPMI configuration","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Parameter to set the IPMI configuration","in":"path","name":"argument","required":true,"schema":{"type":"string"}},{"description":"Value to set the IPMI configuration","in":"path","name":"value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Set the agent's IPMI configuration","tags":["IPMI"]}},"/mimic/agent/{agentNum}/protocol/msg/ipmi/set/trace/{enableOrNot}":{"put":{"description":"1 to enable, 0 to disable","operationId":"protocol_ipmi_set_trace","parameters":[{"description":"Agent to set the IPMI tracing","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Value to set the IPMI tracing","in":"path","name":"enableOrNot","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Set the agent's IPMI traffic tracing","tags":["IPMI"]}},"/mimic/agent/{agentNum}/protocol/msg/ipmi/set/{attr}/{value}":{"put":{"description":"Attribute can be working_authtype ,session_id, outbound_seq, inbound_seq , field_N","operationId":"protocol_ipmi_set_attr","parameters":[{"description":"Agent to set the IPMI tracing","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Attribute","in":"path","name":"attr","required":true,"schema":{"type":"string"}},{"in":"path","name":"value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"string"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Set the outgoing message's attributes","tags":["IPMI"]}},"/mimic/agent/{agentNum}/protocol/msg/mqtt/client/get/protstate":{"get":{"description":"0 - stopped, 2 - disconnected, 3 - connecting, 4 - connected, 5 - waiting for CONNACK, 6 - waiting for SUBACK, 7 - CONNACK received, in steady state","operationId":"protocol_mqtt_client_get_protstate","parameters":[{"description":"Agent to show MQTT state","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"format":"int32","type":"integer"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's MQTT TCP connection state","tags":["MQTT"]}},"/mimic/agent/{agentNum}/protocol/msg/mqtt/client/get/state":{"get":{"description":"0 means stopped, 1 means running","operationId":"protocol_mqtt_client_get_state","parameters":[{"description":"Agent to show MQTT state","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"format":"int32","type":"integer"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's MQTT state","tags":["MQTT"]}},"/mimic/agent/{agentNum}/protocol/msg/mqtt/client/message/card":{"get":{"description":"0 or more","operationId":"protocol_mqtt_client_message_card","parameters":[{"description":"Agent to show MQTT message state","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"format":"int32","type":"integer"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's current messages' cardinality","tags":["MQTT"]}},"/mimic/agent/{agentNum}/protocol/msg/mqtt/client/message/get/{msgNum}/{attr}":{"get":{"description":"Attribute can be topic, interval, count, sent , pre, post, properties(list of PUBLISH properties), properties.i (i-th PUBLISH property), properties.PROP-NAME (PUBLISH property with name PROP-NAME)","operationId":"protocol_mqtt_client_message_get","parameters":[{"description":"Agent to show MQTT state","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Message Number","in":"path","name":"msgNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Attribute","in":"path","name":"attr","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Show the agent's message attributes","tags":["MQTT"]}},"/mimic/agent/{agentNum}/protocol/msg/mqtt/client/message/set/{msgNum}/{attr}/{value}":{"put":{"description":"Attribute can not be sent or properties . Use set/{msgNum}/count/{value} together with get/{msgNum}/count to throttle the outgoing MQTT message to the broker.","operationId":"protocol_mqtt_client_message_set","parameters":[{"description":"Agent to show MQTT state","in":"path","name":"agentNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Message Number","in":"path","name":"msgNum","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"Attribute","in":"path","name":"attr","required":true,"schema":{"type":"string"}},{"description":"Value","in":"path","name":"value","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"successful operation"},"400":{"description":"Invalid agent number value"}},"summary":"Set the agent's message attributes","tags":["MQTT"]}},"/mimic/agent/{agentNum}/protocol/msg/mqtt/client/resubscribe/{