NAME
Set-DcsServerGroupProperties
SYNOPSIS
Sets properties for the local server group.
SYNTAX
Set-DcsServerGroupProperties [ -Alias <String> ] [ -Description <String> ] [ -RecoverySpeed <UInt32> ] [ -SelfHealingDelay <Int32> ] [ -SelfHealingDisabled <Boolean> ] [ -SupportBundleRelayAddress <String> ] [ -Telemetry <String> ] [-CrashRecoveryCount <Int32>] -ServerLocality <Object> [-CyberResiliencyModeEnabled <Boolean>] [ -Connection <String> ] [ -PipelineVariable <String> ]
DESCRIPTION
Sets the alias, description, recovery speed, support bundle relay server address, automatic self-healing, and telemetry settings used by the local server group. Specify the parameters to set or change.
PARAMETERS
- -Alias<String>
- Use this parameter to set a new name for the server group.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Description<String>
- Use this parameter to set a description of the server 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
-
- -RecoverySpeed<UInt32>
- Use this parameter to set the overall mirror recovery for all servers in the server group. The value controls the number of commands that will be processed at the same time for each server in the group. Valid values include "0", "16", "32", "48", and "64". The default setting is "32". For instance, the maximum number of outstanding I/O commands per virtual disk is eight. If the default of 32 is used, then the approximate number of virtual disks that can recover at the same time is four. A value of "0" will suspend mirror recoveries for all servers in the group.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -SelfHealingDelay<Int32>
- Sets the delay for the automatic self-healing feature. The value can be set in number of seconds, from a minimum of five seconds to a maximum of 60000 (1000 minutes). The default is 480 (eight minutes).
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -SelfHealingDisabled<Boolean>
- This parameter enables or disables the automatic self-healing feature. Specify $true to disable or $false to enable.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -SupportBundleRelayAddress<String>
- Use this parameter to set the address or non-default port number for the Support Bundle Relay Server used by the server group. The address can be the hostname or IP address of the Relay Server running the Support Bundle Relay service. If using a hostname, a name resolution mechanism must be used to resolve the hostname to an IP address. For example, "Relay1" would set the Support Bundle Relay Server to the machine named "Relay1" using the default port number (3795). If the port is not included, the default port will be used. To set the address for a Relay Server using a non-default port number, enter the host name or IP address followed by a colon and then the non-default port number to use such as "Relay1:3700". In this case the non-default port "3700" would be set. (Note: using a non-default port also requires the port to be changed directly on the Relay Server, see the Release Notes for information.) See the cmdlet Test-DcsSupportBundleRelayAddress to test connections to the support bundle relay server.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -Telemetry<String>
- Use this parameter to enable or disable machine data transmission (telemetry) to DataCore Software. Valid values are "Disabled" to disable machine data transmission, or "Enabled" to enable machine data transmission.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
-
- -CrashRecoveryCount <Int32>
- Sets the number of attempts to start servers in server group after a crash.
-
- Required: false
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -DefaultServerLocality <Object>
- Specify the ServerLocalityData object, by name or ID that identifies the locality.
-
- Required: true
- Position: named
- Default value:
- Accept pipeline input: false
- Accept wildcard characters: false
- -CyberResiliencyModeEnabled [<Boolean>]
- This parameter enables or disables the Cyber Resiliency Mode. Specify $true to enable or $false to disable.
-
- 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
OUTPUTS
ServerHostGroupData : Object that identifies and describes the server group.
NOTES
Also see Get-DcsServerGroup.
EXAMPLES
Set-DcsServerGroupProperties -Alias "Local Group" -Description "SAN shop in Ft. Lauderdale, FL" -RecoverySpeed 0
Changes the name of the local server group to "Local Group", sets the description to be "SAN shop in Ft. Lauderdale, FL", and sets the Recovery speed to zero in order to suspend recovery for all servers in the group.
OurGroup | : | True |
Alias | : | Local Group |
Description | : | SAN shop in Ft. Lauderdale, FL |
State | : | Present |
SmtpSettings | : | |
LicenseSettings | : | DataCore.Executive.LicenseSettings |
LicenseType | : | NFR |
ContactData | : | DataCore.Executive.ContactData |
StorageUsed | : | 0.00 B |
RecoverySpeed | : | 0 |
ExistingProductKeys | : | {, , , } |
Id | : | 4ba07046-5f6b-44f1-acf8-41d77d0dc184 |
Caption | : | Local Group |
ExtendedCaption | : | Local Group |
Internal | : | False |
Set-DcsServerGroupProperties -SupportBundleRelayAddress HostVM1
The cmdlet is invoked with the support bundle relay address set to the hostname "HostVM1". Since the port number is not specified, the default port number 3795 will be used.
OurGroup | : | True |
Alias | : | Group1 |
Description | : | |
State | : | Present |
SmtpSettings | : | |
LicenseSettings | : | DataCore.Executive.LicenseSettings |
LicenseType | : | NFR |
ContactData | : | |
StorageUsed | : | 0 B |
MaxStorage | : | 1 PB |
RecoverySpeed | : | 32 |
ExistingProductKeys | : | {, , } |
DataCoreStorageUsed | : | 160 GB |
SupportBundleRelayAddress | : | HostVM1 |
CyberResiliencyModeEnabled | : | True |
SequenceNumber | : | 7954 |
Id | : | 4b428832-fd51-45df-9c21-ce267e1ceb7a |
Caption | : | Group1 |
ExtendedCaption | : | Group1 |
Internal | : | False |
Set-DcsServerGroupProperties -SelfHealingDisabled $false -SelfHealingDelay 3600
The automatic self-healing feature is enabled and the delay is set to 60 minutes for the local server group.
OurGroup | : | True |
Alias | : | Server Group FTL |
Description | : | Changed by the REST API |
State | : | Present |
SmtpSettings | : | DataCore.Executive.SmtpServerSettings |
LicenseSettings | : | DataCore.Executive.LicenseSettings |
LicenseType | : | NFR |
ContactData | : | |
StorageUsed | : | 0 B |
BulkStorageUsed | : | 0 B |
MaxStorage | : | 1 PB |
RecoverySpeed | : | 32 |
ExistingProductKeys | : | {, , , } |
DataCoreStorageUsed | : | 511 GB |
SupportBundleRelayAddress | : | 172.20.19.5 |
MirrorTrunkMappingEnabled | : | False |
SelfHealingDelay | : | 3600 |
CyberResiliencyModeEnabled | : | True |
SequenceNumber | : | 78559 |
Id | : | 1063f426-5fd0-4152-b6a6-d93b6f07ded1 |
Caption | : | Server Group FTL |
ExtendedCaption | : | Server Group FTL |
Internal | False |