About the enclosure discovery command output

This section provides the details of the data that each discovery command should discover, and the format in which the data should be listed.

Each command prints the records of the discovered objects. For example, --list pdev lists each physical disk in the enclosure as a separate record. A record displays its attributes, and the values of the attribute.

Record 1

Attribute 1 : Value 1

Attribute 2 : Value 2

Attribute 3 : Value 3

Attribute N : Value N

Record 2

Attribute 1 : Value 1

Attribute 2 : Value 2

Attribute 3 : Value 3

Attribute N : Value N

Record N

Attribute 1 : Value 1

Attribute 2 : Value 2

Attribute 3 : Value 3

Attribute N : Value N

Each attribute with its value, must be on a different line. The attribute and its value should be separated by a colon (:). If you do not know the value for an attribute, you can specify it as "-".

The order of attributes within a record is not relevant. The record identifier attribute must be the first one to be listed for each record. For more information, refer to the command output files for Dell Compellent Storage Insight plug-in sample. It is stored on the managed host:

/opt/VRTSsfmh/etc/SISdk/samples/compellent/compellent_data.tar.gz

For the complete list of commands and attributes, refer to the specific command section.

--list encls command to discover all enclosures

The --list encls command should list all enclosures. Each enclosure should be listed as a record that starts with its record identifier attribute Id.

Table: --list encls

Attribute

Description

Data Type

Comments

Id

Globally unique identifier of the enclosure.

String

It should match with the identifier that is obtained from the SCSI pages via the enclosure identifier formula specified during the Storage Insight plug-in creation.

Name

Name for the enclosure instance.

String

 

SerialNo

Serial Number of the enclosure.

String

 

FirmwareVersion

Firmware version of the enclosure.

String

 

Vendor

Vendor name of the enclosure.

String

For example, the vendor for the EMC Symmetrix enclosure is EMC.

Product

The name of product.

String

For example, for EMC Symmetrix array, the product name is Symmetrix.

Model

Model of the product.

String

For example, for EMC Symmetrix array, the models are DMX and VMAX.

IPAddress

The IP address of the enclosure.

String

 

AutoComputeCaps

Indicates if Storage Insight plug-in agentlet should automatically compute the aggregate capacities in the waterfall chart using the objects that are discovered by other discovery commands

Boolean

The expected values are 1 or 0.

Specify 1 to enable auto compute for aggregate capacities.

If it is 0, it is expected that -list capacities command is implemented.

AltId

Optional alternate unique identifier for the enclosure. It should be globally unique.

String

It is an optional argument. It is useful while identifying a remote enclosure which is the target for the replication.

--list pdevs --encl enclosure Id command to discover all physical disks in an enclosure

The --list pdevs --encl enclosure Id command should list all physical disks in the enclosure specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each physical disk should be listed as a record that starts with the record identifier attribute Id

Table: --list pdevs --encl enclosure Id

Attribute

Description

Data type

Comments

Id

Globally unique identifier for the physical disk.

String

One way to construct the identifier is by using the combination of physical disk name and enclosure identifier.

Name

Name of the physical disk.

String

 

PhysicalSize

Total raw size of the physical disk.

Decimal

Specified in megabytes.

AvailableSize

Portion of the physical size that is free, or available.

Decimal

Specified in megabytes.

SpareSize

Portion of the physical size that is used as spare size (used for internal housekeeping) in the enclosure.

Decimal

Specified in megabytes.

Shared

Indicates if the physical disk is a part of multiple physical groups such as RAID groups.

Boolean

Expected value is 1 if the physical disk is shared, 0 if not shared.

RPM

RPM of the physical disk.

Integer

 

State

State of the physical disk. Indicates if the disk is healthy.

Integer

Expected value is 0 if the physical disk is healthy, and 1 if it is not healthy.

MediaType

Media type of the physical disk.

String

Expected values are one of the following:

HDD and SSD

VendorMediaType

Additional classification for the media type.

String

Allowed values are SED, FC, SATA, BD, SAS, NL-SAS, and SAS (SED).

--list ldevs --encl enclosure Id command to discover all logical disks for an enclosure

The --list ldevs --encl enclosure Id command should list all logical disks in the enclosure specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by -list encls command.

