Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Allocate fabric aware volumes with Configuration Manager service properties

Use the following properties to modify or create values for the Allocate fabric aware volumes with Configuration Manager service.

Allocate fabric aware volumes with Configuration Manager (edit)

keyName Type Description Range Default value
ConfigurationManagerConnection File Specify the Configuration Manager Connection. See the following File type property list.-
StorageSystem File Specify the Storage System. See the following File type property list.-
ResourceGroup File Specify the Resource Group. See the following File type property list.-
Pool File Specify the pool. See the following File type property list.-
CapacityFormat String Specify the volume capacity format as Byte or Block "Byte" or "Block" "Byte"
VolumeSettings File Specify the parameters required to create new volumes. See the following File type property list.-
ResourceCriteria File Specify the resource criteria. See the following File type property list.-
PortType String Specify the port type as Fibre or iSCSI. "Fibre" or "iSCSI" "Fibre"
HostGroupSettings File Specify the parameters that are needed to create a new Host Group/iSCIS Target. See the following File type property list.-
provisioning.fabricSetting.enabled Boolean Specifying True enables fabric information collection functionality. - "True"
fabricConnectionTypestringSpecify the fabric type, either FOS_PrimarySwitch or DCNM to filter the Category in Connections.FOS_PrimarySwitch, DCNM -
provisioning.fabricSettings.connectionsfileSpecify the connection defined in the Web Service Connections on the Administration Tab. If this value is omitted, the system uses all connections that are defined for the product name listed in the Web Service Connections. See the following File type property list. -
provisioning.fabricSetting.fabrics String Specify the fabric name. Separate multiple values by commas. If omitted, all fabrics defined as FOS_PrimarySwitch or DCNM in Connections will be used.- -
provisioning.fabricSetting.usingExistingZone Boolean Specifies whether to select a predefined zone or any connectable path. If you specify True, the system selects paths within the range of the existing Zone setting. If you specify False, the system selects connectable paths regardless of the existing Zone setting. - "True"
provisioning.fabricSetting.hops.restriction Boolean Determines whether the service will fail if there is no path that matches the specified collection range. - "False"
provisioning.fabricSetting.hops.range Integer When using the Host Restriction option, specify the collection range by the number of hops. 0 0
provisioning.zoneSetting.enabled Boolean Specify True to enable the modify zone settings functionality. - "True"
provisioning.zoneSetting.useExistingZoneAliases Boolean Specify True to use predefined Zone Aliases regardless of the naming conventions the user specifies. If you specify False, the system selects Zone Aliases that follow the naming conventions. In either case, if there are no existing Zone Aliases, the system creates new Zone Aliases that follow the naming conventions. - "False"
provisioning.zoneSetting.updateActiveZoneConfiguration Boolean Specify True to add a Zone to the active Zone Configuration. - "True"
provisioning.zoneSetting.zoneConfigurationName String To add a zone to a Zone Configuration other than the active configuration, specify the name of the Zone Configuration in which to add the zone. - -
provisioning.zoneSetting.namingScript.zone File Specify the naming convention script that determines the Zone name for the path. - See the following script example.
provisioning.zoneSetting.namingScript.hostZoneAlias File Specify the naming convention script that determines the Zone Alias name for the host port. - See the following script example.
provisioning.zoneSetting.namingScript.storageZoneAlias File Specify the naming convention script that determines the Zone Alias name for the storage port. - See the following script example.
provisioning.zoneSetting.expression.zone/ provisioning.zoneSetting.namingExpression.hostZoneAlias/ provisioning.zoneSetting.naming.Expression.storageZoneAlias
Specifications of the script Explanation
script

Function that is written in the syntax of ECMAScript 5.

The following conditions of arguments and return must be satisfied.

arguments

arguments[0]: The object with the following properties is passed as an argument.

hostname: Host name

hostPortWorldWideName: WWN of HBA. Separator notation is based on BNA.

