Skip to content

IP

Ip

Bases: Base

Class that generates the connection with a MikroTik router.

Attributes:

Name Type Description
service dict

Dictionary with the services available on the router.
Source code in netmikro/modules/ip.py 
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class Ip(Base):
    """Class that generates the connection with a MikroTik router.

    Attributes:
        service (dict): Dictionary with the services available on the router.
    """

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

        _service_names = [
            'api',
            'api-ssl',
            'ftp',
            'ssh',
            'telnet',
            'winbox',
            'www',
            'www-ssl',
        ]

        self.service = {
            service: IpService(
                port=int(self._get(f'/ip service get {service} port')),
                disabled=self._get_bool(f'/ip service get {service} disabled'),
                available_from=self._get(f'/ip service get {service} address'),
            )
            for service in _service_names
        }

    def ip_port_set(self, service_name: str, port: int) -> None:
        """Set the API port number.

        Args:
            service_name: The service to be changed.
            port: The new port number.

        Examples:
            >>> router.ip_port_set('www', 8080)
        """
        self._cmd(
            f'/ip service set {service_name} port={Port(port=port).port}'
        )
        self.service[service_name].port = port

ip_port_set(service_name, port)

Set the API port number.

Parameters:

Name Type Description Default
service_name str

The service to be changed.

 required
port int

The new port number.

 required

Examples:

>>> router.ip_port_set('www', 8080)
Source code in netmikro/modules/ip.py 
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def ip_port_set(self, service_name: str, port: int) -> None:
    """Set the API port number.

    Args:
        service_name: The service to be changed.
        port: The new port number.

    Examples:
        >>> router.ip_port_set('www', 8080)
    """
    self._cmd(
        f'/ip service set {service_name} port={Port(port=port).port}'
    )
    self.service[service_name].port = port

IpService

Class for representing ip service on a MikroTik router.

Attributes:

Name Type Description
port int

Port number of the service.
disabled bool

Whether the service is disabled or not.
available_from str

IP address from which the service is available.

Examples:

>>> service = IpService(8728, False, '192.168.88.1')
Source code in netmikro/modules/ip.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
@dataclass
class IpService:
    """Class for representing ip service on a MikroTik router.

    Attributes:
        port (int): Port number of the service.
        disabled (bool): Whether the service is disabled or not.
        available_from (str): IP address from which the service is available.

    Examples:
        >>> service = IpService(8728, False, '192.168.88.1')
    """

    port: int
    disabled: bool
    available_from: str