su - mysite        # 方式一：su 切换站点用户（实测可用）
omd su mysite      # 方式二：omd 自带的站点 shell（交互式使用）

Manage multiple monitoring sites comfortably with OMD. The Open Monitoring Distribution.
Usage (called as root):

 omd help                               Show general help
 omd setversion VERSION                 Sets the default version of OMD which will be used by new sites
 omd version    [SITE]                  Show version of OMD
 omd versions                           List installed OMD versions
 omd sites                              Show list of sites
 omd create     SITE                    Create a new site (-u UID, -g GID)
 omd init       SITE                    Populate site directory with default files and enable the site
 omd rm         SITE                    Remove a site (and its data)
 omd disable    SITE                    Disable a site (stop it, unmount tmpfs, remove Apache hook)
 omd enable     SITE                    Enable a site (reenable a formerly disabled site)
 omd update-apache-config SITE                    Update the system apache config of a site (and reload apache)
 omd mv         SITE NEWNAME            Rename a site
 omd cp         SITE NEWNAME            Make a copy of a site
 omd update     SITE                    Update site to other version of OMD
 omd start      [SITE] [SERVICE]        Start services of one or all sites. This command reports one of the following exit codes.
 * 0: All services started successfully.
 * 1: The command failed to start any service.
 * 2: When targeting a single site, this indicates that one or more services failed to start. When targeting multiple sites, this indicates that an unspecific error occurred.
 omd stop       [SITE] [SERVICE]        Stop services of site(s) and terminate processes owned by the site user
 omd restart    [SITE] [SERVICE]        Restart services of site(s)
 omd reload     [SITE] [SERVICE]        Reload services of site(s)
 omd status     [SITE] [SERVICE]        Show status of services of site(s)
 omd config     SITE ...                Show and set site configuration parameters.

Usage:
 omd config [site]                      interactive mode
 omd config [site] show                 show configuration settings
 omd config [site] set VAR VAL          set specific setting VAR to VAL
 omd diff       SITE ([RELBASE])        Shows differences compared to the original version files
 omd su         SITE                    Run a shell as a site-user
 omd umount     [SITE]                  Umount ramdisk volumes of site(s)
 omd backup     SITE [SITE] [-|ARCHIVE_PATH] Create a backup tarball of a site, writing it to a file or stdout
 omd restore    [SITE] handler=[-|ARCHIVE_PATH] Restores the backup of a site to an existing site or creates a new site
 omd cleanup                            Uninstall all Check_MK versions that are not used by any site.

General Options:
 -V <version>                    set specific version, useful in combination with update/create
 -f, --force                     use force mode, useful in combination with update
 omd COMMAND -h, --help          show available options of COMMAND

omd version
omd versions
omd sites

$ omd version
OMD - Open Monitoring Distribution Version 2.4.0p37.cre
$ omd versions
2.4.0p37.cre (default)
$ omd sites
mysite           2.4.0p37.cre     default version

omd create --admin-password q1w2e3r4 mysite

Adding /opt/omd/sites/mysite/tmp to /etc/fstab.
Creating temporary filesystem /omd/sites/mysite/tmp...Generating configuration for core (type nagios)...
Precompiling host checks...OK
Executing post-create script "01_create-sample-config.py"...OK
Executing post-create script "02_cmk-compute-api-spec"...OK
Executing post-create script "03_message-broker-certs"...OK
Updating core configuration...
Adding /opt/omd/sites/mysite/tmp to /etc/fstab.
Skipping Apache restart.
Created new site mysite with version 2.4.0p37.cre.

  The site can be started with omd start mysite.
  The default web UI is available at http://cmk-server.ubuntu.local/mysite/

  The admin user for the web applications is cmkadmin with password: q1w2e3r4
  For command line administration of the site, log in with 'omd su mysite'.
  After logging in, you can change the password for cmkadmin with 'cmk-passwd cmkadmin'.

