Operation: get-masking-group

 Home  Previous  Next

The get-masking-group operation lists all the masking group.

warningThis operation is applicable only on Symmetrix arrays running Enginuity 5874 or above.

Adapter Request Elements for 'get-masking-group' Operation

 

Definition

Required

operation-name

Specifies the name of the operation you want to perform.

•Valid value: get-masking-group.

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 the 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 one or more of the following elements to retrieve specific information. If none of the elements is specified, then all the details are fetched.

username

Specifies the login name used to connect to  EMC SMI-S Provider. The 'username' specified in the adapter request overrides the value specified in adapter configuration.

•Valid value: None.
•Default Value: None.

No

password

Specifies the password used to connect to EMC SMI-S Provider. The 'password' specified in the adapter request overrides the value specified in the adapter configuration.

•Valid value: None.
•Default Value: None.

No

protocol

Specifies the protocol used to connect to EMC SMI-S Provider. The 'protocol' specified in the adapter request overrides the value specified in the adapter configuration.

•Valid value: HTTPS or HTTP
•Default Value: None.

No

port

Specifies the port number used to connect to EMC SMI-S Provider. The 'port' specified in the adapter request overrides the value specified in the adapter configuration.

•Valid value: A valid numeric value.
•Default Value: None.

No

timeout-secs

Specifies the time in seconds after which the attempt to connect to EMC SMI-S provider times out. The 'timeout-secs' specified in the adapter request overrides the value specified in the 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

storage-system-name

Specifies the storage system name from which the information has to be collected.

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

No

storage-group-name

Returns the complete information of the masking group that is associated with the specified storage group. When the "storage-group-name" element is not present, the command reports on all masking groups.

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

No

device-group-name

Returns the complete information of the specified device-group-name. This element is applicable only on Symmetrix arrays running Enginuity 5874 or above.

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

No

lun-name

Returns the complete information of the masking group that is associated with the specified LUN. When the "lun-name" element is not present, the command reports on all masking groups.

•Valid value: None.
•Default value: None.

No

fast-policy-name

Returns the complete information of the masking group that is associated with the specified FAST policy. This element is applicable only on Symmetrix arrays running Enginuity 5874 or above.

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

No

port-group-name

Returns the complete information of the specified port-group-name. This element is applicable only on Symmetrix arrays running Enginuity 5874 or above.

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

No

port-name

Returns the complete information of the masking group that is associated with the specified port. When the "port-name" element is not present, the command reports on all masking groups.

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

No

initiator-group-name

Returns the complete information of the specified initiator-group-name. This element is applicable only on Symmetrix arrays running Enginuity 5874 or above.

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

No

wwn

Returns the complete information of the masking group that is associated with the specified WWN. When the "wwn" element is not present, the command reports on all masking groups.

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

No

iqn

Returns the complete information of the masking group that is associated with the specified iSCSI. When the "iqn" element is not present, the command reports on all masking groups.

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

No

cascaded-initiator-group-name

Returns the complete information of the masking group that is associated with the specified cascaded Initiator group. When the "cascaded-initiator-group-name" element is not present, the command reports on all masking groups.

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

No

Sample Adapter Request for 'get-masking-group' Operation

<emc-storage-request>

    <operation-name>get-masking-group</operation-name>

    <arguments>

      <argument>

 <storage-system-name/>
         <storage-group-name/>
         <device-group-name/>
         <lun-name/>
         <fast-policy-name/>
         <initiator-group-name/>
         <wwn/>
         <iqn/>
         <cascaded-initiator-group-name />
         <port-group-name/>
         <port-name/>      

      </argument>

    </arguments>

  </emc-storage-request>

Adapter Response Elements for 'get-masking-group' Operation

 

Description

device-group-name

Name of the device group.

storage-system-name

Name of the storage system.

storage-group-name

Name of the storage groups.

lun-name

Name of the LUN associated to the created device group.

fast-policy-name

Name of the FAST policy associated with the device group.

port-group-name

Name of the created port group.

port-name

Name of the port.

initiator-group-name

Name of the created Initiator group.

wwn

Name of the host.

cascaded-initiator-group-name

Name of the existing initiator group that is cascaded with the Initiator group.

Sample Adapter Response for 'get-masking-group' Operation

