diff --git a/.vitepress/config.mts b/.vitepress/config.mts
index c3ec39a..97eca27 100644
--- a/.vitepress/config.mts
+++ b/.vitepress/config.mts
@@ -93,7 +93,7 @@ export default defineConfig({
{ text: 'CGI Configuration File Options', link: '/documentation/usersguide/configcgi' },
{ text: 'Authentication And Authorization CGIs', link: '/documentation/usersguide/cgiauth' },
{ text: 'Plugins', link: '/documentation/usersguide/plugins' },
-
+ { text: 'Macros', link: '/documentation/usersguide/macros' },
{ text: 'Naemon Logo', link: '/logo' }
]
},
diff --git a/.vitepress/theme/naemon.css b/.vitepress/theme/naemon.css
index a1790ea..f9cd900 100644
--- a/.vitepress/theme/naemon.css
+++ b/.vitepress/theme/naemon.css
@@ -9,8 +9,8 @@
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(-45deg, #4FC3F7 50%, var(--vp-c-brand-1));
-
- --vp-home-hero-image-background-image: linear-gradient(45deg, var(--vp-c-brand-2) 50%, var(--vp-c-brand-1) 50%);
+
+ --vp-home-hero-image-background-image: linear-gradient(45deg, var(--vp-c-brand-2) 50%, var(--vp-c-brand-1) 50%);
--vp-home-hero-image-filter: blur(68px);
--red-light: #D73A49;
@@ -23,11 +23,11 @@
}
.text-red {
- color: var(--red-light);
+ color: var(--red-light) !important;
}
.dark .text-red {
- color: var(--red-dark);
+ color: var(--red-dark) !important;
}
/* Adds a background color to images to be better visible */
diff --git a/legacy/documentation/usersguide/macros.md b/src/documentation/usersguide/macros.md
similarity index 56%
rename from legacy/documentation/usersguide/macros.md
rename to src/documentation/usersguide/macros.md
index 6abbdea..241aee3 100644
--- a/legacy/documentation/usersguide/macros.md
+++ b/src/documentation/usersguide/macros.md
@@ -1,55 +1,60 @@
----
-layout: doctoc
-title: Understanding Macros and How They Work
----
+# Understanding Macros and How They Work
- See Also: List of Available Macros
-
-
-### Macros
+## Macros
One of the main features that make Naemon so flexible is the ability to use macros in command
definitions. Macros allow you to reference information from hosts, services, and other sources in your commands.
-### Macro Substitution - How Macros Work
+## Macro Substitution - How Macros Work
Before Naemon executes a command, it will replace any macros it finds in the command definition
with their corresponding values. This macro substitution occurs for all types of commands
that Naemon executes - host and service checks, notifications, event handlers, etc.
Certain macros may themselves contain other macros.
-These include the $HOSTNOTES$, $HOSTNOTESURL$, $HOSTACTIONURL$, $SERVICENOTES$, $SERVICENOTESURL$, and $SERVICEACTIONURL$ macros.
+These include the `$HOSTNOTES$`, `$HOSTNOTESURL$`, `$HOSTACTIONURL$`, `$SERVICENOTES$`, `$SERVICENOTESURL$`, and `$SERVICEACTIONURL$` macros.
-### Example 1: Host Address Macro
+## Example 1: Host Address Macro
When you use host and service macros in command definitions, they refer to values for the host or service
for which the command is being run. Let's try an example.
-Assuming we are using a host definition and a check_ping command defined like this:
+Assuming we are using a host definition and a `check_ping` command defined like this:
-
+
+
+
define host {
host_name linuxbox
- address 192.168.1.2
+ address 192.168.1.2
check_command check_ping
...
}
+
+
define command {
command_name check_ping
- command_line /usr/lib/naemon/plugins/check_ping -H $HOSTADDRESS$ -w 100.0,90% -c 200.0,60%
+ command_line /usr/lib/naemon/plugins/check_ping -H $HOSTADDRESS$ -w 100.0,90% -c 200.0,60%
}
+
+
- /usr/lib/naemon/plugins/check_ping -H 192.168.1.2 -w 100.0,90% -c 200.0,60%
+
+
+
+/usr/lib/naemon/plugins/check_ping -H 192.168.1.2 -w 100.0,90% -c 200.0,60%
+
+
+
+
+
define service {
host_name linuxbox
service_description PING
- check_command check_ping!200.0,80%!400.0,40%
+ check_command check_ping!200.0,80%!400.0,40%
...
}
+
+
+
+
+
define command {
command_name check_ping
- command_line /usr/lib/naemon/plugins/check_ping -H $HOSTADDRESS$ -w $ARG1$ -c $ARG2$
+ command_line /usr/lib/naemon/plugins/check_ping -H $HOSTADDRESS$ -w $ARG1$ -c $ARG2$
}
+
+
- /usr/lib/naemon/plugins/check_ping -H 192.168.1.2 -w 200.0,80% -c 400.0,40%
+
+
+
+/usr/lib/naemon/plugins/check_ping -H 192.168.1.2 -w 200.0,80% -c 400.0,40%
+
+
+
+
+
$HOSTDOWNTIME:myhost$ <--- On-demand host macro
$SERVICESTATEID:novellserver:DS Database$ <--- On-demand service macro
$SERVICESTATEID::CPU Load$ <--- On-demand service macro with blank host name field
+
+
+
+
+
$CONTACTEMAIL:john$ <--- On-demand contact macro
$CONTACTGROUPMEMBERS:linux-admins$ <--- On-demand contactgroup macro
$HOSTGROUPALIAS:linux-servers$ <--- On-demand hostgroup macro
$SERVICEGROUPALIAS:DNS-Cluster$ <--- On-demand servicegroup macro
+
+
+
+
+
$HOSTSTATEID:hg1:,$
+
+
+
-### Custom Variable Macros
+## Custom Variable Macros
-Any custom object variables that you define in host,
+Any [custom object variables](customobjectvars) that you define in host,
service, or contact definitions are also available as macros. Custom variable macros are named as follows:
-
-- $_HOSTvarname$
-- $_SERVICEvarname$
-- $_CONTACTvarname$
-
+- `$_HOSTvarname$`
+- `$_SERVICEvarname$`
+- `$_CONTACTvarname$`
+
Take the following host definition with a custom variable called `_MACADDRESS`...
-
+
+
+
define host {
host_name linuxbox
address 192.168.1.1
- _MACADDRESS 00:01:02:03:04:05
+ _MACADDRESS 00:01:02:03:04:05
...
}
+
+
-- $HOSTOUTPUT$
-- $LONGHOSTOUTPUT$
-- $HOSTPERFDATA$
-- $HOSTACKAUTHOR$
-- $HOSTACKCOMMENT$
-- $SERVICEOUTPUT$
-- $LONGSERVICEOUTPUT$
-- $SERVICEPERFDATA$
-- $SERVICEACKAUTHOR$
-- $SERVICEACKCOMMENT$
-
+1. [`$HOSTOUTPUT$`](macrolist#hostoutput)
+2. [`$LONGHOSTOUTPUT$`](macrolist#longhostoutput)
+3. [`$HOSTPERFDATA$`](macrolist#hostperfdata)
+4. [`$HOSTACKAUTHOR$`](macrolist#hostackauthor)
+5. [`$HOSTACKCOMMENT$`](macrolist#hostackcomment)
+6. [`$SERVICEOUTPUT$`](macrolist#serviceoutput)
+7. [`$LONGSERVICEOUTPUT$`](macrolist#longserviceoutput)
+8. [`$SERVICEPERFDATA$`](macrolist#serviceperfdata)
+9. [`$SERVICEACKAUTHOR$`](macrolist#serviceackauthor)
+10. [`$SERVICEACKCOMMENT$`](macrolist#serviceackcomment)
-Additionally, any macros that contain custom variables are stripped for safety and security.
+Additionally, any macros that contain [custom variables](customobjectvars) are stripped for safety and security.
-### Macros as Environment Variables
+## Macros as Environment Variables
Since Naemon macros are no longer available in the environment for performance reasons. Its
a huge waste of resources to calculate all macros all the time even if they are not used.
@@ -235,18 +273,22 @@ can edit your command to export specific macros.
Example notification command:
-
+
+
+
define command {
command_name my_old_notification_script
- command_line NAGIOS_HOSTNAME="$HOSTNAME$" /usr/local/bin/notifiy.pl ...
+ command_line NAGIOS_HOSTNAME="$HOSTNAME$" /usr/local/bin/notifiy.pl ...
}
+
+