storagePortWorldWideName: WWN of CHA. Separator notation is based on BNA.

storageSystemFamily: Display model name of the physical storage system

storageSystemName: Name of physical storage system on Device Manager

storageSystemSerialNumber: Serial number of physical storage system

storagePortName: Display port name of the storage system

virtualStorageArrayFamily: Display model name of virtual storage (if non-virtual, “-“)

virtualStorageSystemName: Name of virtual storage on Device Manager (if non-virtual, “-“)

virtualSerialNumber: Serial number of virtual storage (if non-virtual, “-“)

serviceProperties: List of the service properties passed to the plug-in

return

Script must return the string that satisfies the following conditions.

  1. Only alphanumeric characters and “_” are allowed.
  2. The first character must be alphabetic.
  3. Zone can be up to 60 characters. Zone Alias can be up to 64 characters
  4. A string starting with LSAN_","TI_", "QOSHn+_", "QOSMn+_", "QOSLn_" is not allowed for the Zone (where n is a number).
example

(function(args) {

var name;

if(! args.virtualSerialNumber || args.virtualSerialNumber == "-"){

name = args.hostName + "_" + args.storageSystemName + "_" + args.storagePortName;

}else{

name = args.hostName + "_" + args.virtualStorageSystemName + "_" + args.storagePortName;

}

if (!(name === null || typeof(name) == "string" || name instanceof String)) {

throw new Error("Zone name must be a string: "+ name);

}

name = name.replace(/[^A-Za-z0-9_]/g, '_');

if(name.length > 60){

throw new Error("Zone name must be within 60 characters: "+ name);

}

if (/^[A-Z]/i.test(name) == false) {

throw new Error("Zone name must start with a alphabet: "+ name);

}

if (/^LSAN_/i.test(name) || /^TI_/i.test(name) || /^QOS[HML][0-9]+_/i.test(name)) {

throw new Error("Zone name has the prefix LSAN_, TI_ or QOSxx_ cannot be for normal zone: "+name);

}

return name;

})

File type property list
ConfigurationManagerConnection
Data nesting information Description Range
values
productName Product name of registering to Web Service Connection. "ConfigurationManager"
name Name. -
ipAddress IP address. -
port Port. -
protocol Protocol. -
userID User ID. -
status Status of connection. -
connectedTime Connected time. -
StorageSystem
Data nesting information Description Range
values
storageDeviceId Storage Device ID. -
model Model. -
serialNumber Serial Number. -
svpIp SVP IP Address. -
ResourceGroup
Data nesting information Description Range
values
resourceGroupId Resource Group ID. -
resourceGroupName Resource Group Name. -
virtualStorageId Virtual Storage System ID. -
Pool
Data nesting information Description Range
values
poolId Pool ID. -
poolName Pool name. -
poolType Pool Type. -
usedCapacityRate Used capacity rate. -
availableVolumeCapacity Available Volume capacity. -
totalPoolCapacity Total Pool capacity. -
numOfLdevs Number of LDEVs. -
Volume Settings
Data nesting information Description Range
values 1
volumeUsage Volume usage A maximum of 64 characters can be entered.
numberOfVolumes Number of volumes 1-500
ldevIdStartsFrom LDEV ID starts from 0-FFFFFF
volumeCapacityInMiB 2 Volume capacity 1-
blockCapacity 3 Volume capacity 96000-
volumeLabel Volume label A maximum of 64 characters can be entered.
lunStartsFrom LUN starts from 0-07FF
virtualLdevIdStartsFrom Virtual LDEV ID starts from 0-FEFF
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
  2. When "CapacityFormat" is "Byte", volumeCapacityInMiB can be specified.
  3. When "CapacityFormat" is "Block", blockCapacity can be specified.
