Operation: create-masking-group

Home  Previous  Next

The operation create-masking-group is a generic process that can be used to create the following groups:

device-group-name
initiator-group-name
port-group-name

which compose the "Auto-provisioning Groups" on Symmetrix arrays. Auto-provisioning Groups simplify the creation of the Storage Group (Masking View).

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

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

 

Definition

Required

operation-name

Specifies the name of the operation you want to perform.

Valid value: create-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 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 adapter request overrides the value specified in 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 adapter request overrides the value specified in 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 adapter request overrides the value specified in 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 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

storage-system-name

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

Valid value: Any valid string.
Default value: None

Yes

device-group-name

or
initiator-group-name

or
port-group-name

Specify any one of the three group names that has to be created or modified. This element is applicable only on Symmetrix arrays running Enginuity 5874 or above.

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

Yes

fast-policy-name

If the device-group-name is specified then provide the name of the FAST Policy that must be associated with the specified device-group-name.

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

No

lun-name

If the device-group-name is specified then provide the name of the lun(s) that must be associated to the host (s)(wwn).

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

No

lun-host-address

Specifies the unique address for each LUN associated to the host(s)(wwn). If this unique address is:

specified, the number of <lun-name> MUST BE EQUAL to the number of <lun-host-address>. If not, an error message will be displayed.
not specified, the SMI-S provided will automatically generate a unique value for each <lun-name> provided in a sequential order

 

Valid value: Any valid string.
Default value: Automatically generated by the EMC SMI-S Provider.

No

initiator-group-to-cascade

If the initiator-group-name is specified then provide the name of the existing initiator group(s) that has to be cascaded with the specified initiator-group-name.

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

No

host-name

If the initiator-group-name is specified then provide the host name of the wwn to be added.

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

No

host-ipaddress

If the initiator-group-name is specified then provide the IP address of the of the wwn to be added.

Valid value: any valid IP address
Default value: None.

No

wwn

If the initiator-group-name is specified then provide the name of the host(s) to which the LUN(s) must be associated.

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

No

iqn

If the initiator-group-name is specified then provide the name of the iSCSI host(s) to which the lun(s) must be associated.

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

No

port-name

If the port-group-name is specified then provide the name of the FC/Ethernet port(s) through which the LUN(s) must be exposed to the Host(s).

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

No

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

Sample 1 - Creating a Device Group

<emc-storage-request>

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

  <arguments>

    <argument>

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

      <device-group-name>DG_Pc10</device-group-name>

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

      <fast-policy-name>FP_SSD</fast-policy-name>

    </argument>

  </arguments>

</emc-storage-request>

Sample 2 - Creating an Initiator Group

<emc-storage-request>

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

  <arguments>

    <argument>

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

      <initiator-group-name>IG_Pc10</initiator-group-name>

      <wwn>10000000C96EB8DA</wwn>

      <initiator-group-to-cascade>IG_PC05</initiator-group-to-cascade>

    </argument>

  </arguments>

</emc-storage-request>

Sample 3 - Creating a Port Group

<emc-storage-request>

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

  <arguments>

    <argument>

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

      <port-group-name>PG_Pc10</port-group-name>

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

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

    </argument>

  </arguments>

</emc-storage-request>

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

 

Description

storage-system-name

Name of the storage system.

device-group-name

Name of the device group.

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.

initiator-group-name

Name of the created Initiator group.

wwn

Name of the host.

initiator-group-to-cascade

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

port-group-name

Name of the created port group.

port-name

Name of the port.

create-modify-status

Status of the operation.

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

Sample 1 - Device Group created

 

<emc-storage-response>

  <metadata>

    <status>success</status>

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

  </metadata>

  <responses>

    <response>

      <metadata>

        <status>success</status>

        <execution-milliseconds>1419</execution-milliseconds>

        <line-count>4</line-count>

        <target>pc-emc</target>

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

      </metadata>

      <output>

        <masking-groups>

          <masking-group>

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

            <device-group-name>DG_Pc10</device-group-name>

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

            <create-modify-status>0 (Success)</create-modify-status>

          </masking-group>

        </masking-groups>

      </output>

    </response>

  </responses>

</emc-storage-response>

Sample 2 - Initiator group Created

 

<emc-storage-response>

  <metadata>

    <status>success</status>

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

  </metadata>

  <responses>

    <response>

      <metadata>

        <status>success</status>

        <execution-milliseconds>2199</execution-milliseconds>

        <line-count>4</line-count>

        <target>pc-emc</target>

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

      </metadata>

      <output>

        <masking-groups>

          <masking-group>

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

            <initiator-group-name>IG_Pc10</initiator-group-name>

            <wwn>10000000C96EB8DE</wwn>

            <create-modify-status>0 (Success)</create-modify-status>

          </masking-group>

        </masking-groups>

      </output>

    </response>

  </responses>

</emc-storage-response>

Sample 3 - Port Group Created

 

<emc-storage-response>

  <metadata>

    <status>success</status>

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

  </metadata>

  <responses>

    <response>

      <metadata>

        <status>success</status>

        <execution-milliseconds>1185</execution-milliseconds>

        <line-count>6</line-count>

        <target>pc-emc</target>

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

      </metadata>

      <output>

        <masking-groups>

          <masking-group>

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

            <port-group-name>PG_Pc10</port-group-name>

            <port-names>

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

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

            </port-names>

            <create-modify-status>0 (Success)</create-modify-status>

          </masking-group>

        </masking-groups>

      </output>

    </response>

  </responses>

</emc-storage-response>