{ "content": [ { "type": "text", "text": "# postmulti (man)\n\n## NAME\n\npostmulti - Postfix multi-instance manager\n\n## DESCRIPTION\n\nThe postmulti(1) command allows a Postfix administrator to manage multiple Postfix instances\non a single host.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS** (3 subsections)\n- **DESCRIPTION**\n- **BACKGROUND**\n- **ITERATOR MODE** (13 subsections)\n- **LIFE-CYCLE MANAGEMENT MODE** (11 subsections)\n- **ENVIRONMENT**\n- **CONFIGURATION PARAMETERS**\n- **FILES**\n- **SEE ALSO**\n- **README FILES**\n- **HISTORY**\n- **LICENSE**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n" } ], "structuredContent": { "command": "postmulti", "section": "", "mode": "man", "summary": "postmulti - Postfix multi-instance manager", "synopsis": "", "tldr_summary": null, "tldr_examples": [], "tldr_source": null, "flags": [ { "flag": "-a", "long": null, "arg": null, "description": "" }, { "flag": "-g", "long": null, "arg": null, "description": "Perform the operation only for members of the named group." }, { "flag": "-i", "long": null, "arg": null, "description": "Perform the operation only for the instance with the specified name. You can specify either the instance name or the absolute pathname of the instance's configuration di‐ rectory. Specify \"-\" to select the primary Postfix instance." }, { "flag": "-R", "long": null, "arg": null, "description": "system, where \"sink\" instances are started before \"source\" instances. This option cannot be used with -p." }, { "flag": "-l", "long": null, "arg": null, "description": "status and configuration directory." }, { "flag": "-p", "long": null, "arg": null, "description": "Invoke postfix(1) to execute postfix-command. This option implements the post‐‐ fix-wrapper(5) interface. • With \"start\"-like commands, \"postfix check\" is executed for instances that are not enabled. The full list of commands is specified with the post‐ multistartcommands parameter. • With \"stop\"-like commands, the iteration order is reversed, and disabled in‐ stances are skipped. The full list of commands is specified with the post‐ multistopcommands parameter. • With \"reload\" and other commands that require a started instance, disabled in‐ stances are skipped. The full list of commands is specified with the post‐ multicontrolcommands parameter. • With \"status\" and other commands that don't require a started instance, the command is executed for all instances. The -p option can also be used interactively to start/stop/etc. a named instance or instance group. For example, to start just the instances in the group \"msa\", invoke postmulti(1) as follows: # postmulti -g msa -p start" }, { "flag": "-x", "long": null, "arg": null, "description": "Execute the specified unix-command for all Postfix instances. The command runs with appropriate environment settings for MAILCONFIG, commanddirectory, daemondirectory, configdirectory, queuedirectory, datadirectory, multiinstancename, multiin‐ stancegroup and multiinstanceenable." }, { "flag": "-v", "long": null, "arg": null, "description": "increasingly verbose." }, { "flag": "-a", "long": null, "arg": null, "description": "secondary instance list." }, { "flag": "-g", "long": null, "arg": null, "description": "When creating or importing an instance, place the new instance before the first sec‐ ondary instance that is a member of the specified group." }, { "flag": "-i", "long": null, "arg": null, "description": "When creating or importing an instance, place the new instance before the matching secondary instance. With other life-cycle operations, apply the operation to the named existing instance. Specify \"-\" to select the primary Postfix instance." }, { "flag": "-I", "long": null, "arg": null, "description": "Assign the specified instance name to an existing instance, newly-created instance, or imported instance. Instance names other than \"-\" (which makes the instance \"name‐ less\") must start with \"postfix-\". This restriction reduces the likelihood of name collisions with system files." }, { "flag": "-G", "long": null, "arg": null, "description": "Assign the specified group name to an existing instance or to a newly created or im‐ ported instance." }, { "flag": "-e", "long": null, "arg": null, "description": "\"Edit\" managed instances. The following actions are supported: init This command is required before postmulti(1) can be used to manage Postfix in‐ stances. The \"postmulti -e init\" command updates the primary instance's main.cf file by setting: multiinstancewrapper = ${commanddirectory}/postmulti -p -- multiinstanceenable = yes You can set these by other means if you prefer. create Create a new Postfix instance and add it to the multiinstancedirectories pa‐ rameter of the primary instance. The \"-I name\" option is recommended to give the instance a short name that is used to construct default values for the pri‐ vate directories of the new instance. The \"-G group\" option may be specified to assign the instance to a group, otherwise, the new instance is not a member of any groups. The new instance main.cf is the stock main.cf with the parameters that specify the locations of shared files cloned from the primary instance. For \"nameless\" instances, you should manually adjust \"syslogname\" to yield a unique \"logtag\" starting with \"postfix-\" that will uniquely identify the instance in the mail logs. It is simpler to assign the instance a short name with the \"-I name\" op‐ tion. Optional \"name=value\" arguments specify the instance configdirectory, queuedirectory and datadirectory. For example: # postmulti -I postfix-mumble \\ -G mygroup -e create \\ configdirectory=/my/config/dir \\ queuedirectory=/my/queue/dir \\ datadirectory=/my/data/dir If any of these pathnames is not supplied, the program attempts to generate the pathname by taking the corresponding primary instance pathname, and by replac‐ ing the last pathname component by the value of the -I option. If the instance configuration directory already exists, and contains both a main.cf and master.cf file, create will \"import\" the instance as-is. For exist‐ ing instances, create and import are identical. import Import an existing instance into the list of instances managed by the post‐‐ multi(1) multi-instance manager. This adds the instance to the multiin‐ stancedirectories list of the primary instance. If the \"-I name\" option is provided it specifies the new name for the instance and is used to define a de‐ fault location for the instance configuration directory (as with create above). The \"-G group\" option may be used to assign the instance to a group. Add a \"configdirectory=/path\" argument to override a default pathname based on \"-I name\". destroy Destroy a secondary Postfix instance. To be a candidate for destruction an in‐ stance must be disabled, stopped and its queue must not contain any messages. Attempts to destroy the primary Postfix instance trigger a fatal error, without destroying the instance. The instance is removed from the primary instance main.cf file's alternatecon‐ figdirectories parameter and its data, queue and configuration directories are cleaned of files and directories created by the Postfix system. The main.cf and master.cf files are removed from the configuration directory even if they have been modified since initial creation. Finally, the instance is \"deported\" from the list of managed instances. If other files are present in instance private directories, the directories may not be fully removed, a warning is logged to alert the administrator. It is ex‐ pected that an instance built using \"fresh\" directories via the create action will be fully removed by the destroy action (if first disabled). If the in‐ stance configuration and queue directories are populated with additional files (access and rewriting tables, chroot jail content, etc.) the instance directo‐ ries will not be fully removed. The destroy action triggers potentially dangerous file removal operations. Make sure the instance's data, queue and configuration directories are set correctly and do not contain any valuable files. deport Deport a secondary instance from the list of managed instances. This deletes the instance configuration directory from the primary instance's multiin‐ stancedirectories list, but does not remove any files or directories. assign Assign a new instance name or a new group name to the selected instance. Use \"-G -\" to specify \"no group\" and \"-I -\" to specify \"no name\". If you choose to make an instance \"nameless\", set a suitable syslogname in the corresponding main.cf file. enable Mark the selected instance as enabled. This just sets the multiinstanceenable parameter to \"yes\" in the instance's main.cf file. disable Mark the selected instance as disabled. This means that the instance will not be started etc. with \"postfix start\", \"postmulti -p start\" and so on. The in‐ stance can still be started etc. with \"postfix -c config-directory start\"." }, { "flag": "-v", "long": null, "arg": null, "description": "increasingly verbose." } ], "examples": [], "see_also": [ { "name": "postfix", "section": "1", "url": "https://www.chedong.com/phpMan.php/man/postfix/1/json" }, { "name": "postfix-wrapper", "section": "5", "url": "https://www.chedong.com/phpMan.php/man/postfix-wrapper/5/json" } ], "section_outline": [ { "name": "NAME", "lines": 2, "subsections": [] }, { "name": "SYNOPSIS", "lines": 1, "subsections": [ { "name": "Enabling multi-instance management:", "lines": 2 }, { "name": "Iterator mode:", "lines": 6 }, { "name": "Life-cycle management:", "lines": 14 } ] }, { "name": "DESCRIPTION", "lines": 10, "subsections": [] }, { "name": "BACKGROUND", "lines": 13, "subsections": [] }, { "name": "ITERATOR MODE", "lines": 7, "subsections": [ { "name": "Instance selection", "lines": 1 }, { "name": "-a", "lines": 1, "flag": "-a" }, { "name": "-g", "lines": 2, "flag": "-g" }, { "name": "-i", "lines": 4, "flag": "-i" }, { "name": "-R", "lines": 4, "flag": "-R" }, { "name": "List mode", "lines": 1 }, { "name": "-l", "lines": 2, "flag": "-l" }, { "name": "Postfix-wrapper mode", "lines": 1 }, { "name": "-p", "lines": 24, "flag": "-p" }, { "name": "Command mode", "lines": 1 }, { "name": "-x", "lines": 5, "flag": "-x" }, { "name": "Other options", "lines": 1 }, { "name": "-v -v", "lines": 2, "flag": "-v" } ] }, { "name": "LIFE-CYCLE MANAGEMENT MODE", "lines": 5, "subsections": [ { "name": "Existing instance selection", "lines": 1 }, { "name": "-a", "lines": 2, "flag": "-a" }, { "name": "-g", "lines": 3, "flag": "-g" }, { "name": "-i", "lines": 6, "flag": "-i" }, { "name": "New or existing instance name assignment", "lines": 1 }, { "name": "-I", "lines": 5, "flag": "-I" }, { "name": "-G", "lines": 3, "flag": "-G" }, { "name": "Instance creation/deletion/status change", "lines": 1 }, { "name": "-e", "lines": 94, "flag": "-e" }, { "name": "Other options", "lines": 1 }, { "name": "-v -v", "lines": 2, "flag": "-v" } ] }, { "name": "ENVIRONMENT", "lines": 9, "subsections": [] }, { "name": "CONFIGURATION PARAMETERS", "lines": 56, "subsections": [] }, { "name": "FILES", "lines": 4, "subsections": [] }, { "name": "SEE ALSO", "lines": 3, "subsections": [] }, { "name": "README FILES", "lines": 3, "subsections": [] }, { "name": "HISTORY", "lines": 2, "subsections": [] }, { "name": "LICENSE", "lines": 19, "subsections": [] } ], "sections": { "NAME": { "content": "postmulti - Postfix multi-instance manager\n", "subsections": [] }, "SYNOPSIS": { "content": "", "subsections": [ { "name": "Enabling multi-instance management:", "content": "postmulti -e init [-v]\n" }, { "name": "Iterator mode:", "content": "postmulti -l [-aRv] [-g group] [-i name]\n\npostmulti -p [-av] [-g group] [-i name] postfix-command...\n\npostmulti -x [-aRv] [-g group] [-i name] unix-command...\n" }, { "name": "Life-cycle management:", "content": "postmulti -e create [-av] [-g group] [-i name] [-G group] [-I name] [param=value ...]\n\npostmulti -e import [-av] [-g group] [-i name] [-G group] [-I name] [configdirectory=/path]\n\npostmulti -e destroy [-v] -i name\n\npostmulti -e deport [-v] -i name\n\npostmulti -e enable [-v] -i name\n\npostmulti -e disable [-v] -i name\n\npostmulti -e assign [-v] -i name [-I name] [-G group]\n" } ] }, "DESCRIPTION": { "content": "The postmulti(1) command allows a Postfix administrator to manage multiple Postfix instances\non a single host.\n\npostmulti(1) implements two fundamental modes of operation. In iterator mode, it executes\nthe same command for multiple Postfix instances. In life-cycle management mode, it adds or\ndeletes one instance, or changes the multi-instance status of one instance.\n\nEach mode of operation has its own command syntax. For this reason, each mode is documented\nin separate sections below.\n", "subsections": [] }, "BACKGROUND": { "content": "A multi-instance configuration consists of one primary Postfix instance, and one or more sec‐\nondary instances whose configuration directory pathnames are recorded in the primary in‐\nstance's main.cf file. Postfix instances share program files and documentation, but have\ntheir own configuration, queue and data directories.\n\nCurrently, only the default Postfix instance can be used as primary instance in a multi-in‐\nstance configuration. The postmulti(1) command does not currently support a -c option to se‐\nlect an alternative primary instance, and exits with a fatal error if the MAILCONFIG envi‐\nronment variable is set to a non-default configuration directory.\n\nSee the MULTIINSTANCEREADME tutorial for a more detailed discussion of multi-instance man‐\nagement with postmulti(1).\n", "subsections": [] }, "ITERATOR MODE": { "content": "In iterator mode, postmulti performs the same operation on all Postfix instances in turn.\n\nIf multi-instance support is not enabled, the requested command is performed just for the\nprimary instance.\n\nIterator mode implements the following command options:\n", "subsections": [ { "name": "Instance selection", "content": "" }, { "name": "-a", "content": "", "flag": "-a" }, { "name": "-g", "content": "Perform the operation only for members of the named group.\n", "flag": "-g" }, { "name": "-i", "content": "Perform the operation only for the instance with the specified name. You can specify\neither the instance name or the absolute pathname of the instance's configuration di‐\nrectory. Specify \"-\" to select the primary Postfix instance.\n", "flag": "-i" }, { "name": "-R", "content": "system, where \"sink\" instances are started before \"source\" instances.\n\nThis option cannot be used with -p.\n", "flag": "-R" }, { "name": "List mode", "content": "" }, { "name": "-l", "content": "status and configuration directory.\n", "flag": "-l" }, { "name": "Postfix-wrapper mode", "content": "" }, { "name": "-p", "content": "Invoke postfix(1) to execute postfix-command. This option implements the post‐‐\nfix-wrapper(5) interface.\n\n• With \"start\"-like commands, \"postfix check\" is executed for instances that are\nnot enabled. The full list of commands is specified with the post‐\nmultistartcommands parameter.\n\n• With \"stop\"-like commands, the iteration order is reversed, and disabled in‐\nstances are skipped. The full list of commands is specified with the post‐\nmultistopcommands parameter.\n\n• With \"reload\" and other commands that require a started instance, disabled in‐\nstances are skipped. The full list of commands is specified with the post‐\nmulticontrolcommands parameter.\n\n• With \"status\" and other commands that don't require a started instance, the\ncommand is executed for all instances.\n\nThe -p option can also be used interactively to start/stop/etc. a named instance or\ninstance group. For example, to start just the instances in the group \"msa\", invoke\npostmulti(1) as follows:\n\n# postmulti -g msa -p start\n", "flag": "-p" }, { "name": "Command mode", "content": "" }, { "name": "-x", "content": "Execute the specified unix-command for all Postfix instances. The command runs with\nappropriate environment settings for MAILCONFIG, commanddirectory, daemondirectory,\nconfigdirectory, queuedirectory, datadirectory, multiinstancename, multiin‐\nstancegroup and multiinstanceenable.\n", "flag": "-x" }, { "name": "Other options", "content": "" }, { "name": "-v -v", "content": "increasingly verbose.\n", "flag": "-v" } ] }, "LIFE-CYCLE MANAGEMENT MODE": { "content": "With the -e option postmulti(1) can be used to add or delete a Postfix instance, and to man‐\nage the multi-instance status of an existing instance.\n\nThe following options are implemented:\n", "subsections": [ { "name": "Existing instance selection", "content": "" }, { "name": "-a", "content": "secondary instance list.\n", "flag": "-a" }, { "name": "-g", "content": "When creating or importing an instance, place the new instance before the first sec‐\nondary instance that is a member of the specified group.\n", "flag": "-g" }, { "name": "-i", "content": "When creating or importing an instance, place the new instance before the matching\nsecondary instance.\n\nWith other life-cycle operations, apply the operation to the named existing instance.\nSpecify \"-\" to select the primary Postfix instance.\n", "flag": "-i" }, { "name": "New or existing instance name assignment", "content": "" }, { "name": "-I", "content": "Assign the specified instance name to an existing instance, newly-created instance, or\nimported instance. Instance names other than \"-\" (which makes the instance \"name‐\nless\") must start with \"postfix-\". This restriction reduces the likelihood of name\ncollisions with system files.\n", "flag": "-I" }, { "name": "-G", "content": "Assign the specified group name to an existing instance or to a newly created or im‐\nported instance.\n", "flag": "-G" }, { "name": "Instance creation/deletion/status change", "content": "" }, { "name": "-e", "content": "\"Edit\" managed instances. The following actions are supported:\n\ninit This command is required before postmulti(1) can be used to manage Postfix in‐\nstances. The \"postmulti -e init\" command updates the primary instance's\nmain.cf file by setting:\n\nmultiinstancewrapper =\n${commanddirectory}/postmulti -p --\nmultiinstanceenable = yes\n\nYou can set these by other means if you prefer.\n\ncreate Create a new Postfix instance and add it to the multiinstancedirectories pa‐\nrameter of the primary instance. The \"-I name\" option is recommended to give\nthe instance a short name that is used to construct default values for the pri‐\nvate directories of the new instance. The \"-G group\" option may be specified to\nassign the instance to a group, otherwise, the new instance is not a member of\nany groups.\n\nThe new instance main.cf is the stock main.cf with the parameters that specify\nthe locations of shared files cloned from the primary instance. For \"nameless\"\ninstances, you should manually adjust \"syslogname\" to yield a unique \"logtag\"\nstarting with \"postfix-\" that will uniquely identify the instance in the mail\nlogs. It is simpler to assign the instance a short name with the \"-I name\" op‐\ntion.\n\nOptional \"name=value\" arguments specify the instance configdirectory,\nqueuedirectory and datadirectory. For example:\n\n# postmulti -I postfix-mumble \\\n-G mygroup -e create \\\nconfigdirectory=/my/config/dir \\\nqueuedirectory=/my/queue/dir \\\ndatadirectory=/my/data/dir\n\nIf any of these pathnames is not supplied, the program attempts to generate the\npathname by taking the corresponding primary instance pathname, and by replac‐\ning the last pathname component by the value of the -I option.\n\nIf the instance configuration directory already exists, and contains both a\nmain.cf and master.cf file, create will \"import\" the instance as-is. For exist‐\ning instances, create and import are identical.\n\nimport Import an existing instance into the list of instances managed by the post‐‐\nmulti(1) multi-instance manager. This adds the instance to the multiin‐\nstancedirectories list of the primary instance. If the \"-I name\" option is\nprovided it specifies the new name for the instance and is used to define a de‐\nfault location for the instance configuration directory (as with create above).\nThe \"-G group\" option may be used to assign the instance to a group. Add a\n\"configdirectory=/path\" argument to override a default pathname based on \"-I\nname\".\n\ndestroy\nDestroy a secondary Postfix instance. To be a candidate for destruction an in‐\nstance must be disabled, stopped and its queue must not contain any messages.\nAttempts to destroy the primary Postfix instance trigger a fatal error, without\ndestroying the instance.\n\nThe instance is removed from the primary instance main.cf file's alternatecon‐\nfigdirectories parameter and its data, queue and configuration directories are\ncleaned of files and directories created by the Postfix system. The main.cf and\nmaster.cf files are removed from the configuration directory even if they have\nbeen modified since initial creation. Finally, the instance is \"deported\" from\nthe list of managed instances.\n\nIf other files are present in instance private directories, the directories may\nnot be fully removed, a warning is logged to alert the administrator. It is ex‐\npected that an instance built using \"fresh\" directories via the create action\nwill be fully removed by the destroy action (if first disabled). If the in‐\nstance configuration and queue directories are populated with additional files\n(access and rewriting tables, chroot jail content, etc.) the instance directo‐\nries will not be fully removed.\n\nThe destroy action triggers potentially dangerous file removal operations. Make\nsure the instance's data, queue and configuration directories are set correctly\nand do not contain any valuable files.\n\ndeport Deport a secondary instance from the list of managed instances. This deletes\nthe instance configuration directory from the primary instance's multiin‐\nstancedirectories list, but does not remove any files or directories.\n\nassign Assign a new instance name or a new group name to the selected instance. Use\n\"-G -\" to specify \"no group\" and \"-I -\" to specify \"no name\". If you choose to\nmake an instance \"nameless\", set a suitable syslogname in the corresponding\nmain.cf file.\n\nenable Mark the selected instance as enabled. This just sets the multiinstanceenable\nparameter to \"yes\" in the instance's main.cf file.\n\ndisable\nMark the selected instance as disabled. This means that the instance will not\nbe started etc. with \"postfix start\", \"postmulti -p start\" and so on. The in‐\nstance can still be started etc. with \"postfix -c config-directory start\".\n", "flag": "-e" }, { "name": "Other options", "content": "" }, { "name": "-v -v", "content": "increasingly verbose.\n", "flag": "-v" } ] }, "ENVIRONMENT": { "content": "The postmulti(1) command exports the following environment variables before executing the re‐\nquested command for a given instance:\n\nMAILVERBOSE\nThis is set when the -v command-line option is present.\n\nMAILCONFIG\nThe location of the configuration directory of the instance.\n", "subsections": [] }, "CONFIGURATION PARAMETERS": { "content": "configdirectory (see 'postconf -d' output)\nThe default location of the Postfix main.cf and master.cf configuration files.\n\ndaemondirectory (see 'postconf -d' output)\nThe directory with Postfix support programs and daemon programs.\n\nimportenvironment (see 'postconf -d' output)\nThe list of environment parameters that a privileged Postfix process will import from\na non-Postfix parent process, or name=value environment overrides.\n\nmultiinstancedirectories (empty)\nAn optional list of non-default Postfix configuration directories; these directories\nbelong to additional Postfix instances that share the Postfix executable files and\ndocumentation with the default Postfix instance, and that are started, stopped, etc.,\ntogether with the default Postfix instance.\n\nmultiinstancegroup (empty)\nThe optional instance group name of this Postfix instance.\n\nmultiinstancename (empty)\nThe optional instance name of this Postfix instance.\n\nmultiinstanceenable (no)\nAllow this Postfix instance to be started, stopped, etc., by a multi-instance manager.\n\npostmultistartcommands (start)\nThe postfix(1) commands that the postmulti(1) instance manager treats as \"start\" com‐\nmands.\n\npostmultistopcommands (see 'postconf -d' output)\nThe postfix(1) commands that the postmulti(1) instance manager treats as \"stop\" com‐\nmands.\n\npostmulticontrolcommands (reload flush)\nThe postfix(1) commands that the postmulti(1) instance manager treats as \"control\"\ncommands, that operate on running instances.\n\nsyslogfacility (mail)\nThe syslog facility of Postfix logging.\n\nsyslogname (see 'postconf -d' output)\nA prefix that is prepended to the process name in syslog records, so that, for exam‐\nple, \"smtpd\" becomes \"prefix/smtpd\".\n\nAvailable in Postfix 3.0 and later:\n\nmetadirectory (see 'postconf -d' output)\nThe location of non-executable files that are shared among multiple Postfix instances,\nsuch as postfix-files, dynamicmaps.cf, and the multi-instance template files\nmain.cf.proto and master.cf.proto.\n\nshlibdirectory (see 'postconf -d' output)\nThe location of Postfix dynamically-linked libraries (libpostfix-*.so), and the de‐\nfault location of Postfix database plugins (postfix-*.so) that have a relative path‐\nname in the dynamicmaps.cf file.\n", "subsections": [] }, "FILES": { "content": "$metadirectory/main.cf.proto, stock configuration file\n$metadirectory/master.cf.proto, stock configuration file\n$daemondirectory/postmulti-script, life-cycle helper program\n", "subsections": [] }, "SEE ALSO": { "content": "postfix(1), Postfix control program\npostfix-wrapper(5), Postfix multi-instance API\n", "subsections": [] }, "README FILES": { "content": "Use \"postconf readmedirectory\" or \"postconf htmldirectory\" to locate this information.\nMULTIINSTANCEREADME, Postfix multi-instance management\n", "subsections": [] }, "HISTORY": { "content": "The postmulti(1) command was introduced with Postfix version 2.6.\n", "subsections": [] }, "LICENSE": { "content": "The Secure Mailer license must be distributed with this software.\n\nAUTHOR(S)\nVictor Duchovni\nMorgan Stanley\n\nWietse Venema\nIBM T.J. Watson Research\nP.O. Box 704\nYorktown Heights, NY 10598, USA\n\nWietse Venema\nGoogle, Inc.\n111 8th Avenue\nNew York, NY 10011, USA\n\n\n\nPOSTMULTI(1)", "subsections": [] } } } }