Each logical disk should be listed as a record that starts with the record identifier attribute Id.

Table: --list ldevs --encl enclosure Id

Attribute

Description

Data type

Comments

Id

Globally unique identifier for the logical disk.

String

This identifier should match the identifier obtained from the SCSI pages by logical disk identifier formula specified during the Storage Insight plug-in creation.

Name

Name of the logical disk.

String

 

LogicalSize

Logical size of the logical disk.

Decimal

Specified in megabytes. For thin logical disks, it should be the subscribed size, and not the consumed size.

RawSize

Raw physical storage assigned to the logical disk.

Decimal

Specified in megabytes.

Thin

Indicates if the logical disk is thin.

Boolean

Expected value is 1 if the logical disk is thin, and 0 for thick disk.

ThinConsumedSize

Logical consumed size of a thin logical disk.

Decimal

Specified in megabytes. Applicable only if the logical disk is thin. For a thin logical disk, this is consumed logical size, and not the subscribed size.

ThinConsumedRawSize

Raw physical storage consumed by a thin logical disk.

Decimal

Specified in megabytes. This capacity is applicable only to a thin logical disk. It is the raw physical storage that is consumed by the logical disk. The physical storage capacity that corresponds to the logical storage is represented by ThinConsumedSize.

RaidLevel

RAID level of the logical disk.

String

For example, RAID 5.

Layout

Vendor-specific layout for the logical disk.

String

 

Assigned

Indicates if the logical disk is assigned to a host, or any front-end array.

Boolean

Expected value is 1 if the logical disk is assigned, and 0 if it is not assigned.

Virtual

Indicates if the logical disk is a pass through from any back-end array.

Boolean

Expected value is 1 if the logical disk is virtual, and 0 if it is not virtual.

Administrative

Indicates if the logical disk is used for administrative purposes.

Boolean

Expected value is 1 if the logical disk is administrative, and 0 if it is not administrative.

FaultTolerant

Indicates if the logical disk is fault tolerant. That is, if it is protected by RAID.

Boolean

Expected value is 1 if the logical disk is fault tolerant, and 0 if it is not fault tolerant.

AltId

Optional alternate unique identifier for the logical device. It should be globally unique.

String

Optional argument; useful while identifying the target of a remotely replicated logical device.

Refer --list-replications command for more information.

--list adapters --encl enclosure Id command to discover all adapters of an enclosure

The --list adapters --encl enclosure Id command should list all adapters in the enclosure specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each adapter should be listed as a record that starts with the record identifier attribute Id.

Table: --list adapters --encl enclosure Id

Attribute

Description

Data type

Comments

Id

Globally unique identifier for the adapter.

String

 

Name

Name of the adapter.

String

 

Type

The type of adapter.

String

Expected values are FC, iSCSI, SAS and FCoE.

--list ports --encl enclosure Id command to discover all ports for an enclosure

The --list ports --encl enclosure Id command should list all the ports in the enclosure specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each port should be listed as a record that starts with the record identifier attribute Id.

Table: --list ports --encl enclosure Id

Attribute

Description

Data type

Comments

Id

Globally unique identifier for the port.

String

It is typically the World Wide Port Name (WWPN) of the port.

Name

Name of the port.

String

 

Type

The type of the port.

String

Allowed values are FC, iSCSI, SAS and FCoE.

WWPN

WWPN of the port.

String

 

WWNN

WWNN of the port.

String

 

AdapterId

Identifier of the port's adapter on the enclosure.

String

 

State

State of the port.

Boolean

Expected value is 0 if the port is up, and 1 otherwise.

--list capacities --encl enclosure Id command to discover aggregate physical, RAID group, and logical capacities for an enclosure

The --list capacities --encl enclosure Id command should list aggregate physical, RAID group, and logical capacities of the enclosure specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by the -list encls command. These capacities are displayed on the waterfall chart in the enclosure overview page of Veritas Operations Manager console.

This command expects a single record that lists all the capacity values as described below:

Table: --list capacities --encl enclosure Id

Attribute

Description

Data type

Comments

Id

Globally unique identifier for the enclosure.

String

It is the record identifier.

PhySize

Total raw physical storage present in the enclosure.

Decimal

