Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

srptadm(8)

Name

srptadm - administer SRP targets

Synopsis

srptadm modify-target [-e, --enable] [-d, --disable]
     [-r, --reset] hca_guid
srptadm list-target [hca_guid]
srptadm modify-defaults [-e, --enable] [-d, --disable]
srptadm list-defaults

Description

The srptadm command manages SCSI RDMA Protocol (SRP) target ports within the SCSI Target Mode Framework described in stmfadm(8) and libstmf(3LIB). This allows SRP initiators to access SCSI Target Mode Framework (STMF) logical units using the SRP protocol.

srptadm is implemented as a set of subcommands with options and operands for each subcommand. These subcommands are described in their own section, below.

Sub Commands

list-defaults

Lists information about the default properties. This subcommand has no options.

list-target [hca_guid]

If hca_guid is specified, lists the properties of the target HCA. Otherwise, properties are listed for all HCAs.

modify-defaults [–e, –-enable] [–d, –-disable]

Modify default parameters.

–e, –-enable

Enable SRP target creation for all HCAs that have not been explicitly disabled with modify-target.

–d, –-disable

Disable SRP target creation for all HCAs that have not been explicitly enabled with modify-target.

modify-target [–e, –-enable] [–d, –-disable] [–r, –-reset hca_guid

Sets SRP Target properties for the specified HCA.

–e, –-enable

Enables SRP target creation on this HCA.

–d, –-disable

Disables SRP target creation on this HCA.

–r, –-reset

Clears HCA-specific information and resets to defaults. The SRP Target, if any, associated with this HCA will not be modified as a result of this option until the SRP Target SMF service is restarted.

Operands

The list-target and modify-target subcommands have the following operand.

hca_guid

GUID of the InfiniBand Host Channel Adapter (HCA) on this system for which SRP Target Services can be provided. The GUID must be in one of the following forms:

3BA000100CD18

Base hex form.

0003BA000100CD18

Base hex form with leading zeroes.

hca:3BA000100CD18

Form from cfgadm(8).

eui.0003BA000100CD18

EUI form.

Usage

If the default state is changed when the SRP service is online, the state of existing targets is not changed until the service is restarted.

Changing the target state takes effect immediately if the SRP target service is online. Targets set to disabled will be offlined and removed; targets set to enabled will be immediately created.

Examples

Example 1 Listing Default Properties

The following command lists the default SRP Target Service properties.

# srptadm list-defaults
Example 2 Changing Default Behavior

The following command changes the default behavior of the SRP Target service to not create SRP Targets when the service is enabled.

# srptadm modify-defaults -d
Example 3 Listing Properties for Specific HCA

The following command lists SRP Target properties for a specific HCA.

# cfgadm | grep hca
hca:3BA000100CD18              IB-HCA       connected    configured   ok
hca:3BA000100D030              IB-HCA       connected    configured   ok

# srptadm list-target hca:3BA000100CD18
Target HCA 3BA000100CD18:
    Enabled             : true
    SRP Target Name     : eui.0003BA000100CD18
    Operational Status  : online
Example 4 Disabling Services for Specific HCA

The following command disables SRP Target services for a specific HCA.

# srptadm modify-target -d 3BA000100CD18

Use the list-target command to see the changes:

# srptadm list-target hca:3BA000100CD18
Target HCA 3BA000100CD18:
    Enabled             : false
    SRP Target Name     : eui.0003BA000100CD18
    Operational Status  : -
Example 5 Re-enabling Target Services

The following command sequence re-enables SRP Target services and displays the SRP and STMF target properties.

# srptadm modify-target -e 3BA000100CD18
# srptadm list-target hca:3BA000100CD18
Target HCA 3BA000100CD18:
    Enabled             : true
    SRP Target Name     : eui.0003BA000100CD18
    Operational Status  : online

# stmfadm list-target -v eui.0003BA000100CD18
Target: eui.0003BA000100CD18
    Operational Status: Online
    Provider Name     : srpt
    Alias             : -
    Protocol          : SRP
    Sessions          : 0

Attributes

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
system/storage/scsi-rdma/scsi-rdma-target
Interface Stability
Committed

See Also

libsrpt(3LIB), libstmf(3LIB), srpt(4D), attributes(7), cfgadm(8), stmfadm(8)