{
    "content": [
        {
            "type": "text",
            "text": "# multipathd (man)\n\n## NAME\n\nmultipathd - Multipath daemon.\n\n## SYNOPSIS\n\nmultipathd [-d|-k] [-s] [-v verbosity] [-B] [-w]\n\n## DESCRIPTION\n\nThe  multipathd  daemon is in charge of checking for failed paths. When this happens, it will\nreconfigure the multipath map the path belongs to, so that this map regains its maximum  per‐\nformance and redundancy.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **OPTIONS** (7 subsections)\n- **COMMANDS** (47 subsections)\n- **SYSTEMD INTEGRATION** (3 subsections)\n- **SEE ALSO**\n- **AUTHORS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "multipathd",
        "section": "",
        "mode": "man",
        "summary": "multipathd - Multipath daemon.",
        "synopsis": "multipathd [-d|-k] [-s] [-v verbosity] [-B] [-w]",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [
            {
                "flag": "-d",
                "long": null,
                "arg": null,
                "description": ""
            },
            {
                "flag": "-s",
                "long": null,
                "arg": null,
                "description": ""
            },
            {
                "flag": "-v",
                "long": null,
                "arg": null,
                "description": "Verbosity level. Print additional information while running multipathd. A level of 0 means only print errors. A level of 3 or greater prints debugging information as well."
            },
            {
                "flag": "-B",
                "long": null,
                "arg": null,
                "description": "file. If a userfriendlyname doesn't already exist for a device, it will use its WWID as its alias."
            },
            {
                "flag": "-k",
                "long": null,
                "arg": null,
                "description": "viewed by entering 'help'. When you are finished entering commands, press CTRL-D to quit."
            },
            {
                "flag": "-n",
                "long": null,
                "arg": null,
                "description": "vices by multipathd. See multipath.conf(5)."
            },
            {
                "flag": "-w",
                "long": null,
                "arg": null,
                "description": "multipath devices on dmevents. Use this flag to force it to use the old event waiting method, based on creating a seperate thread for each device."
            }
        ],
        "examples": [],
        "see_also": [
            {
                "name": "multipath",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/multipath/8/json"
            },
            {
                "name": "kpartx",
                "section": "8",
                "url": "https://www.chedong.com/phpMan.php/man/kpartx/8/json"
            },
            {
                "name": "sdnotify",
                "section": "3",
                "url": "https://www.chedong.com/phpMan.php/man/sdnotify/3/json"
            },
            {
                "name": "system.service",
                "section": "5",
                "url": "https://www.chedong.com/phpMan.php/man/system.service/5/json"
            }
        ],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 8,
                "subsections": []
            },
            {
                "name": "OPTIONS",
                "lines": 1,
                "subsections": [
                    {
                        "name": "-d",
                        "lines": 1,
                        "flag": "-d"
                    },
                    {
                        "name": "-s",
                        "lines": 1,
                        "flag": "-s"
                    },
                    {
                        "name": "-v",
                        "lines": 3,
                        "flag": "-v"
                    },
                    {
                        "name": "-B",
                        "lines": 3,
                        "flag": "-B"
                    },
                    {
                        "name": "-k",
                        "lines": 3,
                        "flag": "-k"
                    },
                    {
                        "name": "-n",
                        "lines": 2,
                        "flag": "-n"
                    },
                    {
                        "name": "-w",
                        "lines": 3,
                        "flag": "-w"
                    }
                ]
            },
            {
                "name": "COMMANDS",
                "lines": 2,
                "subsections": [
                    {
                        "name": "list|show paths",
                        "lines": 2
                    },
                    {
                        "name": "list|show paths format $format",
                        "lines": 3
                    },
                    {
                        "name": "list|show maps|multipaths",
                        "lines": 2
                    },
                    {
                        "name": "list|show maps|multipaths format $format",
                        "lines": 3
                    },
                    {
                        "name": "list|show maps|multipaths status",
                        "lines": 2
                    },
                    {
                        "name": "list|show maps|multipaths stats",
                        "lines": 2
                    },
                    {
                        "name": "list|show maps|multipaths topology",
                        "lines": 2
                    },
                    {
                        "name": "list|show topology",
                        "lines": 2
                    },
                    {
                        "name": "list|show map|multipath $map topology",
                        "lines": 3
                    },
                    {
                        "name": "list|show wildcards",
                        "lines": 2
                    },
                    {
                        "name": "list|show config",
                        "lines": 3
                    },
                    {
                        "name": "list|show config local",
                        "lines": 3
                    },
                    {
                        "name": "list|show blacklist",
                        "lines": 3
                    },
                    {
                        "name": "list|show devices",
                        "lines": 3
                    },
                    {
                        "name": "list|show status",
                        "lines": 3
                    },
                    {
                        "name": "list|show daemon",
                        "lines": 2
                    },
                    {
                        "name": "add path $path",
                        "lines": 3
                    },
                    {
                        "name": "remove|del path $path",
                        "lines": 2
                    },
                    {
                        "name": "add map|multipath $map",
                        "lines": 5
                    },
                    {
                        "name": "remove|del map|multipath $map",
                        "lines": 2
                    },
                    {
                        "name": "resize map|multipath $map",
                        "lines": 2
                    },
                    {
                        "name": "switch|switchgroup map|multipath $map group $group",
                        "lines": 3
                    },
                    {
                        "name": "reconfigure",
                        "lines": 3
                    },
                    {
                        "name": "reconfigure all",
                        "lines": 3
                    },
                    {
                        "name": "suspend map|multipath $map",
                        "lines": 2
                    },
                    {
                        "name": "resume map|multipath $map",
                        "lines": 2
                    },
                    {
                        "name": "reset map|multipath $map",
                        "lines": 3
                    },
                    {
                        "name": "reload map|multipath $map",
                        "lines": 2
                    },
                    {
                        "name": "fail path $path",
                        "lines": 2
                    },
                    {
                        "name": "reinstate path $path",
                        "lines": 2
                    },
                    {
                        "name": "disablequeueing maps|multipaths",
                        "lines": 2
                    },
                    {
                        "name": "restorequeueing maps|multipaths",
                        "lines": 2
                    },
                    {
                        "name": "disablequeueing map|multipath $map",
                        "lines": 2
                    },
                    {
                        "name": "restorequeueing map|multipath $map",
                        "lines": 2
                    },
                    {
                        "name": "forcequeueing daemon",
                        "lines": 3
                    },
                    {
                        "name": "restorequeueing daemon",
                        "lines": 2
                    },
                    {
                        "name": "map|multipath $map setprstatus",
                        "lines": 2
                    },
                    {
                        "name": "map|multipath $map unsetprstatus",
                        "lines": 2
                    },
                    {
                        "name": "map|multipath $map getprstatus",
                        "lines": 2
                    },
                    {
                        "name": "map|multipath $map getprkey",
                        "lines": 2
                    },
                    {
                        "name": "map|multipath $map setprkey key $key",
                        "lines": 4
                    },
                    {
                        "name": "map|multipath $map unsetprkey",
                        "lines": 4
                    },
                    {
                        "name": "path $path setmarginal",
                        "lines": 5
                    },
                    {
                        "name": "path $path unsetmarginal",
                        "lines": 4
                    },
                    {
                        "name": "map $map unsetmarginal",
                        "lines": 4
                    },
                    {
                        "name": "quit|exit",
                        "lines": 2
                    },
                    {
                        "name": "shutdown",
                        "lines": 2
                    }
                ]
            },
            {
                "name": "SYSTEMD INTEGRATION",
                "lines": 7,
                "subsections": [
                    {
                        "name": "WatchdogSec=",
                        "lines": 7
                    },
                    {
                        "name": "OOMScoreAdjust=",
                        "lines": 2
                    },
                    {
                        "name": "LimitNOFILE=",
                        "lines": 2
                    }
                ]
            },
            {
                "name": "SEE ALSO",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "AUTHORS",
                "lines": 6,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "multipathd - Multipath daemon.\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "multipathd [-d|-k] [-s] [-v verbosity] [-B] [-w]\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "The  multipathd  daemon is in charge of checking for failed paths. When this happens, it will\nreconfigure the multipath map the path belongs to, so that this map regains its maximum  per‐\nformance and redundancy.\n\nThis  daemon  executes the external multipath tool when events occur.  In turn, the multipath\ntool signals the multipathd daemon when it is done with devmap reconfiguration,  so  that  it\ncan refresh its failed path list.\n",
                "subsections": []
            },
            "OPTIONS": {
                "content": "",
                "subsections": [
                    {
                        "name": "-d",
                        "content": "",
                        "flag": "-d"
                    },
                    {
                        "name": "-s",
                        "content": "",
                        "flag": "-s"
                    },
                    {
                        "name": "-v",
                        "content": "Verbosity  level.  Print additional information while running multipathd. A level of 0\nmeans only print errors. A level of 3 or greater prints debugging information as well.\n",
                        "flag": "-v"
                    },
                    {
                        "name": "-B",
                        "content": "file. If a userfriendlyname doesn't already exist for a device, it will use its WWID\nas its alias.\n",
                        "flag": "-B"
                    },
                    {
                        "name": "-k",
                        "content": "viewed  by  entering  'help'. When you are finished entering commands, press CTRL-D to\nquit.\n",
                        "flag": "-k"
                    },
                    {
                        "name": "-n",
                        "content": "vices by multipathd. See multipath.conf(5).\n",
                        "flag": "-n"
                    },
                    {
                        "name": "-w",
                        "content": "multipath devices on dmevents. Use this flag to force it to use the old event  waiting\nmethod, based on creating a seperate thread for each device.\n",
                        "flag": "-w"
                    }
                ]
            },
            "COMMANDS": {
                "content": "The following commands can be used in interactive mode:\n",
                "subsections": [
                    {
                        "name": "list|show paths",
                        "content": "Show the paths that multipathd is monitoring, and their state.\n"
                    },
                    {
                        "name": "list|show paths format $format",
                        "content": "Show  the  paths that multipathd is monitoring, using a format string with path format\nwildcards.\n"
                    },
                    {
                        "name": "list|show maps|multipaths",
                        "content": "Show the multipath devices that the multipathd is monitoring.\n"
                    },
                    {
                        "name": "list|show maps|multipaths format $format",
                        "content": "Show the status of all multipath devices that the multipathd is  monitoring,  using  a\nformat string with multipath format wildcards.\n"
                    },
                    {
                        "name": "list|show maps|multipaths status",
                        "content": "Show the status of all multipath devices that the multipathd is monitoring.\n"
                    },
                    {
                        "name": "list|show maps|multipaths stats",
                        "content": "Show some statistics of all multipath devices that the multipathd is monitoring.\n"
                    },
                    {
                        "name": "list|show maps|multipaths topology",
                        "content": "Show the current multipath topology. Same as 'multipath -ll'.\n"
                    },
                    {
                        "name": "list|show topology",
                        "content": "Show the current multipath topology. Same as 'multipath -ll'.\n"
                    },
                    {
                        "name": "list|show map|multipath $map topology",
                        "content": "Show   topology   of  a  single  multipath  device  specified  by  $map,  for  example\n36005076303ffc56200000000000010aa. This map could be obtained from 'list maps'.\n"
                    },
                    {
                        "name": "list|show wildcards",
                        "content": "Show the format wildcards used in interactive commands taking $format.\n"
                    },
                    {
                        "name": "list|show config",
                        "content": "Show the currently used configuration, derived from default values and  values  speci‐\nfied within the configuration file /etc/multipath.conf.\n"
                    },
                    {
                        "name": "list|show config local",
                        "content": "Show  the currently used configuration like show config, but limiting the devices sec‐\ntion to those devices that are actually present in the system.\n"
                    },
                    {
                        "name": "list|show blacklist",
                        "content": "Show the currently used blacklist rules, derived from default values and values speci‐\nfied within the configuration file /etc/multipath.conf.\n"
                    },
                    {
                        "name": "list|show devices",
                        "content": "Show  all available block devices by name including the information if they are black‐\nlisted or not.\n"
                    },
                    {
                        "name": "list|show status",
                        "content": "Show the number of path checkers in each  possible  state,  the  number  of  monitored\npaths, and whether multipathd is currently handling a uevent.\n"
                    },
                    {
                        "name": "list|show daemon",
                        "content": "Show the current state of the multipathd daemon.\n"
                    },
                    {
                        "name": "add path $path",
                        "content": "Add  a  path  to  the  list of monitored paths. $path is as listed in /sys/block (e.g.\nsda).\n"
                    },
                    {
                        "name": "remove|del path $path",
                        "content": "Stop monitoring a path. $path is as listed in /sys/block (e.g. sda).\n"
                    },
                    {
                        "name": "add map|multipath $map",
                        "content": "Add a multipath device to the list of monitored devices. $map can either be a  device-\nmapper  device as listed in /sys/block (e.g. dm-0) or it can be the alias for the mul‐\ntipath  device  (e.g.  mpath1)  or   the   uid   of   the   multipath   device   (e.g.\n36005076303ffc56200000000000010aa).\n"
                    },
                    {
                        "name": "remove|del map|multipath $map",
                        "content": "Stop monitoring a multipath device.\n"
                    },
                    {
                        "name": "resize map|multipath $map",
                        "content": "Resizes map $map to the given size.\n"
                    },
                    {
                        "name": "switch|switchgroup map|multipath $map group $group",
                        "content": "Force  a multipath device to switch to a specific path group. $group is the path group\nindex, starting with 1.\n"
                    },
                    {
                        "name": "reconfigure",
                        "content": "Rereads the configuration, and reloads all changed multipath devices. This  also  hap‐\npens at startup, when the service is reload, or when a SIGHUP is received.\n"
                    },
                    {
                        "name": "reconfigure all",
                        "content": "Rereads  the configuration, and reloads all multipath devices regardless of whether or\nnot they have changed. This also happens when multipath -r is run.\n"
                    },
                    {
                        "name": "suspend map|multipath $map",
                        "content": "Sets map $map into suspend state.\n"
                    },
                    {
                        "name": "resume map|multipath $map",
                        "content": "Resumes map $map from suspend state.\n"
                    },
                    {
                        "name": "reset map|multipath $map",
                        "content": "Reassign existing device-mapper table(s) use the multipath device, instead of its path\ndevices.\n"
                    },
                    {
                        "name": "reload map|multipath $map",
                        "content": "Reload a multipath device.\n"
                    },
                    {
                        "name": "fail path $path",
                        "content": "Sets path $path into failed state.\n"
                    },
                    {
                        "name": "reinstate path $path",
                        "content": "Resumes path $path from failed state.\n"
                    },
                    {
                        "name": "disablequeueing maps|multipaths",
                        "content": "Disable queueing on all multipath devices.\n"
                    },
                    {
                        "name": "restorequeueing maps|multipaths",
                        "content": "Restore queueing on all multipath devices.\n"
                    },
                    {
                        "name": "disablequeueing map|multipath $map",
                        "content": "Disable queuing on multipathed map $map.\n"
                    },
                    {
                        "name": "restorequeueing map|multipath $map",
                        "content": "Restore queuing on multipahted map $map.\n"
                    },
                    {
                        "name": "forcequeueing daemon",
                        "content": "Forces  multipathd into queuewithoutdaemon mode, so that nopathretry queueing will\nnot be disabled when the daemon stops.\n"
                    },
                    {
                        "name": "restorequeueing daemon",
                        "content": "Restores configured queuewithoutdaemon mode.\n"
                    },
                    {
                        "name": "map|multipath $map setprstatus",
                        "content": "Enable persistent reservation management on $map.\n"
                    },
                    {
                        "name": "map|multipath $map unsetprstatus",
                        "content": "Disable persistent reservation management on $map.\n"
                    },
                    {
                        "name": "map|multipath $map getprstatus",
                        "content": "Get the current persistent reservation management status of $map.\n"
                    },
                    {
                        "name": "map|multipath $map getprkey",
                        "content": "Get the current persistent reservation key associated with $map.\n"
                    },
                    {
                        "name": "map|multipath $map setprkey key $key",
                        "content": "Set the persistent reservation key associated with $map to $key  in  the  prkeysfile.\nThis  key  will  only  be  used  by  multipathd  if  reservationkey is set to file in\n/etc/multipath.conf.\n"
                    },
                    {
                        "name": "map|multipath $map unsetprkey",
                        "content": "Remove the persistent reservation key associated with $map from the prkeysfile.  This\nwill  only  unset  the  key  used  by  multipathd if reservationkey is set to file in\n/etc/multipath.conf.\n"
                    },
                    {
                        "name": "path $path setmarginal",
                        "content": "move $path to a marginal pathgroup. The path will remain in the  marginal  path  group\nuntil  unsetmarginal  is called. This command will only work if marginalpathgroups is\nenabled and there is no Shaky  paths  detection  method  configured  (see  the  multi‐\npath.conf man page for details).\n"
                    },
                    {
                        "name": "path $path unsetmarginal",
                        "content": "return  marginal  path  $path  to its normal pathgroup. This command will only work if\nmarginalpathgroups is enabled and there is no Shaky paths detection method configured\n(see the multipath.conf man page for details).\n"
                    },
                    {
                        "name": "map $map unsetmarginal",
                        "content": "return  all  marginal paths in $map to their normal pathgroups. This command will only\nwork if marginalpathgroups is enabled and there is no Shaky  paths  detection  method\nconfigured (see the multipath.conf man page for details).\n"
                    },
                    {
                        "name": "quit|exit",
                        "content": "End interactive session.\n"
                    },
                    {
                        "name": "shutdown",
                        "content": "Stop multipathd.\n"
                    }
                ]
            },
            "SYSTEMD INTEGRATION": {
                "content": "When  compiled  with systemd support two systemd service files are installed, multipathd.ser‐\nvice and multipathd.socket The multipathd.socket service instructs systemd to  intercept  the\nCLI  command  socket,  so  that any call to the CLI interface will start-up the daemon if re‐\nquired.  The multipathd.service file carries the definitions for  controlling  the  multipath\ndaemon.  The  daemon  itself uses the sdnotify(3) interface to communicate with systemd. The\nfollowing unit keywords are recognized:\n",
                "subsections": [
                    {
                        "name": "WatchdogSec=",
                        "content": "Enables the internal watchdog from systemd. multipath will  send  a  notification  via\nsdnotify(3)  to  systemd to reset the watchdog. If specified the pollinginterval and\nmaxpollinginterval settings will be overridden by  the  watchdog  settings.   Please\nnote  that  systemd prior to version 207 has issues which prevent the systemd-provided\nwatchdog from working correctly. So the watchdog is not enabled per default,  but  has\nto be enabled manually by updating the multipathd.service file.\n"
                    },
                    {
                        "name": "OOMScoreAdjust=",
                        "content": "Overrides the internal OOM adjust mechanism.\n"
                    },
                    {
                        "name": "LimitNOFILE=",
                        "content": "Overrides the maxfds configuration setting.\n"
                    }
                ]
            },
            "SEE ALSO": {
                "content": "multipath(8), kpartx(8), sdnotify(3), system.service(5).\n",
                "subsections": []
            },
            "AUTHORS": {
                "content": "multipath-tools was developed by Christophe Varoqui <christophe.varoqui@opensvc.com> and oth‐\ners.\n\n\n\nLinux                                        2016-10-27                                MULTIPATHD(8)",
                "subsections": []
            }
        }
    }
}