Fasttrack schedule 10.0.0.1 serial how to#
Fasttrack schedule 10.0.0.1 serial manual#
Fasttrack schedule 10.0.0.1 serial full#
Fasttrack schedule 10.0.0.1 serial software#
Fasttrack schedule 10.0.0.1 serial password#

optional argument: =tag= tag of command to cancel, without it cancels all running commands.If you do not include 'tag' parameter or it's value is empty, then all responses for this command will not have 'tag' parameter.If you include 'tag' parameter with non-empty value in command sentence, then 'tag' parameter with exactly the same value will be included in all responses generated by this command.If API client is doing this and needs to differentiate command responses, it can use 'tag' API parameter in command sentences. It is possible to run several commands simultaneously, without waiting for previous one to complete.in case of error, reply contains =message= error message.

Fasttrack schedule 10.0.0.1 serial password#

Now client sends username and password in first message.In case of successful login client can start to issue commands.In case of error, reply contains =ret= error message.Client sends second /login command, with =name= username and =response= response.Reply contains =ret= challenge argument.Note: that each command and response ends with an empty word. Order of query words in the sentence is important. Can contain none or several query words.There is no particular order at what attribute words has to be sent in the sentence, order is not important for attribute words Can contain none or several attribute words.Should contain zero length word to terminate the sentence.First word should contain command word.Order of attribute words should not be relied on.There is a limit on number and size of sentences client can send before it has logged in.Sentence is processed after receiving zero length word.If API connection is closed, RouterOS sends !fatal with reason as reply and then closes the connection ĪPI sentence is main object of communication using API.Errors and exceptional conditions begin with !trap.Last reply for every sentence is reply that has first word !done.Each sentence sent generates at least one reply (if connection does not get terminated).

Fasttrack schedule 10.0.0.1 serial full#

It is only sent in response to full sentence send by the client. Warning: Order of query words is significant It is possible that attribute does not have a value There are commands that are specific to API Įach command word has its own list of attribute words depending on content.Ītribute word structure consists of 5 parts in this order: Names of commands closely follow CLI, with spaces replaced with '/'. Name of command word should begin with '/'.

query word and reply word Command wordįirst word in sentence has to be command followed by attribute words and zero length word or terminating word. Word content can be separated in 5 parts: command word, attribute word, API attribute word. In general words can be described like this >.

Fasttrack schedule 10.0.0.1 serial how to#

After receiving unknown control byte API client cannot proceed, because it cannot know how to interpret following bytes

If first byte of word is >= 0xF8, then it is a reserved control byte.

Bytes of len are sent most significant first (network order).

Scheme allows encoding of length up to 0x7FFFFFFFFF, only four byte length is supported.

End of sentence is terminated by zero length word

Each word is encoded as length, followed by that many bytes of content.

Length of the word is encoded as follows: Length of the word should be given as count of bytes that are going to be sent. Each word has to be encoded in certain way - length of the word followed by word content. When router receives full sentence (command word, no or more attribute words and zero length word) it is evaluated and executed, then reply is formed and returned. Each sentence sent to router using API should contain command as a first word followed by words in no particular order, end of sentence is marked by zero length word.

Communication happen by sending sentences to the router and receiving replies to sent sentences. Word is part of sentence encoded in certain way - encoded length and data. Sentence is sequence of words terminated by zero length word. Corresponding service name is api ProtocolĬommunication with router is done by sending sentences to the router and receiving one or more sentences in return.

Fasttrack schedule 10.0.0.1 serial manual#

More on service management see in corresponding manual section. To use API RouterOS version 3.x or newer is required.īy default API uses port # 8728 and service is enabled. It can be used to create translated or custom configuration tools to aid ease of use running and managing routers with RouterOS.

API closely follows syntax from command line interface (CLI).

Fasttrack schedule 10.0.0.1 serial software#

Application Programmable Interface (API) allows users to create custom software solutions to communicate with RouterOS to gather information, adjust configuration and manage router.