<emc-storage-response>

  <metadata>

    <status>success</status>

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

  </metadata>

  <responses>

    <response>

      <metadata>

        <status>success</status>

        <execution-milliseconds>5866</execution-milliseconds>

        <masking-group-count>3</masking-group-count>

        <line-count>405</line-count>

        <target>pc-emc</target>

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

      </metadata>

      <output>

        <masking-groups>

          <masking-group>

            <device-groups>

              <device-group>

                <device-group-name>ucs-manager-sg</device-group-name>

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

                <storage-group-name>ucs-manager-vn</storage-group-name>

                <lun-names>

                  <lun-name>00144</lun-name>

                  <lun-name>00145</lun-name>

                </lun-names>

              </device-group>

              <device-group>

                <device-group-name>SG-PC20-DONTTOUCH</device-group-name>

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

                <storage-group-name>PC20-DONTTOUCH</storage-group-name>

                <lun-name>0007A</lun-name>

              </device-group>

              <device-group>

                <device-group-name>dg_pc14</device-group-name>

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

                <storage-group-name>sg_pc14</storage-group-name>

                <lun-names>

                  <lun-name>00066</lun-name>

                  <lun-name>0006C</lun-name>

                </lun-names>

              </device-group>

              <device-group>

                <device-group-name>PC02-Hamster</device-group-name>

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

                <storage-group-name>PC02-Hamster</storage-group-name>

                <lun-names>

                  <lun-name>00030</lun-name>

                  <lun-name>00070</lun-name>

                  <lun-name>00082</lun-name>

                  <lun-name>000EC</lun-name>

                  <lun-name>000F0</lun-name>

                  <lun-name>00131</lun-name>

                </lun-names>

              </device-group>

              <device-group>

                <device-group-name>Pascal</device-group-name>

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

                <storage-group-name>Pascal</storage-group-name>

                <lun-names>

                  <lun-name>0005F</lun-name>

                  <lun-name>00073</lun-name>

                  <lun-name>00074</lun-name>

                  <lun-name>0007C</lun-name>

                  <lun-name>00083</lun-name>

                  <lun-name>002E4</lun-name>

                  <lun-name>002E5</lun-name>

                </lun-names>

              </device-group>

              <device-group>

                <device-group-name>DG_Test</device-group-name>

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

                <storage-group-name>SG_Test</storage-group-name>

                <lun-name>0030A</lun-name>

                <fast-policy-name>SATA_FC_SSD</fast-policy-name>

              </device-group>

            </device-groups>

          </masking-group>

          <masking-group>

            <port-groups>

              <port-group>

                <port-group-name>carnap</port-group-name>

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

                <storage-group-name>carnap</storage-group-name>

                <port-names>

                  <port-name>FA-7E:0</port-name>

                  <port-name>FA-8E:0</port-name>

                  <port-name>FA-7F:0</port-name>

                  <port-name>FA-8F:0</port-name>

                  <port-name>FA-7G:0</port-name>

                  <port-name>FA-8G:0</port-name>

                  <port-name>FA-7H:0</port-name>

                  <port-name>FA-8H:0</port-name>

                </port-names>

              </port-group>

              <port-group>

                <port-group-name>ucs-manager-pg</port-group-name>

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

                <storage-group-name>ucs-manager-vn</storage-group-name>

                <port-names>

                  <port-name>FA-7E:0</port-name>

                  <port-name>FA-7E:1</port-name>

                  <port-name>FA-8E:0</port-name>

                  <port-name>FA-8E:1</port-name>

                  <port-name>FA-8G:1</port-name>

                  <port-name>FA-7H:0</port-name>

                  <port-name>FA-7H:1</port-name>

                  <port-name>FA-8H:0</port-name>

                  <port-name>FA-8H:1</port-name>

                </port-names>

              </port-group>

              <port-group>

                <port-group-name>PC02-Hasmter</port-group-name>

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

                <storage-group-name>PC02-Hamster</storage-group-name>

                <port-names>

                  <port-name>FA-7E:0</port-name>

                  <port-name>FA-7E:1</port-name>

                  <port-name>FA-8E:0</port-name>

                  <port-name>FA-8E:1</port-name>

                  <port-name>FA-7F:0</port-name>

                  <port-name>FA-7F:1</port-name>

                  <port-name>FA-8F:0</port-name>

                  <port-name>FA-8F:1</port-name>

                  <port-name>FA-7G:0</port-name>

                  <port-name>FA-7G:1</port-name>

                  <port-name>FA-8G:0</port-name>

                  <port-name>FA-8G:1</port-name>

                  <port-name>FA-7H:0</port-name>

                  <port-name>FA-7H:1</port-name>

                  <port-name>FA-8H:0</port-name>

                  <port-name>FA-8H:1</port-name>

                </port-names>

              </port-group>

             </port-groups>

          </masking-group>

          <masking-group>

            <initiator-groups>

              <initiator-group>

                <initiator-group-name>ucs-manager</initiator-group-name>

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

                <storage-group-name>ucs-manager-vn</storage-group-name>

                <wwn>20000025B5000009</wwn>

              </initiator-group>

              <initiator-group>

                <initiator-group-name>IG_Test</initiator-group-name>

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

                <storage-group-name>SG_Test</storage-group-name>

                <wwns>

                  <wwn>21000024FF04B66C</wwn>

                  <wwn>2000001B321E5A95</wwn>

                  <wwn>2000001B321E1B98</wwn>

                </wwns>

                <cascaded-initiator-group-name>Pascal</cascaded-initiator-group-name>

              </initiator-group>

              <initiator-group>

                <initiator-group-name>Pascal</initiator-group-name>

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

                <storage-group-name>Pascal</storage-group-name>

                <wwns>

                  <wwn>2000001B321E5A95</wwn>

                  <wwn>2000001B321E1B98</wwn>

                  <wwn>21000024FF04B66C</wwn>

                </wwns>

                <cascaded-initiator-group-name>IG_Test</cascaded-initiator-group-name>

              </initiator-group>

            </initiator-groups>

          </masking-group>

        </masking-groups>

      </output>

    </response>

  </responses>

</emc-storage-response>