ResourceCriteria
Data nesting information Description Range
values 1
storagePortCriteria Storage Port Criteria -
expressions Expressions -
name Name "Name"
op Operation "Equals", "Not Equals", "Starts With", "Ends With"
value Value -
join Join condition of the Expressions "All", "Any"
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
HostGroupSettings
Data nesting information Description Range
values 1
hostGroupName 2 Host Group name. A maximum of 64 characters can be entered.
iScsiTargetName 3 iSCSI target name. A maximum of 32 characters can be entered.
wwnSettings 1, 4 WWN settings.
wwn WWN. A maximum of 16 characters is allowed in hexadecimal.
wwnNickname WWN nickname. A maximum of 64 characters can be entered.
iScsiSettings 1, 5 iSCSI settings.
iScsiName iSCSI name. "Specify in iqn format or eui format. -iqn format: Specify 5-223 characters by using the following characters: a-z,0-9,. ,-, : -eui format: Specify 20 characters in hexadecimal."
iScsiNickName iSCSI nickname. A maximum of 32 characters can be entered.
hostMode 6 Host Mode. "HP-UX", "SOLARIS", "AIX", "WIN", "LINUX/IRIX", "TRU64", "OVMS", "NETWARE", "VMWARE", "VMWARE_EX", "WIN_EX"
hostModeOptions Host Mode options. See "Values that can be specified in the hostmodeoptions parameter" in the Hitachi Command Suite CLI Reference Guide.
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
  2. When "PortType" is "Fibre", hostGroupName can be specified.
  3. When "PortType" is "iSCSI", iScsiTargetName can be specified.
  4. When "PortType" is "Fibre", wwnSettings can be specified.
  5. When "PortType" is "iSCSI", iScsiSettings can be specified.
  6. See "Values that can be specified in the hostmode parameter" in the Hitachi Command Suite CLI Reference Guide.
provisioning.fabricSetting.connections
Data nesting information Description Range
value
productName Category -
name Name -
ipAddress IP Address/Host Name -
port Port -
protocol Protocol -
userID User ID -
status Status -
connectedTime Connected Time -

Allocate fabric aware volumes with Configuration Manager (submit)

keyName Type Description Range Default value
ConfigurationManagerConnection File Specify the Configuration Manager Connection. See the following File type property list.-
StorageSystem File Specify the Storage System. See the following File type property list.-
ResourceGroup File Specify the Resource Group. See the following File type property list.-
Pool File Specify the pool. See the following File type property list.-
CapacityFormat String Specify the volume capacity format as Byte or Block "Byte" or "Block" "Byte"
VolumeSettings File Specify the parameters required to create new volumes. See the following File type property list.-
ResourceCriteria File Specify the resource criteria. See the following File type property list.-
PortType String Specify the port type as Fibre or iSCSI. "Fibre" or "iSCSI" "Fibre"
HostGroupSettings File Specify the parameters that are needed to create a new Host Group/iSCIS Target. See the following File type property list.-
provisioning.fabricSetting.enabled Boolean Specifying True enables fabric information collection functionality. - "True"
fabricConnectionTypestringSpecify the fabric type, either FOS_PrimarySwitch or DCNM to filter the Category in Connections.FOS_PrimarySwitch, DCNM -
provisioning.fabricSettings.connectionsfileSpecify the connection defined in the Web Service Connections on the Administration Tab. If this value is omitted, the system uses all connections that are defined for the product name listed in the Web Service Connections. See the following File type property list. -
provisioning.fabricSetting.fabrics String Specify the fabric name. Separate multiple values by commas. If omitted, all fabrics defined as FOS_PrimarySwitch or DCNM in Connections will be used.- -
provisioning.fabricSetting.usingExistingZone Boolean Specifies whether to select a predefined zone or any connectable path. If you specify True, the system selects paths within the range of the existing Zone setting. If you specify False, the system selects connectable paths regardless of the existing Zone setting. - "True"
provisioning.fabricSetting.hops.restriction Boolean Determines whether the service will fail if there is no path that matches the specified collection range. - "False"
provisioning.fabricSetting.hops.range Integer When using the Host Restriction option, specify the collection range by the number of hops. 0 0
provisioning.zoneSetting.enabled Boolean Specify True to enable the modify zone settings functionality. - "True"
provisioning.zoneSetting.useExistingZoneAliases Boolean Specify True to use predefined Zone Aliases regardless of the naming conventions the user specifies. If you specify False, the system selects Zone Aliases that follow the naming conventions. In either case, if there are no existing Zone Aliases, the system creates new Zone Aliases that follow the naming conventions. - "False"
provisioning.zoneSetting.updateActiveZoneConfiguration Boolean Specify True to add a Zone to the active Zone Configuration. - "True"
provisioning.zoneSetting.zoneConfigurationName String To add a zone to a Zone Configuration other than the active configuration, specify the name of the Zone Configuration in which to add the zone. - -
provisioning.zoneSetting.namingScript.zone File Specify the naming convention script that determines the Zone name for the path. - See the following script example.
provisioning.zoneSetting.namingScript.hostZoneAlias File Specify the naming convention script that determines the Zone Alias name for the host port. - See the following script example.
provisioning.zoneSetting.namingScript.storageZoneAlias File Specify the naming convention script that determines the Zone Alias name for the storage port. - See the following script example.
provisioning.zoneSetting.expression.zone/ provisioning.zoneSetting.namingExpression.hostZoneAlias/ provisioning.zoneSetting.naming.Expression.storageZoneAlias
Specifications of the script Explanation
script

