Skip to content

System

System

Bases: Base

Gets system-related information from the router.

Attributes:

Name Type Description
identity str

Name of the router (format: 'HS-A (192.168.88.1) on RB912UAG-5HPnD (mipsbe)').
routerboard dict

If the router is a RouterBoard, returns a dictionary with board information.
license dict

A dictionary with router license information.
note str

Notes of about the router.
resources dict

A dictionary with router hardware information.
Source code in netmikro/modules/system.py 
 17
 18
 19
 20
 21
 22
 23
 24
 25
 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
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
class System(Base):
    """Gets system-related information from the router.

    Attributes:
        identity (str): Name of the router (format: 'HS-A (192.168.88.1) on RB912UAG-5HPnD (mipsbe)').
        routerboard (dict): If the router is a RouterBoard, returns a dictionary with board information.
        license (dict): A dictionary with router license information.
        note (str): Notes of about the router.
        resources (dict): A dictionary with router hardware information.
    """

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

        self.identity: str = self._get('/system identity get name')

        if self.is_routerboard():
            # ROUTERBOARD
            prefix = '/system routerboard get'
            self.routerboard = IfRouterboard(
                model=self._get(f'{prefix} model'),
                revision=self._get(f'{prefix} revision'),
                serial_number=self._get(f'{prefix} serial-number'),
                firmware_type=self._get(f'{prefix} firmware-type'),
                factory_firmware=self._get(f'{prefix} factory-firmware'),
                current_firmware=self._get(f'{prefix} current-firmware'),
                upgrade_firmware=self._get(f'{prefix} upgrade-firmware'),
            )

            # LICENSE
            prefix = '/system license get'
            self.license = License(
                software_id=self._get(f'{prefix} software-id'),
                level=self._get_number(f'{prefix} nlevel'),
                features=self._get(f'{prefix} features'),
            )

        # NOTE
        self.note = self._get('/system note get note')

        # RESOURCES
        prefix = '/system resource get'
        self.resources = Resources(
            cpu=self._get('/system resource get cpu'),
            cpu_frequency=self._get_number(
                '/system resource get cpu-frequency'
            ),
            memory=self._get_number('/system resource get total-memory'),
            storage=self._get_number('/system resource get total-hdd-space'),
            architecture=self._get('/system resource get architecture-name'),
            board_name=self._get('/system resource get board-name'),
            version=self._get('/system resource get version'),
        )

    def __str__(self) -> str:
        return f'{self.identity} ({self._host}) on {self.resources.board_name} ({self.resources.architecture})'

    def clock_time_get(self) -> time:
        """Returns the router's system time.

        Returns:
            time: Time with time zone, an instance of the `time` class.

        Examples:
            >>> router.clock_time_get()
            datetime.time(5, 41, 24)
            >>> router.clock_time_get().isoformat()
            '15:30:00'
        """
        clock_time = self._get('/system clock get time').split(':')
        time_list = [int(i) for i in clock_time]
        return time(
            hour=time_list[0], minute=time_list[1], second=time_list[2]
        )

    def clock_date_get(self) -> date:
        """Returns the router's system date.

        Returns:
            date: An instance of the `date` class.

        Examples:
            >>> router.clock_date_get()
            datetime.date(2020, 12, 31)
            >>> router.clock_date_get().isoformat()
            '2020-12-31'
        """
        clock_date = self._get('/system clock get date').split('-')
        return date(*[int(i) for i in clock_date])

    def clock_time_zone_get(self) -> str:
        """Returns the router's time zone.

        Returns:
            str: Time zone in the format Continent/City.

        Examples:
            >>> router.clock_time_zone_get()
            'America/Cuiaba'
        """
        return self._get('/system clock get time-zone-name')

    def clock_gmt_offset_get(self) -> str:
        """Returns the router's GMT offset.

        Returns:
            str: GMT offset in the format +/-HH:MM.

        Examples:
            >>> router.clock_gmt_offset_get()
            '-04:00'
        """
        return self._get('/system clock get gmt-offset as-string')

    def clock_dst_active_get(self) -> bool:
        """Returns True if DST is enabled, if not enabled, returns False.

        Returns:
            bool: True if DST is enabled, if not enabled, returns False.

        Examples:
            >>> router.clock_dst_active_get()
            True
        """
        return self._get_bool('/system clock get dst-active')

    def clock_time_zone_autodetect_get(self) -> bool:
        """Returns True if time-zone-autodetect is enabled, if not enabled, it returns False.

        Returns:
            bool: True if time-zone-autodetect is enabled, if not enabled, returns False.

        Examples:
            >>> router.clock_time_zone_autodetect_get()
            True
        """
        return self._get_bool('/system clock get time-zone-autodetect')

    def health_voltage(self) -> float:
        """Returns the current voltage at the router.

        Returns:
            float: Voltage in Volts.

        Examples:
            >>> router.health_voltage()
            24.0
        """
        return self._get_float('/system health get number=0 value')

    def health_temperature(self) -> float:
        """Returns the current temperature at the router.

        Returns:
            float: Temperature in Celsius.

        Examples:
            >>> router.health_temperature()
            40.0
        """
        return self._get_float('/system health get number=1 value')

    def history_system_get(self) -> str:
        """Returns the history of changes made to the router's system settings.

        Returns:
            str: History of changes made to the router's system settings

        Examples:
            >>> router.history_system_get()
            Flags: U - UNDOABLE
            Columns: ACTION, BY, POLICY
              ACTION                        BY    POLICY
            U ntp settings changed          hick  write
            U changed system note settings  hick  write
            U changed system note settings  hick  write
            U ip service changed            hick  write
        """
        return self._cmd('/system history print')

    def identity_set(self, new_identity: str):
        """Sets the router's identity.

        Args:
            new_identity (str): New identity to be set.

        Examples:
            >>> router.identity_set('new_identity')
        """
        new_identity.strip()
        self._cmd(f'/system identity set name={new_identity}')
        self.identity = new_identity

    def note_set(self, note: str, show_at_login: bool = False):
        """Sets the router's note.

        Args:
            note (str): New note to be set.
            show_at_login (bool): Tells whether the user should see the note when logging in.

        Examples:
            >>> router.note_set('new_note', True)
        """
        show_at_login_command = 'yes' if show_at_login else 'no'
        self._cmd(
            f'/system note set note="{note}" show-at-login={show_at_login_command}'
        )

    def ntp_client_get(
        self,
    ) -> NTPClient:
        """Returns the NTP client configuration.

        Returns:
            dict: Dictionary with the NTP client configuration.

        Examples:
            >>> router.ntp_client_get()
            {
                'enabled': True,
                'freq-diff': '3.082 PPM',
                'mode': 'unicast',
                'servers': ['200.160.7.186', '201.49.148.135'],
                'status': 'synchronized',
                'synced-server': '200.160.7.186',
                'synced-stratum': 1,
                'system-offset': -0.915,
                'vrf': 'main'
            }
        """
        prefix = '/system ntp client get'
        npt_client = NTPClient(
            enabled=self._get_bool(f'{prefix} enabled'),
            mode=self._get(f'{prefix} mode'),
            servers=self._get_list_ips(f'{prefix} servers'),
            vrf=self._get(f'{prefix} vrf'),
            freq_diff=self._get_number(f'{prefix} freq-drift'),
            status=self._get(f'{prefix} status'),
            synced_stratum=self._get_number(f'{prefix} synced-stratum'),
            system_offset=self._get_number(f'{prefix} system-offset'),
        )

        return npt_client

    def ntp_client_set(
        self,
        servers: list[IPv4Address],
        enabled: bool = True,
        mode: str = 'unicast',
        vrf: str = 'main',
    ):
        """Sets the NTP client configuration.

        Args:
            servers (list): List of NTP servers.
            enabled (bool): Specifies whether the NTP client should be enabled.
            mode (str): Specifies the NTP client mode.
            vrf (str): Specifies the VRF to be used by the NTP client.

        Examples:
            >>> router.ntp_client_set(
                '200.160.7.186, 201.49.148.135',
                True,
                'unicast',
                'main'
            )
        """
        servers_command: str = ','.join([
            str(IPv4Address(server)) for server in servers
        ])

        enabled_command = 'yes' if enabled else 'no'
        mode = mode.lower().strip()
        if mode not in {'unicast', 'broadcast', 'multicast', 'manycast'}:
            raise InvalidNtpMode(f'Invalid mode: {mode}')
        vrf = vrf.lower().strip()

        self._cmd(
            f'/system ntp client set '
            f'enabled={enabled_command} mode={mode} servers={servers_command} vrf={vrf}'
        )

    def ntp_server_get(self) -> NTPServer:
        """Returns the NTP server configuration.

        Returns:
            dict: Dictionary with the NTP server configuration.

        Examples:
            >>> router.ntp_server_get()
            {
                'broadcast': False,
                'broadcast-address': None,
                'enabled': False,
                'manycast': False,
                'multicast': False,
                'vrf': 'main'
            }
        """
        prefix = '/system ntp server get'

        _broadcast_address = (
            IPv4Address(_broadcast_address)
            if (_broadcast_address := self._get(f'{prefix} broadcast-address'))
            else None
        )

        ntp_server = NTPServer(
            enabled=boolean(self._get(f'{prefix} enabled')),
            broadcast=boolean(self._get(f'{prefix} broadcast')),
            multicast=boolean(self._get(f'{prefix} multicast')),
            manycast=boolean(self._get(f'{prefix} manycast')),
            broadcast_address=_broadcast_address,
            vrf=self._get(f'{prefix} vrf'),
        )

        return ntp_server

    def is_routerboard(self) -> bool:
        """Returns True if the router is a RouterBoard, if not, returns False.

        Returns:
            bool: True if the router is a RouterBoard, if not, returns False.
        """
        return self._get_bool('/system routerboard get routerboard')