Possible options for this command:
 -u,--uid        ARG  create site user with UID ARG
 -g,--gid        ARG  create site group with GID ARG
 --admin-password ARG  set initial password instead of generating one
 --reuse              do not create a site user, reuse existing one
 -n,--no-init         leave new site directory empty (a later omd init does this
 -A,--no-autostart      set AUTOSTART to off (useful for test sites)
 --apache-reload      Issue a reload of the system apache instead of a restart
 --no-tmpfs           set TMPFS to off
 -t,--tmpfs-size ARG  specify the maximum size of the tmpfs (defaults to 50% of RAM), examples: 500M, 20G, 60%

omd start mysite

Starting agent-receiver...OK
Starting mkeventd...OK
Starting rrdcached...OK
Starting redis...OK
Starting npcd...OK
Starting automation-helper...OK
Starting ui-job-scheduler...OK
Starting nagios...OK
Starting apache...OK
Starting crontab...OK

agent-receiver:     running
mkeventd:           running
rrdcached:          running
redis:              running
npcd:               running
automation-helper:  running
ui-job-scheduler:   running
nagios:             running
apache:             running
crontab:            running
---------------------------
Overall state:      running

omd status mysite apache

apache:             running
---------------------------
Overall state:      running

omd restart mysite

Stopping crontab...OK
Stopping redis...killing ...OK
Stopping rrdcached...OK
Starting agent-receiver...OK
Starting mkeventd...OK
Starting rrdcached...OK
Starting redis...OK
Starting nagios...OK
Starting apache...OK
Starting crontab...OK

ADMIN_MAIL:
AGENT_RECEIVER: on
AGENT_RECEIVER_PORT: 8000
APACHE_MODE: own
APACHE_TCP_ADDR: 127.0.0.1
APACHE_TCP_PORT: 5000
AUTOMATION_HELPER: on
AUTOSTART: on
CORE: nagios
LIVESTATUS_TCP: off
MKEVENTD: on
MULTISITE_COOKIE_AUTH: on
PIGGYBACK_HUB: off
PNP4NAGIOS: on
RABBITMQ_PORT: 5672
TMPFS: on

omd config mysite set LIVESTATUS_TCP on

Cannot change config variables while site is running.

omd backup mysite /tmp/mysite-backup.tar.gz
ls -lh /tmp/mysite-backup.tar.gz

-rw-r--r-- 1 root root 1.7M Oct 19 22:17 /tmp/mysite-backup.tar.gz

omd rm mysite

WAYS TO CALL:
 cmk  --automation [COMMAND...]          Internal helper to invoke Check_MK
                                         actions
 cmk  --check [HOST [IPADDRESS]]         Check all services on the given HOST
 cmk  --check-discovery HOSTNAME         Check for not yet monitored services
 cmk  --cleanup-piggyback                Cleanup outdated piggyback files
 cmk  --create-diagnostics-dump          Create diagnostics dump
 cmk  --flush [HOST1 HOST2...]           Flush all data of some or all hosts
 cmk  --inventorize-marked-hosts         Run inventory for hosts which
                                         previously had no tree data
 cmk  --list-tag [TAG1 TAG2...]          List hosts having certain tags
 cmk  --localize [COMMAND]               Do localization operations
 cmk  --notify [MODE]                    Used to send notifications from core
 cmk  --snmpget [OID [HOST1 HOST2...]]   Fetch single OID from one or multiple
                                         hosts
 cmk  --snmptranslate HOST               Do snmptranslate on walk
 cmk  --snmpwalk [HOST1 HOST2...]        Do snmpwalk on one or more hosts
 cmk  --update-dns-cache                 Update IP address lookup cache
 cmk  -D, --dump [H1 H2...]              Dump info about all or some hosts
 cmk  -d, --dump-agent HOSTNAME|ADDRESS  Show raw information from agent
 cmk  -h, --help                         Print this help
 cmk  -I, --discover [[-I] HOST1 HOST2...]Find new services
 cmk  -i, --inventory [HOST1 HOST2...]   Do a HW/SW Inventory on some or all
                                         hosts
 cmk  -L, --list-checks                  List all available Check_MK checks
 cmk  -l, --list-hosts [G1 G2...]        Print list of all hosts or members of
                                         host groups
 cmk  -m, --browse-man                   Open interactive manpage browser
 cmk  -M, --man [CHECKTYPE]              Show manpage for check CHECKTYPE
 cmk  -N, --nagios-config [HOST1 HOST2...]Output Nagios configuration
 cmk  -O, --reload [[HostA, HostB]]      Create core config + core reload
 cmk  -P, --package [COMMAND]            DEPRECATED: Do package operations
 cmk  -R, --restart [[HostA, HostB]]     Create core config + core restart
 cmk  -U, --update                       Create core config
 cmk  -V, --version                      Print the version of Check_MK

OPTIONS:
   --debug             Let most Python exceptions raise through
   --fake-dns IP       Fake IP addresses of all hosts to be IP. This prevents
                       DNS lookups.
   --profile           Enable profiling mode
   -v, --verbose       Enable verbose output (Use twice for more)

cmk -V
cmk -l
cmk -L | wc -l
cmk -L | head -5

$ cmk -V
This is Check_MK version 2.4.0p37 CRE
$ cmk -l
localhost
$ cmk -L | wc -l
2091
$ cmk -L | head -5
3par_capacity                               agent     HPE 3PAR: Capacity
3par_cpgs                                   agent     HPE 3PAR: CPGs
3par_cpgs_usage                             agent     HPE 3PAR: CPGs Usage
3par_hosts                                  agent     HPE 3PAR: Hosts
3par_ports                                  agent     HPE 3PAR: Ports

<<<check_mk>>>
Version: 2.4.0p37
AgentOS: linux
Hostname: cmk-server.ubuntu.local
AgentDirectory: /etc/check_mk
DataDirectory: /var/lib/check_mk_agent
SpoolDirectory: /var/lib/check_mk_agent/spool
PluginsDirectory: /usr/lib/check_mk_agent/plugins
LocalDirectory: /usr/lib/check_mk_agent/local
OSType: linux
OSName: Ubuntu
OSVersion: 22.04
OSPlatform: ubuntu
FailedPythonReason:
SSHClient:
<<<checkmk_agent_plugins_lnx:sep(0)>>>
pluginsdir /usr/lib/check_mk_agent/plugins
localdir /usr/lib/check_mk_agent/local
<<<nfsmounts_v2:sep(0)>>>
<<<cifsmounts>>>
<<<mounts>>>
<<<ps_lnx>>>
[time]
1792447191
[processes]

<<<omd_info:sep(59)>>>
[versions]
version;number;edition;demo
2.4.0p37.cre;2.4.0p37;cre;0
[sites]
site;used_version;autostart
mysite;2.4.0p37.cre;1

cmk -I localhost          # 静默模式：无新服务时无输出
cmk -v -I localhost       # 冗长模式：输出发现过程

Get piggybacked data
+ ANALYSE DISCOVERED HOST LABELS
SUCCESS - Found no new host labels
+ ANALYSE DISCOVERED SERVICES
+ EXECUTING DISCOVERY PLUGINS (24)
SUCCESS - Found no new services

cmk --check -n localhost

[agent] Success, [piggyback] Success (but no data found for this host), execution time 0.3 sec | execution_time=0.270 user_time=0.010 system_time=0.000 children_user_time=0.000 children_system_time=0.000 cmk_time_agent=0.270

cmk -v --check localhost

 checkmk_agent_plugins: ok
 check_mk: ok
 lnx_if: ok
[agent] Success, [piggyback] Success (but no data found for this host), execution time 0.3 sec | execution_time=0.270 user_time=0.000 system_time=0.010 children_user_time=0.000 children_system_time=0.000 cmk_time_agent=0.250

localhost
Addresses:              127.0.0.1
Tags:                   [address_family:ip-v4-only], [agent:cmk-agent], [checkmk-agent:checkmk-agent], [criticality:prod], [ip-v4:ip-v4], [networking:lan], [piggyback:auto-piggyback], [site:mysite], [snmp_ds:no-snmp], [tcp:tcp]
Host groups:            check_mk
Contact groups:         check-mk-notify, all
Agent mode:             Normal Checkmk agent, or special agent if configured
Type of agent:
  TCP: 127.0.0.1:6556
  Process piggyback data from /omd/sites/mysite/tmp/check_mk/piggyback/localhost
Services:
  checktype           item                      params        description
  ------------------- ------------------------- ------------  ----------------------
  cpu_utilization_os  None                      {}            CPU utilization
  checkmk_agent       None                      {'agent_version': ('ignore', {}), ...}  Check_MK Agent
  diskstat            SUMMARY                   {}            Disk IO SUMMARY
  lnx_if              2                         {'errors': {'both': ('perc', (0.01, 0.1))}, ...}  Interface 2
  mem_used            None                      {'levels': (150.0, 200.0)}  Memory
  mkeventd_status     mysite                    {}            OMD mysite Event Console

cmk -M cpu_utilization_os

 cpu_utilization_os       Cpu Utilization OS
 Distribution:            Official part of Checkmk
 License:                 GPLv2
 Supported Agents:        Linux

 This  check measures the  CPU utilization during the  last check cycle. Levels
 can be set on the total utilization.

 DISCOVERY
 One service is created.

cmk -v -i localhost

+ CREATE INVENTORY OR STATUS DATA TREE
+ MAY UPDATE INVENTORY TREE
SUCCESS - Found 46 inventory entries, Found 15 status entries

cmk -U        # 只编译核心配置，不重载
cmk -O        # 编译配置 + 核心重载（平滑，不中断监控）
cmk -R        # 编译配置 + 核心重启（完全重启核心进程）

$ cmk -U
Precompiling host checks...OK
Validating Nagios configuration...OK
$ cmk -O
Validating Nagios configuration...OK
Reloading monitoring core...OK

dpkg -i /omd/sites/mysite/share/check_mk/agents/check-mk-agent_2.4.0p37-1_all.deb

Deployed xinetd
Starting xinetd
 * Starting internet superserver xinetd
   ...done.

dpkg -l check-mk-agent | tail -1
ss -ltn | grep 6556

ii  check-mk-agent 2.4.0p37-1   all          Checkmk Agent for Linux
LISTEN 0      64                 *:6556             *:*

<<<check_mk>>>
Version: 2.4.0p37
AgentOS: linux

usage: mkp [-h] [--debug] [--verbose]
           {find,inspect,template,package,show,show-all,files,list,add,remove,release,enable,disable,disable-outdated,update-active}
           ...

Command line interface for the Checkmk Extension Packages

options:
  -h, --help            show this help message and exit
  --debug, -d
  --verbose, -v         Be more verbose

available commands:
  {find,inspect,template,package,show,show-all,files,list,add,remove,release,enable,disable,disable-outdated,update-active}
    find                Show information about local files
    inspect             Show manifest of an MKP file
    template            Create a template of a package manifest
    package             Create an .mkp file from the provided manifest. You
                        can use the `template` command to create a manifest
                        template.
    show                Show manifest of a stored package
    show-all            Show all manifests
    files               Show all files beloning to a package
    list                Show a table of all known files, including the
                        deployment state
    add                 Add an MKP to the collection of managed MKPs
    remove              Remove a package from the site

mkp list                    # 列出已安装包及部署状态
mkp add /path/to/pkg.mkp    # 安装 MKP 包
mkp enable <包名> <版本>     # 启用
mkp disable <包名> <版本>    # 停用
mkp remove <包名> <版本>     # 卸载
mkp template                # 生成打包清单模板
mkp package manifest文件     # 按 manifest 打出 .mkp 包

Name Version Title Author Req. Version Until Version Files State
---- ------- ----- ------ ------------ ------------- ----- -----

su - mysite -c "printf 'GET hosts\nColumns: name state hard_state num_services services\n\n' | unixcat ~/tmp/run/live"

localhost;0;0;22;Uptime,TCP Connections,Site mysite statistics,Process mysite rrdcached,Process mysite redis-server,Process mysite event console,Process mysite automation helpers,Process mysite apache,Process mysite agent receiver,OMD mysite status,OMD mysite performance,OMD mysite disk usage,OMD mysite apache,OMD mysite Event Console,Memory,Interface 2,Disk IO SUMMARY,Check_MK HW/SW Inventory,Check_MK Discovery,Check_MK Agent,Check_MK,CPU utilization