Function that is written in the syntax of ECMAScript 5.

The following conditions of arguments and return must be satisfied.

arguments

arguments[0]: The object with the following properties is passed as an argument.

hostname: Host name

hostPortWorldWideName: WWN of HBA. Separator notation is based on BNA.

storagePortWorldWideName: WWN of CHA. Separator notation is based on BNA.

storageSystemFamily: Display model name of the physical storage system

storageSystemName: Name of physical storage system on Device Manager

storageSystemSerialNumber: Serial number of physical storage system

storagePortName: Display port name of the storage system

virtualStorageArrayFamily: Display model name of virtual storage (if non-virtual, “-“)

virtualStorageSystemName: Name of virtual storage on Device Manager (if non-virtual, “-“)

virtualSerialNumber: Serial number of virtual storage (if non-virtual, “-“)

serviceProperties: List of the service properties passed to the plug-in

return

Script must return the string that satisfies the following conditions.

  1. Only alphanumeric characters and “_” are allowed.
  2. The first character must be alphabetic.
  3. Zone can be up to 60 characters. Zone Alias can be up to 64 characters
  4. A string starting with LSAN_","TI_", "QOSHn+_", "QOSMn+_", "QOSLn_" is not allowed for the Zone (where n is a number).
example

(function(args) {

var name;

if(! args.virtualSerialNumber || args.virtualSerialNumber == "-"){

name = args.hostName + "_" + args.storageSystemName + "_" + args.storagePortName;

}else{

name = args.hostName + "_" + args.virtualStorageSystemName + "_" + args.storagePortName;

}

if (!(name === null || typeof(name) == "string" || name instanceof String)) {

throw new Error("Zone name must be a string: "+ name);

}

name = name.replace(/[^A-Za-z0-9_]/g, '_');

if(name.length > 60){

throw new Error("Zone name must be within 60 characters: "+ name);

}

if (/^[A-Z]/i.test(name) == false) {

throw new Error("Zone name must start with a alphabet: "+ name);

}

if (/^LSAN_/i.test(name) || /^TI_/i.test(name) || /^QOS[HML][0-9]+_/i.test(name)) {

throw new Error("Zone name has the prefix LSAN_, TI_ or QOSxx_ cannot be for normal zone: "+name);

}

return name;

})