clock_date_get()

Returns the router's system date.

Returns:

Name Type Description
date date

An instance of the date class.

Examples:

>>> router.clock_date_get()
datetime.date(2020, 12, 31)
>>> router.clock_date_get().isoformat()
'2020-12-31'
Source code in netmikro/modules/system.py 
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def clock_date_get(self) -> date:
    """Returns the router's system date.

    Returns:
        date: An instance of the `date` class.

    Examples:
        >>> router.clock_date_get()
        datetime.date(2020, 12, 31)
        >>> router.clock_date_get().isoformat()
        '2020-12-31'
    """
    clock_date = self._get('/system clock get date').split('-')
    return date(*[int(i) for i in clock_date])

clock_dst_active_get()

Returns True if DST is enabled, if not enabled, returns False.

Returns:

Name Type Description
bool bool

True if DST is enabled, if not enabled, returns False.

Examples:

>>> router.clock_dst_active_get()
True
Source code in netmikro/modules/system.py 
131
132
133
134
135
136
137
138
139
140
141
def clock_dst_active_get(self) -> bool:
    """Returns True if DST is enabled, if not enabled, returns False.

    Returns:
        bool: True if DST is enabled, if not enabled, returns False.

    Examples:
        >>> router.clock_dst_active_get()
        True
    """
    return self._get_bool('/system clock get dst-active')

