Add Host to Cluster in vCenter: Service details

The Add Host to Cluster in vCenter service template enables you to allocate existing volumes used as datastores by ESX cluster hosts to a new ESX host.

The following service template details apply to the Add Host to Cluster in vCenter service template.

Software and setup prerequisites

For software and setup prerequisites, see Service template prerequisites.

Edit Service settings

The following table lists the Edit Service settings for the Add Host to Cluster in vCenter service template.

Navigation pane	Settings pane	Description
Target ESX Cluster	vCenter Connection	Specify a vCenter Server that is registered as a Web Service Connection in the Administration Tab.
	ESX Cluster	Specify the ESX Cluster name.
	ESX Hosts	Specify ESX host names.
Target Storage	Configuration Manager Connection	Select the Configuration Manager server which is registered as a Web Service Connection in the Administration Tab.
	Storage System	Select a storage system.
	Resource Group	Specify the resource group from which resources are used (for example LDEV ID and host group ID). You must specify the resource group for VSM when allocating volumes in VSM.
	Port Selection	Select the storage port selection criteria: "Smaller number of hosts": Select the port with the smallest registered WWN. (Default value) "Smaller number of volumes": Select the port with the smallest registered LUN.
Resource Criteria	Storage Port	Specify the Storage Port Configuration Expressions (Name and Value) that meets the specified criteria (Equals, Not Equals, Starts with, and Ends with) based on the selected condition (All or Any).
Host Group Settings	Script for Host Group Naming	Specify a naming rule for the Host Group name as a script.
	Host Mode	Specify the host mode.
	Host Mode Options	Specify the host mode options.
Fabric Settings	Use Fabric Settings	Determines whether to use fabric information from the FC switch manager services for LUN path selection.
	Connections	Specify the connection for the FOS_PrimarySwitch 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.
	Target Fabrics	Specify the fabric name. Separate multiple values by commas. If omitted, all fabrics defined as the FOS_PrimarySwitch specified in Connections will be used.
	Use Existing Zone	Specify 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.
	Use Active Zone Only	Specify whether to use the active zone only if Use Existing Zone is true. Specifying True selects paths with an active Zone setting only. Specifying False selects connectable paths including those with an inactive Zone setting.
	Num. of Hops Restriction	Determines whether restrict path selection to within an assigned number of hops. When this property enabled, the service will fail if there is no path that matched the specified collection range.
	Maximum Num. of Hops	Specify the maximum number of hops when "Num. of Hops Restriction" is set to True.
Zone Settings	Update Zone Configurations	Specify whether to add or create zones.
	Use Existing Zone Aliases	Specify whether to update existing zone alias.
	Update Current Active Zone Configuration	Determines whether to use Zone Active configuration when adding or creating a zone.
	Zone Configurations to Update	Specify a range of zones in which zones are created when "Update Current Active Zone Config" is False.
	Interval for each Fabric Settings	Specify the wait time in minutes between configuring fabrics.
	Script for Zone Naming	Enables zone naming using javascript.
	Script for Host Zone Alias Naming	Enables naming of the Host Zone Alias for host WWNs using javascript.
	Script for Storage Zone Alias Naming	Enables naming of the Storage Zone Alias for storage ports using javascript.

Submit Service Request settings

The following table lists the Submit Service Request settings for the Add Host to Cluster in vCenter service template.

Navigation pane	Settings pane	Description
Target ESX Cluster	vCenter Connection	Specify a vCenter Server that is registered as a Web Service Connection in the Administration Tab.
	ESX Cluster	Specify the ESX Cluster name.
	ESX Hosts	Specify ESX host names.
Target Storage	Configuration Manager Connection	Select the Configuration Manager server which is registered as a Web Service Connection in the Administration Tab.
	Storage System	Select a storage system.
	Resource Group	Specify the resource group from which resources are used (for example LDEV ID and host group ID). You must specify the resource group for VSM when allocating volumes in VSM.
	Port Selection	Select the storage port selection criteria: "Smaller number of hosts": Select the port with the smallest registered WWN. (Default value) "Smaller number of volumes": Select the port with the smallest registered LUN.
Resource Criteria	Storage Port	Specify the Storage Port Configuration Expressions (Name and Value) that meets the specified criteria (Equals, Not Equals, Starts with, and Ends with) based on the selected condition (All or Any).
Host Group Settings	Script for Host Group Naming	Specify a naming rule for the Host Group name as a script.
	Host Mode	Specify the host mode.
	Host Mode Options	Specify the host mode options.
Fabric Settings	Connections	Specify the connection for the FOS_PrimarySwitch 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.
	Target Fabrics	Specify the fabric name. Separate multiple values by commas. If omitted, all fabrics defined as the FOS_PrimarySwitch specified in Connections will be used.
	Use Existing Zone	Specify 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.
	Use Active Zone Only	Specify whether to use the active zone only if Use Existing Zone is true. Specifying True selects paths with an active Zone setting only. Specifying False selects connectable paths including those with an inactive Zone setting.
	Num. of Hops Restriction	Determines whether restrict path selection to within an assigned number of hops. When this property enabled, the service will fail if there is no path that matched the specified collection range.
	Maximum Num. of Hops	Specify the maximum number of hops when "Num. of Hops Restriction" is set to True.
Zone Settings	Update Zone Configurations	Specify whether to add or create zones.
	Use Existing Zone Aliases	Specify whether to update existing zone alias.
	Update Current Active Zone Configuration	Determines whether to use Zone Active configuration when adding or creating a zone.
	Zone Configurations to Update	Specify a range of zones in which zones are created when "Update Current Active Zone Config" is False.
	Interval for each Fabric Settings	Specify the wait time in minutes between configuring fabrics.
	Script for Zone Naming	Enables zone naming using javascript.
	Script for Host Zone Alias Naming	Enables naming of the Host Zone Alias for host WWNs using javascript.
	Script for Storage Zone Alias Naming	Enables naming of the Storage Zone Alias for storage ports using javascript.

Zone naming conventions

The following table lists the zone naming conventions for use with the Add Host to Cluster in vCenter service template.

Type	Zone name	Zone alias name (Host side/Storage side)
Input	One object has the following properties: hostName: Host name hostPortWorldWideName: WWN of HBA. Separator notation is based on FC switch manager services. storagePortWorldWideName: WWN of CHA. Separator notation is based on FC switch manager services. storageSystemSerialNumber: Serial number of physical storage system storagePortName: Display port name of the storage system serviceProperties: List of the service properties passed to the plug-in
Output	Zone name to add to the specified Zone Configuration.	Zone alias name to add to the zone specified in the Zone name convention.
Handling when the output is the same name	Same zone name of the same fabric refers to the same zone. In the case of an existing zone: Add an alias in the zone and add to the Zone Configuration. null: Do not create a zone.	Same zone alias name of the same fabric refers to the same alias. In the case of an existing alias: Add WWN in the alias and add to the Zone. null: Do not create an alias.
Handling when unavailable characters are used for output	Characters other than alphanumeric characters and "_" are converted to "_" and become part of the name.
If the output string is too long	When the output string is over 60 characters, the 61st and subsequent characters are truncated.	When the output string is over 64 characters or more, the 65th and subsequent characters are truncated.
Validation	An error occurs if the return value is one of following: Other than String When starting from non-alphabetic characters. When having a non-standard prefix for the zone. ("LSAN_","TI_", "QOS[HML][0-9]+_")(case ignored)	An error occurs if the return value is one of following: Other than String When starting from non-alphabetic characters.