NAME

Set-DcsClientProperties

SYNOPSIS

Sets the properties of a client (host).

SYNTAX

Set-DcsClientProperties   -Client <Object>   [ -Name <String> ]   [ -PreferredServer <Object[]> ]   [ -Description <String> ]   [ -ClientType <String> ]   [ -Multipath <Boolean> ]   [ -ALUA <Boolean> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ] [<CommonParameters>]

DESCRIPTION

Sets the properties of a client (host). Specify the parameters to set or change.

PARAMETERS

-Client<Object>

ClientHostData object, name, or ID that identifies the client.

Required: true

Position: named

Default value:

Accept pipeline input: true (ByValue)

Accept wildcard characters: false

-Name<String>

Use this parameter to set a new name for the client.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PreferredServer<Object[]>

Use this parameter to set the preferred servers for the client (host). Valid values include the computer name or ID of one or more servers. Computer names must be either unique or fully qualified. Multiple servers should be separated by commas, for instance "SSVVM01", "SSVVM02", "SSVVM03". The Auto Select option (available in the console) is not supported in this cmdlet.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Description<String>

Use this parameter to set or change the description of the client. To remove the description, use an empty string as the value; for example "".

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-ClientType<String>

Use this parameter to set the operating system type of the client. Specify one of the following types: "WindowsServer2012" if the client host is running Windows Server 2012 and later. "WindowsServer2008" if the client host is running Windows Server 2008. "Windows" if the client host is running any Windows operating system version prior to Windows Server 2008. "ESXi" if the client host is running VMware ESXi. "CitrixXenServer" if the client host is running Citrix Xen Server. "SuseEnterpriseLinusServer11" if the client host is running Linux Suse Enterprise Server 11. "Linux" if the client host is running any Linux operating system other than Linux Suse Enterprise Server 11. "AixMpio" if the client host is running IBM AIX Native MPIO Legacy. "AixMpioTL6Plus" if the client host is running IBM AIX. "HPUX" if the client is running HP HPUX. "SolarisSanFoundation" if the client host is running Oracle (Sun) Solaris. "Proxmox" if the client host is a Proxmox Virtual Environment. "Other" if the client host is running an operating system that is not listed.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Multipath<Boolean>

Use this parameter to set multipathing. Specify $true to enable multipathing or $false to disable multipathing. After this function is enabled, any virtual disk then served to a client will have one path from the client to each server.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-ALUA<Boolean>

Use this parameter to set ALUA support. Specify $true to enable ALUA support or $false to disable ALUA support. After this function is enabled, any virtual disk then served to a client will have support for SCSI-3 target port group commands. Multipathing must be enabled in order to enable ALUA support (see Multipath parameter).

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Connection<String>

Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-PipelineVariable<String>

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

 

-<CommonParameters>

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

INPUTS

ClientHostData : Object that identifies and describes the client.

OUTPUTS

ClientHostData : Object that identifies and describes the client.

NOTES

Also see Set-DcsPortProperties, Get-DcsClient.

EXAMPLES

Set-DcsClientProperties -Client Host3 -PreferredServer SSV1 -ALUA $true
		

Get-DcsClient | Set-DcsClientProperties -PreferredServer SSV2
		

Set-DcsClientProperties -Client audi-vm1 -Multipath $true -ALUA $true