Skip to content

Latest commit

 

History

History
348 lines (263 loc) · 7.92 KB

Set-IntersightHyperflexHealthCheckDefinition.md

File metadata and controls

348 lines (263 loc) · 7.92 KB
Raw
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Set-IntersightHyperflexHealthCheckDefinition

SYNOPSIS

Fill in the Synopsis

SYNTAX


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>]

DESCRIPTION

Update a 'HyperflexHealthCheckDefinition' resource.

PARAMETERS

-AdditionalProperties

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: False

-Category

Category 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: False

-CommonCauses

Static 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: False

-Configuration

Execution 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: False

-Description

Description 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: False

-HealthImpact

Static 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: False

-InternalName

Internal 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: False

-MinimumHyperFlexVersion

Minimum 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: False

-Moid

The 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: False

-Name

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: False

-Reference

Static 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: False

-Resolution

Static 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: False

-ScriptExecutionMode

Execution 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: False

-ScriptExecutionOnComputeNodes

Indicates 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: False

-Tags

Note :- 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: False

-TargetExecutionType

Indicates 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: False

-Timeout

Health 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: False

-Json

Returns 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: False

-WithHttpInfo

Returns 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: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

EXAMPLES

Example 1

PS C:\> Set-IntersightHyperflexHealthCheckDefinition

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Get-IntersightHyperflexHealthCheckDefinition

Initialize-IntersightHyperflexHealthCheckScriptInfo

Initialize-IntersightMoVersionContext

New-IntersightHyperflexHealthCheckDefinition

Remove-IntersightHyperflexHealthCheckDefinition