Specified in megabytes.

PhyConfigSize

Total raw physical storage in the enclosure that is configured. This is the capacity that is either allocated to some type of array group like RAID group, or thin pool, or it is directly assigned to logical disks.

Decimal

Specified in megabytes.

PhySpareSize

Total physical storage size that is used for internal housekeeping.

Decimal

Specified in megabytes.

PhyUnConfigSize

Total physical storage that is not configured. It should not include the spare capacity.

Decimal

Specified in megabytes.

RGSize

Total logical size of all RAID groups in the enclosure.

Decimal

Specified in megabytes.

Applicable only if the array is RAID group capable.

RGFreeSize

Total logical size of all RAID groups in the enclosure that is free, and not yet carved out into the logical disks.

Decimal

Specified in megabytes.

Applicable only if the array is RAID group capable.

RGAddrSize

Total logical addressable size of all RAID groups in the enclosure. That is, the logical size of RAID groups that is carved out into the logical disks.

Decimal

Specified in megabytes.

Applicable only if the array is RAID group capable.

RGOverheadSize

Total overhead size of all RAID groups in the enclosure.

Decimal

Specified in megabytes.

Applicable only if the array is RAID group capable.

LogicalSize

Total logical storage size in the enclosure.

Decimal

Specified in megabytes.

Applicable only if the array is RAID group capable

LogicalAssignedSize

Total logical storage in the enclosure that is assigned to hosts, or any front-end array.

Decimal

Specified in megabytes.

LogicalUnassignedSize

Total logical storage in the enclosure that is not assigned to hosts, or any front-end array.

Decimal

Specified in megabytes.

LogicalAdminSize

Total logical storage in the enclosure that is used for the administrative purpose.

Decimal

Specified in megabytes.

LogicalRepTargetSize

Total logical storage in the enclosure that is used as replication target.

Decimal

Specified in megabytes.

--list ldevpdevmap --encl enclosure Id command to discover logical disk-physical disk mapping for an enclosure

The --list ldevpdevmap --encl enclosure Id command should list the physical disks whose storage is consumed by logical disks in the enclosure that is specified by -encl argument. enclosure Id is the identifier for enclosure as reported by the -list encls command.

Each record should list the logical disk, and the corresponding physical disk it gets the storage from. If a logical disk consumes storage from multiple physical disks, there are multiple records for the same logical disk. The attribute Id is the record identifier.

Table: --list ldevpdevmap --encl enclosure Id

Attribute

Description

Data type

Ldev

Globally unique identifier of the logical disk.

String

Pdev

Globally unique identifier of the corresponding physical disk.

String

--list ldevhostmap --encl enclosure Id command to discover logical device-host mapping for an enclosure

The --list ldevhostmap --encl enclosure Id command should list the masking information for logical disks in the enclosure that is specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each record should list the masking information as described below:

Table: --list ldevhostmap --encl enclosure Id

Attribute

Description

Data type

Comments

Id

Globally unique identifier of the logical disk.

String

 

HbaPortWWPN

World Wide Port Name (WWPN) of the HBA port to which the logical disk is mapped.

String

 

ArrayPortWWPN

World Wide Port Name (WWPN) of the array port to which the logical disk is mapped.

String

 

LunId

SCSI LunId of the logical disk in context with the array port.

String

LunId should be listed as hexadecimal number in upper case. For example, 3C.

--list meta-ldevs --encl enclosure Id command to discover the mapping of meta logical disks with segment logical disks for an enclosure

The --list meta-ldevs --encl enclosure Id command should list the mapping of meta logical disks with the corresponding segment logical disks in the enclosure that is specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each record should list this mapping information as described below:

Table: --list meta-ldevs --encl enclosure Id

Attribute

Description

Data type

Id

Globally unique identifier of the meta logical disk.

String

SegmentId

Globally unique identifier of the segment logical disk.

String

--list raidgroups --encl enclosure Id command to discover RAID groups for an enclosure

The --list raidgroups --encl enclosure Id command should list all RAID groups in the enclosure that is specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each RAID group should be listed as a record that starts with the record identifier attribute Id. The RAID group information is described below:

Table: --list raidgroups --encl enclosure Id

Attribute

Description