File type property list
ConfigurationManagerConnection
Data nesting information Description Range
values
productName Product name of registering to Web Service Connection. "ConfigurationManager"
name Name. -
ipAddress IP address. -
port Port. -
protocol Protocol. -
userID User ID. -
status Status of connection. -
connectedTime Connected time. -
StorageSystem
Data nesting information Description Range
values
storageDeviceId Storage Device ID. -
model Model. -
serialNumber Serial Number. -
svpIp SVP IP Address. -
ResourceGroup
Data nesting information Description Range
values
resourceGroupId Resource Group ID. -
resourceGroupName Resource Group Name. -
virtualStorageId Virtual Storage System ID. -
Pool
Data nesting information Description Range
values
poolId Pool ID. -
poolName Pool name. -
poolType Pool Type. -
usedCapacityRate Used capacity rate. -
availableVolumeCapacity Available Volume capacity. -
totalPoolCapacity Total Pool capacity. -
numOfLdevs Number of LDEVs. -
Volume Settings
Data nesting information Description Range
values 1
volumeUsage Volume usage A maximum of 64 characters can be entered.
numberOfVolumes Number of volumes 1-500
ldevIdStartsFrom LDEV ID starts from 0-FFFFFF
volumeCapacityInMiB 2 Volume capacity 1-
blockCapacity 3 Volume capacity 96000-
volumeLabel Volume label A maximum of 64 characters can be entered.
lunStartsFrom LUN starts from 0-07FF
virtualLdevIdStartsFrom Virtual LDEV ID starts from 0-FEFF
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
  2. When "CapacityFormat" is "Byte", volumeCapacityInMiB can be specified.
  3. When "CapacityFormat" is "Block", blockCapacity can be specified.
ResourceCriteria
Data nesting information Description Range
values 1
storagePortCriteria Storage Port Criteria -
expressions Expressions -
name Name "Name"
op Operation "Equals", "Not Equals", "Starts With", "Ends With"
value Value -
join Join condition of the Expressions "All", "Any"
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
HostGroupSettings
Data nesting information Description Range
values 1
hostGroupName 2 Host Group name. A maximum of 64 characters can be entered.
iScsiTargetName 3 iSCSI target name. A maximum of 32 characters can be entered.
wwnSettings 1, 4 WWN settings.
wwn WWN. A maximum of 16 characters is allowed in hexadecimal.
wwnNickname WWN nickname. A maximum of 64 characters can be entered.
iScsiSettings 1, 5 iSCSI settings.
iScsiName iSCSI name. "Specify in iqn format or eui format. -iqn format: Specify 5-223 characters by using the following characters: a-z,0-9,. ,-, : -eui format: Specify 20 characters in hexadecimal."
iScsiNickName iSCSI nickname. A maximum of 32 characters can be entered.
hostMode 6 Host Mode. "HP-UX", "SOLARIS", "AIX", "WIN", "LINUX/IRIX", "TRU64", "OVMS", "NETWARE", "VMWARE", "VMWARE_EX", "WIN_EX"
hostModeOptions Host Mode options. See "Values that can be specified in the hostmodeoptions parameter" in the Hitachi Command Suite CLI Reference Guide.
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
  2. When "PortType" is "Fibre", hostGroupName can be specified.
  3. When "PortType" is "iSCSI", iScsiTargetName can be specified.
  4. When "PortType" is "Fibre", wwnSettings can be specified.
  5. When "PortType" is "iSCSI", iScsiSettings can be specified.
  6. See "Values that can be specified in the hostmode parameter" in the Hitachi Command Suite CLI Reference Guide.
provisioning.fabricSetting.connections
Data nesting information Description Range
value
productName Category -
name Name -
ipAddress IP Address/Host Name -
port Port -
protocol Protocol -
userID User ID -
status Status -
connectedTime Connected Time -

Allocate fabric aware volumes with Configuration Manager (task details)

Use the following information to show the task details of allocated fabric aware volumes with Configuration Manager.

