Skip to content

Latest commit

 

History

History
321 lines (233 loc) · 8.22 KB

Set-IntersightOpenapiTaskGenerationRequest.md

File metadata and controls

321 lines (233 loc) · 8.22 KB
Raw
external help file Module Name online version schema
Intersight.PowerShell.dll-Help.xml
Intersight.PowerShell
2.0.0

Set-IntersightOpenapiTaskGenerationRequest

SYNOPSIS

Fill in the Synopsis

SYNTAX


Set-IntersightOpenapiTaskGenerationRequest [-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-EndpointType< OpenapiTaskGenerationRequest.EndpointTypeEnum>][-HeaderParameters< System.Collections.Generic.List`1[OpenapiKeyValuePair]>][-IsValidateRequest< bool>][[-Moid]< string>][-Organization< OrganizationOrganizationRelationship>][-Protocol< OpenapiTaskGenerationRequest.ProtocolEnum>][-QueryParameters< System.Collections.Generic.List`1[OpenapiKeyValuePair]>][-SelectedApis< System.Collections.Generic.List`1[OpenapiApiInfo]>][-Source< OpenapiProcessFileRelationship>][-Tags< System.Collections.Generic.List`1[MoTag]>][-TaskPrefix< string>][-TaskTags< System.Collections.Generic.List`1[OpenapiKeyValuePair]>][-Url< string>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]

DESCRIPTION

Update a 'OpenapiTaskGenerationRequest' 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

-EndpointType

Indicates if target endpoint is external or internal. An endpoint is internal if the target is an Intersight resource. For instance, configuring an intersight object using a Task.\n* External - Denotes that the target endpoint is an external API endpoint.\n* Internal - Denotes that the target endpoint is a Intersight API endpoint.

Type: OpenapiTaskGenerationRequest.EndpointTypeEnum
Parameter Sets: (All)
Aliases:

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

-HeaderParameters

Note :- Use Initialize-IntersightOpenapiKeyValuePair to create the object of complex type OpenapiKeyValuePair

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

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

-IsValidateRequest

When this value is set to true, the task name validations happen and provides the task validation status against each of the selected API on the property selectedApis When this value is set to false, an internal workflow to generate the tasks is submitted, conflicting task names are created with an incremented version.

Type: bool
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

-Organization

A reference to a organizationOrganization resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: OrganizationOrganizationRelationship
Parameter Sets: (All)
Aliases:

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

-Protocol

Specifies the REST API protocol being used, which can be one of HTTP or HTTPS.\n* HTTPS - Denotes that the API call uses the HTTPS protocol type\n* HTTP - Denotes that the API call uses the HTTP protocol type

Type: OpenapiTaskGenerationRequest.ProtocolEnum
Parameter Sets: (All)
Aliases:

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

-QueryParameters

Note :- Use Initialize-IntersightOpenapiKeyValuePair to create the object of complex type OpenapiKeyValuePair

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

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

-SelectedApis

Note :- Use Initialize-IntersightOpenapiApiInfo to create the object of complex type OpenapiApiInfo

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

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

-Source

A reference to a openapiProcessFile resource.\nWhen the $expand query parameter is specified, the referenced resource is returned inline.

Note:- To get the relationship object pass the MO to the cmdlet Get-IntersightMoMoRef or use the cmdlet Initialize-IntersightMoMoRef.

Type: OpenapiProcessFileRelationship
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

-TaskPrefix

Optional string that can be prefixed to the name of created tasks.

Type: string
Parameter Sets: (All)
Aliases:

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

-TaskTags

Note :- Use Initialize-IntersightOpenapiKeyValuePair to create the object of complex type OpenapiKeyValuePair

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

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

-Url

Specifies the URL of the endpoint that the created task communicates with. It is defaulted to intersight.com for internal endpoints.

Type: string
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-IntersightOpenapiTaskGenerationRequest

{ Add example description here }

INPUTS

System.Int32

System.String

OUTPUTS

TestModule.FavoriteStuff

NOTES

RELATED LINKS

Get-IntersightOpenapiTaskGenerationRequest

Initialize-IntersightMoVersionContext

Initialize-IntersightOpenapiApiInfo

Initialize-IntersightOpenapiFailedTask

Initialize-IntersightOpenapiKeyValuePair

New-IntersightOpenapiTaskGenerationRequest

Remove-IntersightOpenapiTaskGenerationRequest