Inspecting FortiOS shared-memory table counts
Description
The command 'diagnose sys shmfile dump' reads object-table information from FortiOS shared memory. It is possible to use it to get raw counts for one object table, across the whole FortiGate or inside a single VDOM.
For routine checks of how close a table is to its limit, 'print tablesize' and 'diagnose sys vdom-property' are the better tools. The sections below show how the three commands relate and when to use each.
Scope
FortiGate, FortiOS version 7.6.
Solution
Use 'print tablesize' and 'diagnose sys vdom-property' for routine monitoring. Use 'diagnose sys shmfile dump' when it is necessary to dig into one table or one VDOM.
Command | Scope | What it reports |
|---|---|---|
print tablesize | Whole FortiGate | Four values per object table: maximum per parent entry, maximum per VDOM, global limit, and current usage (the usage column was added in FortiOS version 7.6.0) |
diagnose sys vdom-property | Per VDOM | Current, Guaranteed, Maximum for each per-VDOM resource, such as addresses, address groups, policies, services, schedules, users, sessions and VPN tunnels |
diagnose sys shmfile dump | One object table, FortiGate or per-VDOM | Raw table counts from shared memory, without limits |
Syntax.
The FortiOS version 7.6.8 CLI reference documents these 'diagnose sys shmfile dump' subcommands:
diagnose sys shmfile dump table-count
diagnose sys shmfile dump table-count total <path.name>
diagnose sys shmfile dump table-count vdom <vdom-name> <path.name>
diagnose sys shmfile dump vdom <vdom-name>
diagnose sys shmfile dump oid-app <path.name>
diagnose sys shmfile dump oid-slab <path.object>
diagnose sys shmfile dump objid <key-size>
diagnose sys shmfile dump slab-file [file]Subcommand | Parameters | Description in the CLI reference |
table-count | None | Table count information |
table-count total | <path.name>: object path, for example system.interface | Total table count information |
table-count vdom | <vdom-name>, then <path.name> | VDOM table count information |
vdom | <vdom-name> | VDOM information |
oid-app | <path.name> | oid-app information |
oid-slab | <path.object> | oid-slab information |
objid | <key-size> | No specific description |
slab-file | [file]: optional file name | Slab file information |
The VDOM form of table-count takes the VDOM name first, then the object path, whereas the total form takes only the path.
Object paths use the same names as the 'print tablesize' output, for example 'firewall.address', 'firewall.addrgrp', or 'firewall.policy'.
Behavior on FortiOS version 7.6.8
Run without arguments, table-count returned no output on the test unit:
FortiGate # diagnose sys shmfile dump table-count
FortiGate #
The command reports counts only, not limits. For the per-VDOM and global maximums, cross-check with columns 2 and 3 of 'print tablesize'.
Monitor object usage before a table fills up.
If the goal is to catch a table before it reaches its limit, compare usage with limits using these two commands:
print tablesize
diagnose sys vdom-property
Command 'print tablesize' prints four values per object table: the maximum for a child table in its parent entry, the maximum per VDOM, the global limit, and the current object usage.
Command 'diagnose sys vdom-property' prints one block per VDOM, headed 'Resource for vdom <name>: Current, Guaranteed, Maximum'.
Compare each VDOM's 'Current' value with the per-VDOM limit in column 2 of print tablesize.
Compare the 'Current' value in the "Resource over all vdoms" block with the global limit in column 3 of 'print tablesize'.
A 'Maximum' of 0 means no per-VDOM override is configured, so the VDOM is bounded only by the global limit. A 'Guaranteed' of 0 means nothing is reserved for that VDOM.
