REALMINIT(1)

📦
version 2.2.3 · 2 versions
, in fedora 43

💖 REALMINIT(1) 💖

okay bestie, so this is realminit, and it lives in the User Contributed Perl Documentation corner of your manual. buckle up, we're making realms. 🦋

✨ NAME ✨

realminit — it makes brand new realm records for a DNSSEC-Tools realms file. that's it. that's the job. 💅

🌸 SYNOPSIS 🌸

realminit [options] <realm1> ... <realmN>

🎀 DESCRIPTION 🎀

okay so realminit creates new realm entries for a realms file. meanwhile dtrealms is out here managing multiple distinct DNSSEC-Tools rollover environments running simultaneously — like, at the same time, no big deal. each one of those rollover environments is called a realm, and every realm gets defined in a realms file. dtrealms reads that file to figure out how to run each rollover environment. this is lowkey iconic for stuff like managing very large collections of zones, segregating customer zones, and software tests. ✨

the newly generated realm entries get written to standard output, unless you pass the -out option. (we love a redirect. we love a file. options, options.) 💖

so a realms file is just a bunch of entries, one for each managed realm. and a realm entry looks like THIS:

realm "example"
    state          "active"
    configdir      "/usr/realms/configs/example"
    statedir       "/usr/realms/states/example"
    realmsdir      "/usr/realms/realms-files/example"
    rollrec        "example.rrf"
    administrator  "bob@cat.example.com"
    display        "1"
    manager        "rollerd"
    args           "-display -loglevel phase"

you can create multiple realm entries in a single execution of realminit — one girl, many realms, main character energy fr fr. except for the entry's name field, those entries will be exactly the same unless you use the '=' metacharacter in the command-line options. here's the tea: if the values of the configdir, statedir, realmdir, rollrec, administrator, args, or user options contain an '=', then it gets replaced with the realm's name when building the entry. it's giving template. it's giving mad libs but for DNS. 🧚 check the EXAMPLES section for how options are actually used by realminit.

👑 OPTIONS 👑

realminit may be given the following options, bestie:

  • -active — this says dtrealms should start the realm when dtrealms starts. realms are active by default, so this is you just being explicit about it. 💅
  • -administrator — the email address for the realm's administrator. someone's gotta get the emails.
  • -args — a set of command-line arguments passed to the realm's rollover manager when the realm is started.
  • -configdir — the realm's configuration directory. it holds things like the DNSSEC-Tools configuration file for that realm. 🎀
  • -display — this indicates if the realm should be included in grandvizier output.
  • -inactive — this says dtrealms should not start the realm when dtrealms starts. rest era.
  • -manager — the rollover manager for the realm. rollerd is the default rollover manager, but other managers may be used. (not me being loyal to rollerd.)
  • -out output-file — the new realm entries will be appended to output-file. the file will be created if it does not exist. 🫶

if this option is not given, the new rollrec entries will be written to standard output.

  • -realmdir — the realm's data directory. this directory is expected to contain the rollrec file, zone files, keyrec files, and key files for the zones in that realm. it's giving whole entire closet. 🌈
  • -rollrec — the path to the realm's rollrec file. this is used to control rollover actions for the realm. if it is not an absolute path, it will be assumed to be relative to the realmdir field.
  • -statedir — the realm's state directory. it holds things like that realm's rollrec lock file and the rollerd communications socket. if the statedir is not defined for a realm, then the realm's configdir is used for that value. (fallback queen.) 💜
  • -user — the user that the realm is executed as. > heads up bestie: this is not yet implemented in dtrealms. 😭
  • -help — display a usage message.
  • -Version — display version information for realminit and DNSSEC-Tools. note the capital V, she's fancy. ✨

🌟 EXAMPLES 🌟

the following options should make clear how realminit deals with options and the new realms. Example 1 will show the complete new realm record. for the sake of brevity, the remaining examples will only show the fields relevant to that example. further examples will also use short-hand forms of the option names. iykyk. 🦋

🍓 Example 1. One realm, with -statedir

this example shows the realm generated by giving realminit a single realm.

$ realminit -active -configdir /realms/confs/example -statedir /realms/states/example -realmdir /realms/realms/example -rollrec example.rrf -admin bob@cat.example.com -args "-loglevel phase -logfile logger" example

realm       "example"
    state           "active"
    configdir       "/realms/confs/example"
    statedir        "/realms/states/example"
    realmdir        "/realms/realms/example"
    rollrec         "example.rrf"
    administrator   "bob@cat.example.com"
    display         "1"
    manager         "rollerd"
    args            "-loglevel phase -logfile logger"

look at her. fully formed. we're so proud. 😭💖

🍓 Example 2. One realm, without -statedir

this example shows the realm generated by giving realminit a single realm.

$ realminit -active -configdir /realms/confs/example -realmdir /realms/realms/example -rollrec example.rrf -admin bob@cat.example.com -args "-loglevel phase -logfile logger" example

realm       "example"
    state           "active"
    configdir       "/realms/confs/example"
    statedir        "/realms/confs/example"
    ...

see how statedir just quietly became the configdir? that's the fallback. no drama, just defaults. 💅

🍓 Example 3. Two realms, without metacharacters

this example shows the realms generated by giving realminit two realms, without using the special "=" metacharacter.

$ realminit -configdir /realms/confs/example -statedir /realms/states/example -realmdir /realms/realms/example -rollrec example.rrf -admin bob@cat.example.com example test

realm       "example"
    configdir       "/realms/confs/example"
    statedir        "/realms/states/example"
    realmdir        "/realms/realms/example"
    rollrec         "example.rrf"
    administrator   "bob@cat.example.com"
    ...

realm       "test"
    configdir       "/realms/confs/example"
    statedir        "/realms/states/example"
    realmdir        "/realms/realms/example"
    rollrec         "example.rrf"
    administrator   "bob@cat.example.com"
    ...

both realms got the same everything except the name. twins. matching outfits. 👯

🍓 Example 4. Two realms, with metacharacters

this example shows the realms generated by giving realminit two realms, and that uses the special "=" metacharacter.

$ realminit -configdir /realms/confs/= -statedir /realms/states/= -realmdir /realms/realms/= -rollrec =.rrf -admin bob@cat.=.com example test

realm       "example"
    configdir       "/realms/confs/example"
    statedir        "/realms/states/example"
    realmdir        "/realms/realms/example"
    rollrec         "example.rrf"
    administrator   "bob@cat.example.com"
    ...

realm       "test"
    configdir       "/realms/confs/test"
    statedir        "/realms/states/test"
    realmdir        "/realms/realms/test"
    rollrec         "test.rrf"
    administrator   "bob@cat.test.com"
    ...

THE = ATE. 🎀 every single = got swapped for the realm name and now both realms are custom-built. this is the one. this is the moment. ⭐

Copyright 2012-2014 SPARTA, Inc. All rights reserved. See the COPYING file included with the DNSSEC-Tools package for details.

🌸 AUTHOR 🌸

Wayne Morrison, tewok@tislabs.com

🔥 SEE ALSO 🔥

lsrealm(1), dtrealms(8), realmchk(8)

Net::DNS::SEC::Tools::realm.pm(3),

file-realmrec.pm(5)

and that's the whole page bestie!! 💖 this one came from perl v5.42.0 and it's dated 2025-07-23 — you're reading REALMINIT(1), so go forth and make realms, periodt. 🦋✨🎀

📦 where this page comes from