VMware vSphere SDKs and Tools 8.0

8.0 7.0 6.7 6.5

Managing SATPs

The
esxcli storage nmp satp
 commands manage SATPs.
You can use these commands to perform the following tasks.
  • Retrieve and set configuration parameters.
  • Add and remove rules from the list of claim rules for a specified SATP.
  • Set the default PSP for a specified SATP.
  • List SATPs that are currently loaded into NMP and the associated claim rules.
The default SATP for an active-active FC array with a vendor and model not listed in the SATP rules is
VMW_SATP_DEFAULT_AA
.

Retrieving Information About SATPs

The
esxcli storage nmp satp list
 command lists the SATPs that are currently available to the NMP system and displays information about those SATPs. This command supports no options and displays information about these SATPs. 
esxcli <conn_options> storage nmp satp list
The rule list command lists the claim rules for SATPs. 
esxcli <conn_options> storage nmp satp rule list

Adding SATP Rules

Claim rules specify that a storage device that uses a certain driver or transport or has a certain vendor or model should use a certain SATP. The
esxcli storage nmp satp rule add
 command adds a rule that performs such a mapping to the list of claim rules. The options you specify define the rule. For example, the following command specifies that if a path has vendor
VMWARE
 and model
Virtual
, the PSA assigns it to the
VMW_SATP_LOCAL
 SATP. 
esxcli <conn_options> storage nmp satp rule add --satp="VMW_SATP_LOCAL" --vendor="VMWARE" --model="Virtual" --description="VMware virtual disk"
Option
Description
--driver
-D
Driver string to set when adding the SATP claim rule.
--device
-d
Device to set when adding SATP claim rules. Device rules are mutually exclusive with vendor/model and driver rules.
--force
-f
Force claim rules to ignore validity checks and install the rule even if checks fail.
--model
-M
Model string to set when adding the SATP claim rule. Can be the model name or a pattern
^mod*
, which matches all devices that start with
mod
. That is, the pattern successfully matches
mod1
 and
modz
, but not
mymod1
.
The command supports the start/end (^) and wildcard (*) functionality but no other regular expressions.
--transport
-R
Transport string to set when adding the SATP claim rule. Describes the type of storage HBA, for example,
iscsi
 or
fc
.
--vendor
-V
Vendor string to set when adding the SATP claim rule.
--satp
-s
SATP for which the rule is added.
--claim-option
-c
Claim option string to set when adding the SATP claim rule.
--description
-e
Description string to set when adding the SATP claim rule.
--option
-o
Option string to set when adding the SATP claim rule. Surround the option string in double quotes, and use a space, not a comma, when specifying more than one option. 
"enable_local enable_ssd"
--psp
-P
Default PSP for the SATP claim rule.
--psp-option
-O
PSP options for the SATP claim rule.
--type
-t
Set the claim type when adding a SATP claim rule.
The following examples illustrate adding SATP rules. Specify one of the options listed in Connection Options for ESXCLI Host Management Commands in place of
<conn_options>
.
  • Add an SATP rule that specifies that disks with vendor string
    VMWARE
     and model string
    Virtual
     should be added to
    VMW_SATP_LOCAL
    . 
    esxcli <conn_options> storage nmp satp rule add --satp="VMW_SATP_LOCAL" --vendor="VMWARE" --model="Virtual" --description="VMware virtual disk"
  • Add an SATP rule that specifies that disks with the driver string
    somedriver
     should be added to
    VMW_SATP_LOCAL
    . 
    esxcli <conn_options> storage nmp satp rule add --satp="VMW_SATP_LOCAL" --driver="somedriver"
  • Add a rule that specifies that all storage devices with vendor string
    ABC
     and a model name that starts with
    120
     should use
    VMW_SATP_DEFAULT_AA
    . 
    esxcli <conn_options> storage nmp satp rule add --satp VMW_SATP_DEFAULT_AA --vendor="ABC" --model="^120*

Removing SATP Rules

The
esxcli storage nmp satp rule remove
 command removes an existing SATP rule. The options you specify define the rule to remove. The options listed for Adding SATP Rules are supported.
The following example removes the rule that assigns devices with vendor string
VMWARE
 and model string
Virtual
 to
VMW_SATP_LOCAL
. 
esxcli <conn_options> storage nmp satp rule remove --satp="VMW_SATP_LOCAL" --vendor="VMWARE" --model="Virtual"

Retrieving and Setting SATP Configuration Parameters

The
esxcli storage nmp satp generic deviceconfig get
 and
esxcli storage nmp satp generic pathconfig get
 commands retrieve per-device or per-path SATP configuration parameters. You cannot retrieve paths or devices for all SATPs, you must retrieve the information one path or one device at a time.
Use the following command to retrieve per device or per path SATP configuration parameters, and to see whether you can set specific configuration parameters for a device or path.
For example,
esxcli storage nmp satp generic deviceconfig get --device naa.xxx
 might return
SATP VMW_SATP_LSI does not support device configuration
. 
esxcli storage nmp satp generic pathconfig get -path vmhba1:C0:T0:L8 might return INIT,AVT OFF,v5.4,DUAL ACTIVE,ESX FAILOVER
The
esxcli storage nmp satp generic deviceconfig set
 and
esxcli storage nmp satp generic pathconfig set
 commands set configuration parameters for SATPs that are loaded into the system, if they support device configuration. You can set per-path or per-device SATP configuration parameters.
The command passes the configuration string to the SATP associated with that device or path.
The configuration strings might vary by SATP. VMware supports a fixed set of configuration strings for a subset of its SATPs. The strings might change in future releases.
Options
Description
--config
-c
Configuration string to set for the path specified by
--path
 or the device specified by
--device
.
You can set the configuration for the following SATPs.
  • VMW_SATP_ALUA_CX
  • VMW_SATP_ALUA
  • VMW_SATP_CX
  • VMW_SATP_INV
You can specify one of the following device configuration strings.
  • navireg_on
     – starts automatic registration of the device with Navisphere.
  • navireg_off
     – stops the automatic registration of the device.
  • ipfilter_on
     – stops the sending of the host name for Navisphere registration. Used if host is known as
    localhost
    .
  • ipfilter_off
     – enables the sending of the host name during Navisphere registration.
--device
-d
Device to set SATP configuration for. Not all SATPs support the setconfig option on devices.
--path
-p
Path to set SATP configuration for. Not all SATPs support the setconfig option on paths.
Run
esxcli storage nmp device set --default --device=<device>
 to set the PSP for the specified device back to the default for the assigned SATP for this device.

Content feedback and comments