rmpath Command

Purpose

Removes from the system a path to an MPIO capable device.

Syntax

rmpath [ -l Name ] [ -p Parent ] [ -w Connection ] [ -i PathID ]

rmpath [ -l Name ] [ -p Parent ] [ -w Connection ] [ -d ] [ -g ]

rmpath -h

Description

The rmpath command unconfigures, and possibly undefines, one or more paths associated with the specified target device (-l Name). The set of paths that are removed are determined by the combination of the -l Name, -p Parent, and -w Connection flags. If the command will result in all paths associated with the device being unconfigured or undefined, the command will exit with an error and without unconfiguring or undefining any path. In this situation, rmdev command must be used instead to unconfigure or undefine the target device itself.

The default action unconfigures each specified path, but does not completely remove it from the system. If the -d flag is specified, the rmpath command unconfigures (if necessary) and removes, or deletes, the path definition(s) from the system.

When the rmpath command finishes, it displays a status message. When unconfiguring paths, it is possible for this command to be able to unconfigure some paths and not others (e.g., paths that are in the process of doing I/O cannot be unconfigured).

The rmpath command provides status messages about the results of operation. Messages in one of the following formats will be generated:
path [ defined | deleted ]
This message is displayed when a single path was successfully unconfigures or undefined. If the path is successfully configured the message path available displays. If the path is not successfully configured and there is no explicit error code returned by the method, the message path defined displays.
paths [defined | deleted]
This message is displayed if multiple paths were identified and all paths were successfully unconfigured or undefined. If the -d flag is not specified, the message would be paths defined. If the -d flag is specified, the message would be paths deleted.
some paths [ defined | deleted ]
This message is display if multiple paths were identified, but only some of them were successfully unconfigured or undefined. If the -d flag is not specified, the message would be some paths defined. If the '-d flag is specified, the message would be some paths deleted.
no paths processed
This message is generated if no paths were found matching the selection criteria.

Flags

Item Description
-d Indicates that the specified paths are to be deleted from the system.
-g Forces the remove path operation to run on a locked device.
-h Displays the command usage message.
-i PathID Indicates the path ID associated with the path to be removed and is used to uniquely identify a path.
-l Name Specifies the logical device name of the target device whose path is to be removed. The paths to be removed are qualified via the -p and -w flags.
-p Parent Indicates the logical device name of the parent device to use in qualifying the paths to be removed. Since all paths to a device cannot be removed by this command, either this flag, the -w flag, or both must be specified.
-w Connection Indicates the connection information to use in qualifying the paths to be removed. Since all paths to a device cannot be removed by this command, either this flag, the -p flag, or both must be specified.

Security

Privilege Control: Only the root user and members of the system group have execute access to this command.

Auditing Events:
Event Information
DEV_Change rmpath,Unconfigure,<unconfigure method arguments>
DEV_Change rmpath,Undefine,<undefine method arguments>

Examples

  1. To unconfigure the path from scsi0 to hdisk1 at connection 5,0, type:
    rmpath -l hdisk1 -p scsi0 -w "5,0"
    The message generated would be similar to:
    path defined
  2. To unconfigure all paths from scsi0 to hdisk1, type:
    rmpath -l hdisk1 -p scsi0
    If all paths were successfully unconfigured, the message generated would be similar to:
    paths defined
    However, if only some of the paths were successfully unconfigured, the message would be similar to:
    some paths defined
  3. To undefine the path definition between scsi0 and hdisk1 at connection 5,0, type:
    rmpath -d -l hdisk1 -p scsi0 -w "5,0"
    The message generated would be similar to the following:
    path deleted
  4. To unconfigure all paths from scsi0 to hdisk1, type:
    rmpath -d -l hdisk1 -p scsi0
    The message generated would be similar to:
    paths deleted

Files

Item Description
/usr/sbin/rmpath Contains the rmpath command.