clock_gmt_offset_get()

Returns the router's GMT offset.

Returns:

Name Type Description
str str

GMT offset in the format +/-HH:MM.

Examples:

>>> router.clock_gmt_offset_get()
'-04:00'
Source code in netmikro/modules/system.py 
119
120
121
122
123
124
125
126
127
128
129
def clock_gmt_offset_get(self) -> str:
    """Returns the router's GMT offset.

    Returns:
        str: GMT offset in the format +/-HH:MM.

    Examples:
        >>> router.clock_gmt_offset_get()
        '-04:00'
    """
    return self._get('/system clock get gmt-offset as-string')

clock_time_get()

Returns the router's system time.

Returns:

Name Type Description
time time

Time with time zone, an instance of the time class.

Examples:

>>> router.clock_time_get()
datetime.time(5, 41, 24)
>>> router.clock_time_get().isoformat()
'15:30:00'
Source code in netmikro/modules/system.py 
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def clock_time_get(self) -> time:
    """Returns the router's system time.

    Returns:
        time: Time with time zone, an instance of the `time` class.

    Examples:
        >>> router.clock_time_get()
        datetime.time(5, 41, 24)
        >>> router.clock_time_get().isoformat()
        '15:30:00'
    """
    clock_time = self._get('/system clock get time').split(':')
    time_list = [int(i) for i in clock_time]
    return time(
        hour=time_list[0], minute=time_list[1], second=time_list[2]
    )

clock_time_zone_autodetect_get()

Returns True if time-zone-autodetect is enabled, if not enabled, it returns False.

Returns:

Name Type Description
bool bool

True if time-zone-autodetect is enabled, if not enabled, returns False.

Examples:

>>> router.clock_time_zone_autodetect_get()
True
Source code in netmikro/modules/system.py 
143
144
145
146
147
148
149
150
151
152
153
def clock_time_zone_autodetect_get(self) -> bool:
    """Returns True if time-zone-autodetect is enabled, if not enabled, it returns False.

    Returns:
        bool: True if time-zone-autodetect is enabled, if not enabled, returns False.

    Examples:
        >>> router.clock_time_zone_autodetect_get()
        True
    """
    return self._get_bool('/system clock get time-zone-autodetect')

clock_time_zone_get()

Returns the router's time zone.

Returns:

Name Type Description
str str

Time zone in the format Continent/City.

Examples:

>>> router.clock_time_zone_get()
'America/Cuiaba'
Source code in netmikro/modules/system.py 
107
108
109
110
111
112
113
114
115
116
117
def clock_time_zone_get(self) -> str:
    """Returns the router's time zone.

    Returns:
        str: Time zone in the format Continent/City.

    Examples:
        >>> router.clock_time_zone_get()
        'America/Cuiaba'
    """
    return self._get('/system clock get time-zone-name')

health_temperature()

Returns the current temperature at the router.

Returns:

Name Type Description
float float

Temperature in Celsius.

Examples:

>>> router.health_temperature()
40.0
Source code in netmikro/modules/system.py 
167
168
169
170
171
172
173
174
175
176
177
def health_temperature(self) -> float:
    """Returns the current temperature at the router.

    Returns:
        float: Temperature in Celsius.

    Examples:
        >>> router.health_temperature()
        40.0
    """
    return self._get_float('/system health get number=1 value')

health_voltage()

Returns the current voltage at the router.

Returns:

Name Type Description
float float

Voltage in Volts.

Examples:

>>> router.health_voltage()
24.0
Source code in netmikro/modules/system.py 
155
156
157
158
159
160
161
162
163
164
165
def health_voltage(self) -> float:
    """Returns the current voltage at the router.

    Returns:
        float: Voltage in Volts.

    Examples:
        >>> router.health_voltage()
        24.0
    """
    return self._get_float('/system health get number=0 value')

history_system_get()

Returns the history of changes made to the router's system settings.

Returns:

Name Type Description
str str

History of changes made to the router's system settings

Examples:

>>> router.history_system_get()
Flags: U - UNDOABLE
Columns: ACTION, BY, POLICY
  ACTION                        BY    POLICY
U ntp settings changed          hick  write
U changed system note settings  hick  write
U changed system note settings  hick  write
U ip service changed            hick  write
Source code in netmikro/modules/system.py 
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
def history_system_get(self) -> str:
    """Returns the history of changes made to the router's system settings.

    Returns:
        str: History of changes made to the router's system settings

    Examples:
        >>> router.history_system_get()
        Flags: U - UNDOABLE
        Columns: ACTION, BY, POLICY
          ACTION                        BY    POLICY
        U ntp settings changed          hick  write
        U changed system note settings  hick  write
        U changed system note settings  hick  write
        U ip service changed            hick  write
    """
    return self._cmd('/system history print')

identity_set(new_identity)

Sets the router's identity.

Parameters:

Name Type Description Default
new_identity str

New identity to be set.

 required

Examples:

>>> router.identity_set('new_identity')
Source code in netmikro/modules/system.py 
197
198
199
200
201
202
203
204
205
206
207
208
def identity_set(self, new_identity: str):
    """Sets the router's identity.

    Args:
        new_identity (str): New identity to be set.

    Examples:
        >>> router.identity_set('new_identity')
    """
    new_identity.strip()
    self._cmd(f'/system identity set name={new_identity}')
    self.identity = new_identity

is_routerboard()

Returns True if the router is a RouterBoard, if not, returns False.

Returns:

Name Type Description
bool bool

True if the router is a RouterBoard, if not, returns False.
Source code in netmikro/modules/system.py 
335
336
337
338
339
340
341
def is_routerboard(self) -> bool:
    """Returns True if the router is a RouterBoard, if not, returns False.

    Returns:
        bool: True if the router is a RouterBoard, if not, returns False.
    """
    return self._get_bool('/system routerboard get routerboard')

note_set(note, show_at_login=False)

Sets the router's note.

Parameters:

Name Type Description Default
note str

New note to be set.

 required
show_at_login bool

Tells whether the user should see the note when logging in.

 False

Examples:

>>> router.note_set('new_note', True)
Source code in netmikro/modules/system.py 
210
211
212
213
214
215
216
217
218
219
220
221
222
223
def note_set(self, note: str, show_at_login: bool = False):
    """Sets the router's note.

    Args:
        note (str): New note to be set.
        show_at_login (bool): Tells whether the user should see the note when logging in.

    Examples:
        >>> router.note_set('new_note', True)
    """
    show_at_login_command = 'yes' if show_at_login else 'no'
    self._cmd(
        f'/system note set note="{note}" show-at-login={show_at_login_command}'
    )

ntp_client_get()

Returns the NTP client configuration.

Returns:

Name Type Description
dict NTPClient

Dictionary with the NTP client configuration.

Examples:

