routeros

README

routeros

Mikrotik RouterOS REST API client

Status

dev time-to-time

Details

Start dev with Mikrotik RouterOS v7.18.2

Use Mikrotik docs REST API

#	endpoint	description	impl
ip/firewall	/ip/firewall/address-list	add/list address list	✅
tools	/tool/ping	send echo requests	✅

Documentation

Index

• type Client
  • func NewClient(cfg Config) (*Client, error)
• type Config
  • func NewClientConfigFromEnv(envPrefix string) (*Config, error)
• type IPFirewallAddressListService
  • func (ipfwls *IPFirewallAddressListService) Add(ctx context.Context, item types.FirewallAddressListNewItem) (*types.FirewallAddressListItem, error)
  • func (ipfwls *IPFirewallAddressListService) Find(ctx context.Context, list string, ips ...string) (types.FirewallAddressList, error)
• type ToolService
  • func (ts *ToolService) Ping(ctx context.Context, req types.EchoRequest) (types.EchoResponse, error)

Types

type Client

type Client struct {
	IPFirewallAddressListService *IPFirewallAddressListService
	ToolService                  *ToolService
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg Config) (*Client, error)

type Config

type Config struct {
	BaseURL              string        `envconfig:"base_url" validate:"required"`
	RequestTimeout       time.Duration `envconfig:"request_timeout" default:"10s"`
	PauseBetweenRequests time.Duration `envconfig:"pause_between_requests" default:"100ms"`
	BurstRequestCount    int           `envconfig:"burst_req_count" default:"10"`
	User                 string        `envconfig:"user" default:"root"`
	Password             string        `envconfig:"password" default:"master"`
}

func NewClientConfigFromEnv

func NewClientConfigFromEnv(envPrefix string) (*Config, error)

type IPFirewallAddressListService

type IPFirewallAddressListService struct {
	// contains filtered or unexported fields
}

func (*IPFirewallAddressListService) Add

func (ipfwls *IPFirewallAddressListService) Add(ctx context.Context, item types.FirewallAddressListNewItem) (*types.FirewallAddressListItem, error)

func (*IPFirewallAddressListService) Find

func (ipfwls *IPFirewallAddressListService) Find(ctx context.Context, list string, ips ...string) (types.FirewallAddressList, error)

type ToolService

type ToolService struct {
	// contains filtered or unexported fields
}

func (*ToolService) Ping

func (ts *ToolService) Ping(ctx context.Context, req types.EchoRequest) (types.EchoResponse, error)