| external help file | Module Name | online version | schema |
|---|---|---|---|
Intersight.PowerShell.dll-Help.xml |
Intersight.PowerShell |
2.0.0 |
Fill in the Synopsis
Set-IntersightHyperflexHealthCheckDefinition [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-Category< string>][-CommonCauses< string>][-Configuration< string>][-Description< string>][-HealthImpact< string>][-InternalName< string>][-MinimumHyperFlexVersion< string>][[-Moid]< string>][-Name< string>][-Reference< string>][-Resolution< string>][-ScriptExecutionMode< HyperflexHealthCheckDefinition.ScriptExecutionModeEnum>][-ScriptExecutionOnComputeNodes< bool>][-Tags< System.Collections.Generic.List`1[MoTag]>][-TargetExecutionType< HyperflexHealthCheckDefinition.TargetExecutionTypeEnum>][-Timeout< long>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]
Update a 'HyperflexHealthCheckDefinition' resource.
Type: System.Collections.Generic.Dictionary`2[string,object]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseCategory that the health check belongs to.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseStatic information detailing the common causes for the health check failure.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseExecution configuration fo the health check script.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseDescription of the health check definition.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseStatic information detailing the health impact of the health check failure.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseInternal name of the health check definition.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseMinimum HyperFlex version that the check is supported on. Defaults to version 3.0.1.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe unique identifier of this Managed Object instance.
Type: string
Parameter Sets: (All)
Aliases:
Required: true
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseName of the health check definition.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseStatic information containing additional reference for the health check.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseStatic information detailing the possible remediation actions that can be taken to remedy the health check failure.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseExecution mode of the health script on the HyperFlex cluster.\n* ON_DEMAND - Execute the health check on-demand.\n* SCHEDULED - Execute the health check on a scheduled interval.
Type: HyperflexHealthCheckDefinition.ScriptExecutionModeEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseIndicates if the script needs to be executed on HyperFlex compute nodes. |\nTypically, scripts are only executed on the storage Nodes.
Type: bool
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseNote :- Use Initialize-IntersightMoTag to create the object of complex type MoTag
Type: System.Collections.Generic.List`1[MoTag]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseIndicates whether the health check is executed only on the leader node, or on all nodes in the HyperFlex cluster.\n* EXECUTE_ON_LEADER_NODE - Execute the health check script only on the HyperFlex cluster's leader node.\n* EXECUTE_ON_ALL_NODES - Execute health check on all nodes and aggregate the results.\n* EXECUTE_ON_ALL_NODES_AND_AGGREGATE - Execute the health check on all Nodes and perform custom aggregation.\n* EXECUTE_ON_CURRENT_NODE - The HyperFlex health check is executed on the node which receives the request.
Type: HyperflexHealthCheckDefinition.TargetExecutionTypeEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseHealth check script execution timeout.
Type: long
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseReturns the json payload received in response.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseReturns the HTTP response with headers and content.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
PS C:\> Set-IntersightHyperflexHealthCheckDefinition{ Add example description here }
Get-IntersightHyperflexHealthCheckDefinition
Initialize-IntersightHyperflexHealthCheckScriptInfo
Initialize-IntersightMoVersionContext