Data type

Comments

Id

Globally unique identifier for the RAID group.

String

 

Name

Name of the RAID group.

String

 

State

State of the RAID group.

Integer

Its value is zero if the RAID group is healthy, and 1 otherwise.

PdevCount

Total number of physical disks that create the RAID group.

Integer

 

RawSize

Total raw physical size of the RAID group.

Decimal

Specified in megabytes.

OverheadSize

RAID overhead that is introduced by the RAID group.

Decimal

Specified in megabytes.

LogicalSize

Total logical size of the RAID group.

Decimal

Specified in megabytes.

LogicalSize = RawSize - OverheadSize

LogicalUsedSize

Total logical size that is already carved out as logical disks.

Decimal

Specified in megabytes.

LogicalFreeSize

Total Logical size that is not yet carved out as logical disks.

Decimal

Specified in megabytes.

LogicalFreeSize = LogicalSize - LogicalUsedSize

RaidLevel

RAID level of the RAID group.

String

For example, RAID 5 (6D+1P) and RAID 0.

--list thinpools --encl enclosure Id command to discover all thin pools for an enclosure

The --list thinpools --encl enclosure Id command should list all thin pools in the enclosure that is specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each thin pool should be listed as a record that starts with the record identifier attribute Id. The thin pool information is described below:

Table: --list thinpools --encl enclosure Id

Attribute

Description

Data type

Comments

Id

Globally unique identifier for the thin pool.

String

 

Name

Name of the thin pool.

String

 

State

State of the thin pool.

Integer

Its value is zero if the thin pool is healthy, and 1 otherwise.

SourceDevCount

Total number of source physical disks or logical disks that create the thin pool. These devices are the source of storage capacity of thin pool, and not the actual logical disks carved out of the thin pool.

Integer

 

VolumeCount

Total number of thin logical disks that are carved out of the thin pool.

Integer

 

RawSize

Total raw physical size of the thin pool.

Decimal

Specified in megabytes.

OverheadSize

RAID overhead that is introduced by the thin pool.

Decimal

Specified in megabytes.

LogicalSize

Total logical size of the thin pool.

Decimal

Specified in megabytes.

LogicalSize = RawSize - OverheadSize

LogicalUsedSize

Total logical size that is already carved out as logical disks.

Decimal

Specified in megabytes.

LogicalFreeSize

Total Logical size that is not yet carved out as logical disks.

Decimal

Specified in megabytes.

LogicalFreeSize = LogicalSize - LogicalUsedSize

RaidLevel

RAID level of the thin pool if applicable.

String

For example, RAID 5 (6D+1P) and RAID 0.

SubscribedSize

Subscribed size of the thin pool.

Decimal

Total subscribed logical size of the thin pool. It is the sum of subscribed sizes of all thin logical disks carved out of the thin pool.

--list rgpdevmap --encl enclosure Id command to discover RAID group-physical disk mapping for an enclosure

The --list rgpdevmap --encl enclosure Id command should list the mapping of RAID groups and the physical disks that constitute the RAID group in the enclosure that is specified by -encl argument. enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each record lists the mapping information as described below:

Table: --list rgpdevmap --encl enclosure Id

Attribute

Description

Data type

Rg

Globally unique identifier for the RAID group.

String

Pdev

Globally unique identifier for the physical disk.

String

--list rgldevmap --encl enclosure Id command to discover RAID group-logical device mapping for an enclosure

The --list rgldevmap --encl enclosure Id command should list the mapping of RAID groups and the logical disks that are carved out of the RAID group in the enclosure that is specified by -encl argument.

enclosure Id is the identifier for the enclosure as reported by the -list encls command. Each record lists the mapping information as described below:

Table: --list rgldevmap --encl enclosure Id

Attribute

Description

Data type

Rg

Globally unique identifier for the RAID group.

String

Ldev

Globally unique identifier for the logical disk.

String

--list tpsrcldevmap --encl enclosure Id command to discover thin pool-source logical device mapping for an enclosure

The --list tpsrcldevmap --encl enclosure Id command should list the mapping of thin pools, and the source logical disks that make up the thin pool in the enclosure that is specified by -encl argument.

enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Note:

