NAME

Set-DcsHostGroupProperties

SYNOPSIS

Changes the properties of a host group; such as name, description, Quality of Service settings, and Charge Back feature setting.

SYNTAX

Set-DcsHostGroupProperties   -Group <Object>   [ -Name <String> ]   [ -Description <String> ]   [ -MaxIoOperationsPerSec <UInt64> ]   [ -MaxDataTransferredPerSec <DataSize> ]   [ -EnableChargeBack <Boolean> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Changes the properties of a host group; such as name, description, Quality of Service settings, and Charge Back feature setting.

PARAMETERS

-Group<Object>

HostGroupData object, name, or ID that identifies the host group.

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 host group.

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Description<String>

Use this parameter to set the description of the host group. 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

-MaxIoOperationsPerSec<UInt64>

The maximum number of operations per second allowed between a set of hosts in a host group and a particular server. The maximum number ranges from 1 to 2,147,483,647. To remove the value in order to disable the setting, set the value to "0".

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-MaxDataTransferredPerSec<DataSize>

The maximum amount of data that can be transferred per second between a set of hosts in a host group and a particular server. Valid values consist of the number followed by the unit of measurement (KB, MiB, GiB). Decimals may be used. For example, "100KB", "500MG", and "2.99GiB" are valid amounts. Maximum amount can range from 1 KB to 3 GiB. To remove the value in order to disable the setting, set the value to "0".

Required: false

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-EnableChargeBack<Boolean>

Use the parameter to enable or disable the Charge Back setting for the host group. Specify $true to enable the feature or $false to disable the feature. Note: The recording server must be configured before enabling the Charge Back feature, see Set-DcsRecordingEndpointProperties.

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

INPUTS

HostGroupData : The object that identifies and describes the host group.

OUTPUTS

HostGroupData : The object that identifies and describes the host group.

NOTES

Also see Add-DcsHostGroup, Add-DcsHostToGroup, Get-DcsHostGroup, Remove-DcsHostFromGroup, Remove-DcsHostGroup, Set-DcsRecordingEndpointProperties.

EXAMPLES

Set-DcsHostGroupProperties -Group "HostGroup1" -Name "FinanceGroup1" -Description "A collection of hosts that serve the Finance Department for Region 1."
		

Set-DcsHostGroupProperties -Group HostGroup1 -MaxDataTransferredPerSec 3GiB -MaxIoOperationsPerSec 100000 -EnableChargeBack $true