keyName Type Description Range
LUNPathConfigurationInformation File Stores the allocated LUN path information from the volume allocation results. See the "File type property list" section following this table.
provisioning.taskResult.createdZoneConfigurations File List of new zone. -
provisioning.taskResult.createdZones File List of new zones. -
provisioning.taskResult.createdZoneAliases File Stores the new zone aliases. -
provisioning.taskResult.updatedZoneConfigurations File Stores the new zone aliases. -
provisioning.taskResult.updatedZones File Stores the new zone aliases. -
provisioning.taskResult.updatedZoneAliases File Stores the new zone aliases. -
File type property list
LUNPathConfigurationInformation
Data nesting information Description Range
value 1
storageDeviceId Storage device ID -
volumeUsage Volume Usage -
hostPort WWN/iSCSI name -
storagePort Storage port -
lun LUN -
portType Port type -
capacity Capacity -
provisionedCapacity Provisioned capacity -
ldevId LDEV ID -
hostGroupNameOrIScsiTarget Host Group name/iSCSI target name -
hostGroupNumber Host Group number -
hostMode Host Mode -
hostModeOptions Host Mode options -
model Model -
serialNumber Serial number -
ldevLabel LDEV label -
virtualStorageMachineResourceGroupName Resource Group in Virtual Storage System -
virtualModel Model in Virtual Storage System -
virtualSerialNumber Serial number in Virtual Storage System -
resourceGroupName Virtual Storage Machine Resource Group name -
virtualLdevId Virtual LDEV ID -
configurationManager Configuration Manager -
poolId Pool ID -
poolName Pool name -
asymmetricAccessStatus ALUA settings -
  1. Repeatable Repeatable items must be repeated and must include all lower layer tags.
provisioning.taskResult.zoneConfiguration
Data nesting information Explanation Range
values 1 List of new Zone Configuration -
name Name of new Zone Configuration name -
bnaName Name of Switch Management Server/FOS_PrimarySwitch-
fabricName Name of Fabric where the settings exist -
zoneNames 1 Zone to add to the created Zone Configuration -
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
provisioning.taskResult.createdZones
Data nesting information Explanation Range
values 1 List of new zone
name Name of new zone-
bnaName Name of Switch Management Server/FOS_PrimarySwitch-
fabricName Name of Fabric where the settings exist -
Zone Alias to add to the created Zone 1 Zone to add to the created Zone Configuration -
memberNames 1 WWN of the port added to the created Zone -
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
provisioning.taskResult.createdZoneAliases
Data nesting information Explanation Range
values 1 List of new zone alias
name Name of new zone alias -
bnaName Name of Switch Management Server/FOS_PrimarySwitch-
fabricName Name of Fabric where the settings exist -
memberNames 1 WWN of the port added to the created Zone -
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
provisioning.taskResult.updatedZoneConfigurations
Data nesting information Explanation Range
values 1 Zone to add to the created Zone Configuration
name Name of new zone configuration-
bnaName Name of Switch Management Server/FOS_PrimarySwitch-
fabricName Name of Fabric where the settings exist -
zoneNames 1 Name of added zone -
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
provisioning.taskResult.updatedZones
Data nesting information Explanation Range
values 1 List of zones where the settings were updated
name Name of zone where settings were updated-
bnaName Name of Switch Management Server/FOS_PrimarySwitch-
fabricName Name of Fabric where the settings exist -
aliasNames 1 Name of added Zone alias -
memberNames 1 WWN of the added port -
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.
provisioning.taskResult.updatedZoneAliases
Data nesting information Explanation Range
values 1 List of Zone alias where settings were updated
name Name of Zone alias where settings were updated -
bnaName Name of BNA that manages the settings -
fabricName Name of Fabric where the settings exist -
memberNames 1 WWN of added port -
  1. Repeatable. Repeatable items must be repeated and must include all lower layer tags.