New HPOVClusterProfile - HewlettPackard/POSH-HPEOneView GitHub Wiki

Create a new cluster profile resource.

New-HPOVClusterProfile [-Name] <string> [-ClusterManager] <HPOneView.Cluster.ClusterManager> [-ClusterManagerLocation] <String> [-ServerProfileTemplate] <Object> [-ClusterPassword] <SecureString>[ [-Description] <String>][ [-ClusterPrefix] <String>][ [-Servers] <HPOneView.Cluster.AddHostRequest[]>] [-LeaveHostsInMaintenanceMode] <bool>[ [-StorageVolume] <Object>][ [-StorageVolumeFileSystem] <String>][ [-Scope] <Object>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

New-HPOVClusterProfile [-Name] <string> [-ClusterManager] <HPOneView.Cluster.ClusterManager> [-ClusterManagerLocation] <String> [-ServerProfileTemplate] <Object> [-ClusterPassword] <SecureString> [-UnmanageVSwitch] <SwitchParameter>[ [-Description] <String>][ [-ClusterPrefix] <String>][ [-Servers] <HPOneView.Cluster.AddHostRequest[]>][ [-HAEnabled] <Bool>][ [-DRSEnabled] <Bool>][ [-MultiNicVMotionEnabled] <bool>][ [-Scope] <Object>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

New-HPOVClusterProfile [-Name] <string> [-ClusterManager] <HPOneView.Cluster.ClusterManager> [-ClusterManagerLocation] <String> [-ServerProfileTemplate] <Object> [-ClusterPassword] <SecureString>[ [-Description] <String>][ [-ClusterPrefix] <String>][ [-Servers] <HPOneView.Cluster.AddHostRequest[]>] [-OverrideManagementAddressAssignmet] <SwitchParameter> [-SubnetMask] <IPAddress> [-Gateway] <IPAddress>[ [-PrimaryDNS] <IPAddress>][ [-SecondaryDNS] <IPAddress>][ [-TertiaryDNS] <IPAddress>] [-Domain] <String> [-LeaveHostsInMaintenanceMode] <bool>[ [-StorageVolume] <Object>][ [-StorageVolumeFileSystem] <String>] [-OverrideNetworkingConfig] <SwitchParameter> [-ConfigurePortGroups] <bool> [-VSwitchNameOverride] <hashtable> [-PortGroupNameOverride] <Hashtable> [-OverrideClusterManagerConfig] <SwitchParameter> [-VirtualSwitchType] <string>[ [-DistributedSwitchUsage] <String>][ [-DistributedSwitchVersion] <String>][ [-HAEnabled] <Bool>][ [-DRSEnabled] <Bool>][ [-MultiNicVMotionEnabled] <bool>][ [-Scope] <Object>][ [-Async] <SwitchParameter>][ [-ApplianceConnection] <Object>] [<CommonParameters>]

A cluster profile enables you to deploy and manage a cluster of servers (nodes) managed by HPE OneView and orchestrates consistent configuration on cluster of server nodes to share the same workload. A cluster profile and the associated server profile template are used to define a consistent configuration from server nodes to members in the cluster. The associated server profiles define physical server configurations for server nodes in the cluster, which are derived from parent cluster profile and its associated server profile template.

NOTE: The server profile template must have a configured connection to the hypervisor management network for the template to be valid for use by a hypervisor cluster profile.

The cluster profile helps you manage life cycle operations, such as growing or shrinking the cluster, modifying configurations based on needs, consistency checks, and nondisruptive firmware updates on the member nodes. For example, you can grow or shrink a cluster by adding or removing members from the cluster profile. Any change in the configuration of the cluster profile will be reported as an inconsistency. When inconsistencies are remediated, the changed configurations can be applied on cluster and member nodes.

A cluster profile can manage VMware ESXi-based hypervisor clusters by leveraging VMware vCenter server. A hypervisor cluster must be managed by one instance of HPE OneView to avoid inconsistencies.

Use this Cmdlet to create a new cluster profile within OneView. Any new created clusters within OneView cannot be removed from OneView withour destroying the cluster within the cluster manager.

Privileges: Infrastructure administrator, Server administrator, Server profile architect, or Server profile administrator.

-ApplianceConnection <Object>

Aliases [-Appliance]

Specify one or more HPOneView.Appliance.Connection object(s) or Name property value(s).

Default Value: ${Global:ConnectedSessions} | ? Default

-Async <SwitchParameter>

Use this parameter to immediately return the async task. By default, the Cmdlet will wait for the task to complete.

-ClusterManager <HPOneView.Cluster.ClusterManager>

Specify the cluster manager that will manage the cluster and associated members, from Get-HPOVClusterManager.

-ClusterManagerLocation <String>

Specify the location where the cluster will be created within the cluster manager.

-ClusterPassword <SecureString>

Specify the cluster administrator/root account password.

-ClusterPrefix <String>

Specify the cluster member hostname prefix that will be used. A unique numerical value will be appended to the end. If omitted, the clsuter name will be used as the prefix.

-ConfigurePortGroups <bool>

Specify if port groups should also be configured when configuring host networking.

-DRSEnabled <Bool>

Specify if DRS (if supported) should be enabled ($True) or disabled ($false).

-Description <String>

Provide a description of the cluster.

-DistributedSwitchUsage <String>

If overriding the distributed virtual switch configuring set by the cluster manager, specify the switch usage. Allowed values:

* Standard
* Distributed

-DistributedSwitchVersion <String>

If overriding the distributed virtual switch configuring set by the cluster manager, specify the version. To identify the supported versions, look at the AvailableDvsVersions property of the returned cluster manager from Get-HPOVClusterManager.

-Domain <String>

Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the domain name if the management network is not configured to use an IP Address Pool.

-Gateway <IPAddress>

When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the gateway if the management network is not configured to use an IP Address Pool.

-HAEnabled <Bool>

Specify if VMware HA (if supported) should be enabled ($True) or disabled ($false).

-LeaveHostsInMaintenanceMode <bool>

Specify if the host should be left in maintenance mode (if applicable) before servicing the cluster.

-MultiNicVMotionEnabled <bool>

Specify if multi-NIC VMotion (if supported) should be enabled ($True) or disabled ($false).

-Name <string>

Provide the cluster profile name. If -Prefix is omitted, this value will become the cluster node prefix value.

-OverrideClusterManagerConfig <SwitchParameter>

Use to indicate the desire to override the cluster manager default settings.

-OverrideManagementAddressAssignmet <SwitchParameter>

Use to indicate address assignment. If the server profile template boot connections are set to require static addresses, the IPAddress value must be used in the New-HPOVClusterProfileMember Cmdlet.

-OverrideNetworkingConfig <SwitchParameter>

Use to indicate if network naming will be overridden.

-PortGroupNameOverride <Hashtable>

Use to specify what the PortGroup name override should be. By default, PortGroup names will be automatically assigned based on the network name, removing unique character strings. Specify an Array of Hashtable with the following format:

@{ "NetworkName" = "OverrideName" }

Where "NetworkName" is the name of the Ethernet Network assigned to the connection.

-PrimaryDNS <IPAddress>

Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the primary DNS if the management network is not configured to use an IP Address Pool.

-Scope <Object>

Provide an HPOneView.Appliance.ScopeCollection resource object to initially associate with. Resource can also be added to scope using the Add-HPOVResourceToScope Cmdlet.

-SecondaryDNS <IPAddress>

Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the secondary DNS if the management network is not configured to use an IP Address Pool.

-ServerProfileTemplate <Object>

The server profile template from Get-HPOVServerProfileTemplate that the cluster configuration will be derived from and follow cluster consistency with.

-Servers <HPOneView.Cluster.AddHostRequest[]>

One or more server resource objects from New-HPOVClusterProfileMember. Value can be empty to create an empty cluster, if the target cluster manager supports that type of configuration, like VMware vSphere.

-StorageVolume <Object>

One or more storage volumes to assign.

-StorageVolumeFileSystem <String>

Specify if the storage volume(s) in the StorageVolume parameter should be formatted with a specific filesystem. Allowed values:

* VMFS
* Unmanaged

-SubnetMask <IPAddress>

When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the subnet mask if the management network is not configured to use an IP Address Pool.

-TertiaryDNS <IPAddress>

Optional - When deploying a new cluster profile with HPE Synergy and Image Streamer, specify the tertiary DNS if the management network is not configured to use an IP Address Pool.

-UnmanageVSwitch <SwitchParameter>

Use to configure the cluster profile to not manage host networking.

-VSwitchNameOverride <hashtable>

Use to specify what the vSwitch name override should be. By default, vSwitch names will be automatically assigned based on the network name, removing unique character strings. Specify an Array of Hashtable with the following format:

@{ "NetworkName" = "OverrideName" }

Where "NetworkName" is the name of the Ethernet Network assigned to the connection.

-VirtualSwitchType <string>

Use to indicate which vSiwtch type to configure when overriding cluster manager networking settings. Allowed values are:

* Standard
* Distributed

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216)

None. You cannot pipe objects to this cmdlet.

HPOneView.Appliance.TaskResource [System.Management.Automation.PSCustomObject]

Asyncronous task resource to monitor.

 -------------------------- EXAMPLE 1 --------------------------

# Get the specific Cluster Manager
$ClusterManager = Get-HPOVHypervisorManager -Name ClusterManager1

# Display the allowed locations to place the cluster
$ClusterManager.Locations

DC1
DC2
DC3
DC3\Folder1

$ClusterPassword = Read-Host -Prompt "Cluster password" -AsSecureString

# Get the server profile template the cluster will be created and derived from
$ServerProfileTemplate = Get-HPOVServerProfileTemplate -Name "Hypervisor Cluster Prod"

# Get a list of servers based on the SPT, that are available to deploy to
$Servers = Get-HPOVServer -NoProfile -InputObject $ServerProfileTemplate -Count 4

# Create the new cluster profile
New-HPOVClusterProfile -Name ProdCluster1 -ClusterPrefix ProdClusterNode- -ClusterManager $ClusterManager -ClusterManagerLocation "DC2" -ServerProfileTemplate $ServerProfileTemplate -ClusterPassword $ClusterPassword -Servers $Servers

Create a new cluster profile.

 -------------------------- EXAMPLE 2 --------------------------

# Get the specific Cluster Manager
$ClusterManager = Get-HPOVHypervisorManager -Name ClusterManager1

# Display the allowed distributed switch versions supported by the cluster manager
$ClusterManager.AvailableDvsVersions

4.0
4.10
5.0.0
5.1.0
5.5.0
6.0
6.7

$ClusterPassword = Read-Host -Prompt "Cluster password" -AsSecureString

# Get the server profile template the cluster will be created and derived from
$ServerProfileTemplate = Get-HPOVServerProfileTemplate -Name "Hypervisor Cluster Prod"

# Get a list of servers based on the SPT, that are available to deploy to
$Servers = Get-HPOVServer -NoProfile -InputObject $ServerProfileTemplate -Count 4

# Create new cluster profile overriding the cluster manager settings
New-HPOVClusterProfile -Name ProdCluster1 -ClusterPrefix ProdClusterNode- -ClusterManager $ClusterManager -ClusterManagerLocation "DC2" -ServerProfileTemplate $ServerProfileTemplate -ClusterPassword $ClusterPassword -Servers $Servers -OverrideClusterManagerConfig -VirtualSwitchType Distributed -DistributedSwitchUsage AllNetworks -DistributedSwitchVersion 6.0 -HAEnabled $true -DRSEnabled $false 

Create a new cluster profile, overriding clsuter manager settings.

• Get-HPOVClusterProfile
• New-HPOVClusterProfileMember
• Remove-HPOVClusterProfile
• Update-HPOVClusterProfile