The logical disks are the source of storage capacity of thin pool, and not the actual logical disks carved out of the thin pool. This command is applicable to arrays whose thin pools are backed by thick logical disks (not physical disks).

Each record lists the mapping information as described below:

Table: --list tpsrcldevmap --encl enclosure Id

Attribute

Description

Data type

Tp

Globally unique identifier of the thin pool.

String

Ldev

Globally unique identifier of the source logical disk.

String

--list tpldevmap --encl enclosure Id command to discover thin pool logical device mapping for an enclosure

The --list tpldevmap --encl enclosure Id command should list the mapping of thin pools, and the source disks that are carved out of the thin pool in the enclosure that is specified by -encl argument.

enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each record lists the mapping information as described below:

Table: --list tpldevmap --encl enclosure Id

Attribute

Description

Data type

Tp

Globally unique identifier of the thin pool.

String

Ldev

Globally unique identifier of the thin logical disk.

String

--list replications --encl enclosure Id command to discover the replications for an enclosure

The --list replications --encl enclosure Id command should list the information about replications in the enclosure that is specified by -encl argument.

enclosure Id is the identifier for the enclosure as reported by the -list encls command.

Each replication should be listed as a record that starts with record identifier attribute Id. For a replication source-target pair, single record should be reported.

Each record lists the mapping information as described below:

Table: --list replications --encl enclosure Id

Attribute

Description

Data type

Comments

Id

Globally unique identifier of the replication source or target logical disk.

String

 

Designation

It indicates if the logical disk that is specified by Id attribute is the source or target of the replication.

Integer

Its value is 0 if the Id is replication source, and 1 if it is the replication target.

PartnerId

Globally unique identifier for the replication target if Id refers to the replication source.

And, it is the globally unique identifier for replication source, if Id refers to the replication target.

String

 

PartnerName

Name of the logical disk that corresponds to PartnerId.

String

 

AcrossEncls

Specifies if the replication is across enclosures. That is, either source, or target is present in a different enclosure.

Boolean

Its value is 0 if the replication is local, and 1 if the replication is remote.

RemoteEnclId

Globally unique identifier for the remote enclosure. It is applicable only to remote replication.

String

RemoteEnclId is optional if all three attributes RemoteEnclName, RemoteEnclVendor and RemoteEnclModel are specified.

RemoteEnclName

Name of the remote enclosure. It is applicable only to remote replication.

String

 

RemoteEnclVendor

Vendor name of the remote enclosure. It is applicable only to remote replication.

String

If replication is remote and remote enclosure's vendor is not specified, it is assumed to be the same as that of the local enclosure (referred by enclosure Id).

RemoteEnclModel

Product name of the remote enclosure. It is applicable only to remote replication.

String

If replication is remote and remote enclosure's product is not specified, it is assumed to be the same as that of the local enclosure. (referred by enclosure Id).

RepMode

Mode of replication - Sync or Async.

String

Expected values are Sync for synchronous replication, and Async for asynchronous replication.

RepType

Type of replication.

String

For example, Snapshot, Clone, or Mirror.

RepState

State of replication.

String

Expected values are:

Split, Synchronized, CopyOnWrite, Copied, Inactive, ReverseSynchronizing, ReverseOutofSync, Synchronizing, OutofSync, Consistent, Active, Suspended, FailedOver, Initialization, Unsynchronized, Partitioned, PreCopy, CopyInProgress, CopyOnAccess

AccessMode

Access mode of the replication target.

String

Expected values are:

Rdonly: If the replication target access mode is read-only.

Rdwrite: If the replication target access mode is read-write.

PartnerAltId

Alternate globally unique identifier for the replication target logical device. It should match the AltId field reported for the target logical device.

String

Optional. It is useful when neither PartnerId nor PartnerName are known while discovering the replications from the source enclosure.

If either PartnerId or PartnerName are specified, this field should not be specified.

RemoteEnclAltId

Alternate globally unique identifier for the remote enclosure. It should match the AltId property specified for the target enclosure.

String

Optional. It is useful when neither RemoteEnclName nor RemoteEnclId are known while discovering the replications from the source enclosure.

If either RemoteEnclName and RemoteEnclId are specified, this field should not be specified.

More Information

About Storage Insight SDK Add-on