Skip to content

Latest commit

 

History

History
253 lines (187 loc) · 6.31 KB

File metadata and controls

253 lines (187 loc) · 6.31 KB
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Initialize-IntersightWorkflowProperties

SYNOPSIS

Fill in the Synopsis

SYNTAX


Initialize-IntersightWorkflowProperties [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-ClassId< WorkflowProperties.ClassIdEnum>][-InputDefinition< System.Collections.Generic.List`1[Model.WorkflowBaseDataType]>][-ObjectType< WorkflowProperties.ObjectTypeEnum>][-OutputDefinition< System.Collections.Generic.List`1[Model.WorkflowBaseDataType]>][-RetryCount< long>][-RetryDelay< long>][-RetryPolicy< WorkflowProperties.RetryPolicyEnum>][-SupportStatus< WorkflowProperties.SupportStatusEnum>][-Timeout< long>][-TimeoutPolicy< WorkflowProperties.TimeoutPolicyEnum>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Initialize cmdlet is used to instantiate the object of complex type in the Powershell session, it does not create the object on the server.

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

-ClassId

The fully-qualified name of the instantiated, concrete type.\nThis property is used as a discriminator to identify the type of the payload\nwhen marshaling and unmarshaling data.

Type: WorkflowProperties.ClassIdEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-InputDefinition

Note :- Use Initialize-IntersightWorkflowBaseDataType to create the object of complex type WorkflowBaseDataType

Type: System.Collections.Generic.List`1[Model.WorkflowBaseDataType]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-ObjectType

The fully-qualified name of the instantiated, concrete type.\nThe value should be the same as the 'ClassId' property.

Type: WorkflowProperties.ObjectTypeEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-OutputDefinition

Note :- Use Initialize-IntersightWorkflowBaseDataType to create the object of complex type WorkflowBaseDataType

Type: System.Collections.Generic.List`1[Model.WorkflowBaseDataType]
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RetryCount

The number of times a task should be tried before marking as failed.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RetryDelay

The delay in seconds after which the the task is re-tried.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-RetryPolicy

The retry policy for the task.\n* Fixed - The enum specifies the option as Fixed where the task retry happens after fixed time specified by RetryDelay.

Type: WorkflowProperties.RetryPolicyEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-SupportStatus

Supported status of the definition.\n* Supported - The definition is a supported version and there will be no changes to the mandatory inputs or outputs.\n* Beta - The definition is a Beta version and this version can under go changes until the version is marked supported.\n* Deprecated - The version of definition is deprecated and typically there will be a higher version of the same definition that has been added.

Type: WorkflowProperties.SupportStatusEnum
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-Timeout

The timeout value in seconds after which task will be marked as timed out. Max allowed value is 7 days.

Type: long
Parameter Sets: (All)
Aliases:

Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: False

-TimeoutPolicy

The timeout policy for the task.\n* Timeout - The enum specifies the option as Timeout where task will be timed out after the specified time in Timeout property.\n* Retry - The enum specifies the option as Retry where task will be re-tried.

Type: WorkflowProperties.TimeoutPolicyEnum
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:\> Initialize-IntersightWorkflowProperties

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Initialize-IntersightWorkflowBaseDataType