Operation: get-storage-system

Home  Previous  Next

The get-storage-system operation lets the administrators list the available disk arrays and virtualization controllers visible through the EMC SMI-S Provider. The operation also provides useful information about each storage system, including the model and serial number, as well as its overall capacity (total, consumed and available).

The get-storage-system operation is a prerequisite operation before allocating or deleting storage as such operations require the name of the storage system where the action is supposed to take place.

Adapter Request Elements for 'get-storage-system' Operation

 

Definition

Required

operation-name

Specifies the name of the operation you want to perform.

Valid value: get-storage-system.

Yes

arguments

Parent element for <argument> element.

Yes

argument

Specifies a list of arguments that is required for this operation

Yes

target

Specifies the connection information for an EMC SMI-S Provider.

Valid value: The value specified for <target> element must be same as the value that has been specified for the name attribute of <config> element in the adapter configuration. You can skip this element. In this case the request will be executed on the first defined adapter configuration. You can leave this element empty. In this case the request will be executed on the first defined adapter configuration.
Default value: The first defined adapter configuration.

No

timeout-secs

Specifies the time in seconds after which the attempt to connect to the EMC SMI-S Provider times out. The "timeout-secs" specified in adapter request overrides the value specified in adapter configuration.

Valid value: A numeric value which specifies the time in seconds.
Default value: 180, if no "timeout-secs" is provided in adapter configuration.

No

You can specify the following element to retrieve specific information. If this element is not specified, then all the details are fetched.

storage-system-name

Specifies the user defined storage system name.

Valid value: Any valid string.
Default value: None.

No

Sample Adapter Request for 'get-storage-system' Operation

<emc-storage-request>

  <operation-name>get-storage-system</operation-name>

  <arguments>

    <argument>

      <storage-system-name/>

    </argument>

  </arguments>

</emc-storage-request>

Adapter Response Elements for 'get-storage-system' Operation

 

Description

storage-system-name

Name of the storage system.

model

Model of the storage system.

serial-number

Number identifying the storage system.

size-bytes

Size of the storage system in bytes.

size-gigabytes

Size of the storage system in gigabytes.

available-capacity-bytes

Number of bytes available in the storage system.

subscribed-capacity-bytes

Total host visible capacity in bytes.

subscribed-capacity-gigabytes

Total host visible capacity in gigabytes.

operational-status

Operational status of the storage system.

operational-status-description

Detailed information about the operational status of the storage system.

Sample Adapter Response for 'get-storage-system' Operation

<emc-storage-response>

  <metadata>

    <status>success</status>

    <response-count>1</response-count>

  </metadata>

  <responses>

    <response>

      <metadata>

        <status>success</status>

        <execution-milliseconds>1856</execution-milliseconds>

        <line-count>22</line-count>

        <storage-system-count>2</storage-system-count>

        <target>locke-2</target>

        <config-name>default</config-name>

      </metadata>

      <output>

        <storage-systems>

          <storage-system>

            <storage-system-name>CLARiiON+CKM00083900053</storage-system-name>

            <model>Rack Mounted CX4_120</model>

            <serial-number>CKM00083900053</serial-number>

            <size-bytes>1435374714880</size-bytes>

            <size-gigabytes>1336.797</size-gigabytes>

            <available-capacity-bytes>1159926210560</available-capacity-bytes>

            <available-capacity-gigabytes>1080.265</available-capacity-gigabytes>

            <subscribed-capacity-bytes>54979330048</subscribed-capacity-bytes>

            <subscribed-capacity-gigabytes>51.203</subscribed-capacity-gigabytes>

            <operational-status>3</operational-status>

            <operational-status-description>Degraded</operational-status-description>

          </storage-system>

          <storage-system>

            <storage-system-name>SYMMETRIX+000294901120</storage-system-name>

            <model>VMAX-1SE</model>

            <serial-number>000294901120</serial-number>

            <size-bytes>27686186726640</size-bytes>

            <size-gigabytes>25784.771</size-gigabytes>

            <available-capacity-bytes>22112158189128</available-capacity-bytes>

            <available-capacity-gigabytes>20593.552</available-capacity-gigabytes>

            <subscribed-capacity-bytes>434964660224</subscribed-capacity-bytes>

            <subscribed-capacity-gigabytes>405.092</subscribed-capacity-gigabytes>

            <operational-status>2</operational-status>

            <operational-status-description>OK</operational-status-description>

          </storage-system>

        </storage-systems>

      </output>

    </response>

  </responses>

</emc-storage-response>