>>> router.ntp_client_get()
{
    'enabled': True,
    'freq-diff': '3.082 PPM',
    'mode': 'unicast',
    'servers': ['200.160.7.186', '201.49.148.135'],
    'status': 'synchronized',
    'synced-server': '200.160.7.186',
    'synced-stratum': 1,
    'system-offset': -0.915,
    'vrf': 'main'
}
Source code in netmikro/modules/system.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
def ntp_client_get(
    self,
) -> NTPClient:
    """Returns the NTP client configuration.

    Returns:
        dict: Dictionary with the NTP client configuration.

    Examples:
        >>> router.ntp_client_get()
        {
            'enabled': True,
            'freq-diff': '3.082 PPM',
            'mode': 'unicast',
            'servers': ['200.160.7.186', '201.49.148.135'],
            'status': 'synchronized',
            'synced-server': '200.160.7.186',
            'synced-stratum': 1,
            'system-offset': -0.915,
            'vrf': 'main'
        }
    """
    prefix = '/system ntp client get'
    npt_client = NTPClient(
        enabled=self._get_bool(f'{prefix} enabled'),
        mode=self._get(f'{prefix} mode'),
        servers=self._get_list_ips(f'{prefix} servers'),
        vrf=self._get(f'{prefix} vrf'),
        freq_diff=self._get_number(f'{prefix} freq-drift'),
        status=self._get(f'{prefix} status'),
        synced_stratum=self._get_number(f'{prefix} synced-stratum'),
        system_offset=self._get_number(f'{prefix} system-offset'),
    )

    return npt_client

ntp_client_set(servers, enabled=True, mode='unicast', vrf='main')

Sets the NTP client configuration.

Parameters:

Name Type Description Default
servers list

List of NTP servers.

 required
enabled bool

Specifies whether the NTP client should be enabled.

 True
mode str

Specifies the NTP client mode.

 'unicast'
vrf str

Specifies the VRF to be used by the NTP client.

 'main'

Examples:

>>> router.ntp_client_set(
    '200.160.7.186, 201.49.148.135',
    True,
    'unicast',
    'main'
)
Source code in netmikro/modules/system.py 
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
def ntp_client_set(
    self,
    servers: list[IPv4Address],
    enabled: bool = True,
    mode: str = 'unicast',
    vrf: str = 'main',
):
    """Sets the NTP client configuration.

    Args:
        servers (list): List of NTP servers.
        enabled (bool): Specifies whether the NTP client should be enabled.
        mode (str): Specifies the NTP client mode.
        vrf (str): Specifies the VRF to be used by the NTP client.

    Examples:
        >>> router.ntp_client_set(
            '200.160.7.186, 201.49.148.135',
            True,
            'unicast',
            'main'
        )
    """
    servers_command: str = ','.join([
        str(IPv4Address(server)) for server in servers
    ])

    enabled_command = 'yes' if enabled else 'no'
    mode = mode.lower().strip()
    if mode not in {'unicast', 'broadcast', 'multicast', 'manycast'}:
        raise InvalidNtpMode(f'Invalid mode: {mode}')
    vrf = vrf.lower().strip()

    self._cmd(
        f'/system ntp client set '
        f'enabled={enabled_command} mode={mode} servers={servers_command} vrf={vrf}'
    )

ntp_server_get()

Returns the NTP server configuration.

Returns:

Name Type Description
dict NTPServer

Dictionary with the NTP server configuration.

Examples:

>>> router.ntp_server_get()
{
    'broadcast': False,
    'broadcast-address': None,
    'enabled': False,
    'manycast': False,
    'multicast': False,
    'vrf': 'main'
}
Source code in netmikro/modules/system.py 
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
def ntp_server_get(self) -> NTPServer:
    """Returns the NTP server configuration.

    Returns:
        dict: Dictionary with the NTP server configuration.

    Examples:
        >>> router.ntp_server_get()
        {
            'broadcast': False,
            'broadcast-address': None,
            'enabled': False,
            'manycast': False,
            'multicast': False,
            'vrf': 'main'
        }
    """
    prefix = '/system ntp server get'

    _broadcast_address = (
        IPv4Address(_broadcast_address)
        if (_broadcast_address := self._get(f'{prefix} broadcast-address'))
        else None
    )

    ntp_server = NTPServer(
        enabled=boolean(self._get(f'{prefix} enabled')),
        broadcast=boolean(self._get(f'{prefix} broadcast')),
        multicast=boolean(self._get(f'{prefix} multicast')),
        manycast=boolean(self._get(f'{prefix} manycast')),
        broadcast_address=_broadcast_address,
        vrf=self._get(f'{prefix} vrf'),
    )

    return ntp_server