| external help file | Module Name | online version | schema |
|---|---|---|---|
Intersight.PowerShell.dll-Help.xml |
Intersight.PowerShell |
2.0.0 |
Fill in the Synopsis
New-IntersightWorkloadWorkloadDeployment [-Action< WorkloadWorkloadDeployment.ActionEnum>][-AdditionalProperties< System.Collections.Generic.Dictionary`2[string,object]>][-Blueprints< System.Collections.Generic.List`1[WorkloadBlueprintInputReference]>][-Description< string>][-DigitCount< long>][-Moid< string>][[-Name]< string>][-Organization< OrganizationOrganizationRelationship>][-Qualifiers< System.Collections.Generic.List`1[ResourceResourceQualifier]>][-RolloutStrategy< WorkloadRolloutStrategy>][-SchedulePolicy< SchedulerSchedulePolicyRelationship>][-StartIndexForSuffix< long>][-Tags< System.Collections.Generic.List`1[MoTag]>][-WorkloadDefinitionReference< WorkloadDefinitionMapper>][-WorkloadInstancePrefix< string>][-IfMatch< String>][-IfNoneMatch< String>][-Json< SwitchParameter>][-WithHttpInfo< SwitchParameter>]
Create a 'WorkloadWorkloadDeployment' resource.
The action is performed on the deployment.\n* None - No changes have been made.\n* PrepareToDeploy - Marks the deployment as ready once the user has completed all changes and the deployment is in a valid state. Once the deployment is marked as PrepareToDeploy, workload instances will be created, but the actual deployment will occur as part of the deploy action.\n* Deploy - Initiates the process of pushing workload configuration to the instances based on the configured schedule. Once deployed, the deployment cannot be reverted to draft status.\n* Suspend - Suspends the deployment, preventing any further actions until it is resumed. Making changes to deployment configuration will not be pushed out. The deployment will not take any changes from the attached Workload when it is suspended.\n* Retry - Retries the deployment for all instances that previously failed.\n* Resume - Resumes a suspended deployment. Any changes made to the deployment when it was suspended or any changes made to the attached Workload will now be pushed out based on configured schedules.\n* Undeploy - Undeploy cleans up the policies, templates, and leases generated from the deployment, and marks the deployment as being in the Draft state. The associated definition will be marked as Inactive if there are no other deployments linked to it.\n* ReEvaluateQualifiers - Triggers a re-evaluation of resource qualifiers for the deployment to ensure that all associated instances are aligned with the current resource constraints and qualifiers defined in the deployment.
Type: WorkloadWorkloadDeployment.ActionEnum
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseType: 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: FalseNote :- Use Initialize-IntersightWorkloadBlueprintInputReference to create the object of complex type WorkloadBlueprintInputReference
Type: System.Collections.Generic.List`1[WorkloadBlueprintInputReference]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseA brief description of the deployment.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe minimum digit count to format the instance index with leading zeros, for example if the digit count is 4 and the start index is 1, then the first instance will have a suffix 0001. If the number of instances created for the deployment exceeds the 9999, then the suffix will become a 5 digit number.
Type: long
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: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe name for this Deployment. Name can only contain letters (a-z, A-Z), numbers (0-9), space, hyphen (-), or an underscore (_). The name must be unique within the organization.
Type: string
Parameter Sets: (All)
Aliases:
Required: true
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseA 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: FalseNote :- Use Initialize-IntersightResourceResourceQualifier to create the object of complex type ResourceResourceQualifier
Type: System.Collections.Generic.List`1[ResourceResourceQualifier]
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe strategy used for rolling out deployment changes.
Note :- Use Initialize-IntersightWorkloadRolloutStrategy to create the object of complex type WorkloadRolloutStrategy
Type: WorkloadRolloutStrategy
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseA reference to a schedulerSchedulePolicy 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: SchedulerSchedulePolicyRelationship
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe starting index used to generate the suffix for the workload instance name.
Type: long
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: FalseThe workload definition associated with this deployment.
Note :- Use Initialize-IntersightWorkloadDefinitionMapper to create the object of complex type WorkloadDefinitionMapper
Type: WorkloadDefinitionMapper
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseThe prefix to be used for naming workload instances created by this deployment. Prefix can only contain letters (a-z, A-Z), numbers (0-9), hyphen (-), or an underscore (_). This prefix must be unique within the organization.
Type: string
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True True (ByPropertyName)
Accept wildcard characters: FalseFor methods that apply server-side changes, and in particular for PUT, If-Match can be used to prevent the lost update problem. It can check if the modification of a resource that the user wants to upload will not override another change that has been done since the original resource was fetched. If the request cannot be fulfilled, the 412 (Precondition Failed) response is returned. When modifying a resource using POST or PUT, the If-Match header must be set to the value of the resource ModTime property after which no lost update problem should occur. For example, a client send a GET request to obtain a resource, which includes the ModTime property. The ModTime indicates the last time the resource was created or modified. The client then sends a POST or PUT request with the If-Match header set to the ModTime property of the resource as obtained in the GET request.
Type: String
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
Accept wildcard characters: FalseFor methods that apply server-side changes, If-None-Match used with the * value can be used to create a resource not known to exist, guaranteeing that another resource creation didn't happen before, losing the data of the previous put. The request will be processed only if the eventually existing resource's ETag doesn't match any of the values listed. Otherwise, the status code 412 (Precondition Failed) is used. The asterisk is a special value representing any resource. It is only useful when creating a resource, usually with PUT, to check if another resource with the identity has already been created before. The comparison with the stored ETag uses the weak comparison algorithm, meaning two resources are considered identical if the content is equivalent - they don't have to be identical byte for byte.
Type: String
Parameter Sets: (All)
Aliases:
Required: false
Position: Named
Default value: None
Accept pipeline input: True False
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:\> New-IntersightWorkloadWorkloadDeployment{ Add example description here }
Get-IntersightWorkloadWorkloadDeployment
Initialize-IntersightMoVersionContext
Initialize-IntersightResourceResourceQualifier
Initialize-IntersightWorkflowValidationInformation
Initialize-IntersightWorkloadBlueprintInputReference
Initialize-IntersightWorkloadDefinitionMapper
Initialize-IntersightWorkloadDeploymentChangeDetail
Initialize-IntersightWorkloadRolloutStrategy
Initialize-IntersightWorkloadStateAggregation