Citrix Virtual Apps and Desktops SDK

New-ProvSchemeVersion

Introduced in: Citrix Virtual Apps and Desktop 7 2511

[Experimental Command]

Creates a new configuration version for a provisioning scheme

Syntax

New-ProvSchemeVersion
   [-CpuCount <Int32>]
   [-MemoryInMB <Int32>]
   [-CustomProperties <String>]
   [-MachineProfile <String>]
   [-NetworkMapping <Hashtable>]
   [-SecurityGroup <String[]>]
   [-WriteBackCacheDiskSize <Int32>]
   [-WriteBackCacheMemorySize <Int32>]
   -ProvisioningSchemeUid <Guid>
   [-ConfigurationInfo <String>]
   [-VtpmProvisionPolicy <ProvisioningSchemeVtpmPolicy>]
   [-RunAsynchronously]
   [-PurgeJobOnSuccess]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-ProvSchemeVersion
   [-CustomProperties <String>]
   -ServiceOffering <String>
   [-MachineProfile <String>]
   [-NetworkMapping <Hashtable>]
   [-SecurityGroup <String[]>]
   [-WriteBackCacheDiskSize <Int32>]
   [-WriteBackCacheMemorySize <Int32>]
   -ProvisioningSchemeUid <Guid>
   [-ConfigurationInfo <String>]
   [-VtpmProvisionPolicy <ProvisioningSchemeVtpmPolicy>]
   [-RunAsynchronously]
   [-PurgeJobOnSuccess]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-ProvSchemeVersion
   [-CpuCount <Int32>]
   [-MemoryInMB <Int32>]
   [-CustomProperties <String>]
   [-MachineProfile <String>]
   [-NetworkMapping <Hashtable>]
   [-SecurityGroup <String[]>]
   [-WriteBackCacheDiskSize <Int32>]
   [-WriteBackCacheMemorySize <Int32>]
   -ProvisioningSchemeName <String>
   [-ConfigurationInfo <String>]
   [-VtpmProvisionPolicy <ProvisioningSchemeVtpmPolicy>]
   [-RunAsynchronously]
   [-PurgeJobOnSuccess]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
New-ProvSchemeVersion
   [-CustomProperties <String>]
   -ServiceOffering <String>
   [-MachineProfile <String>]
   [-NetworkMapping <Hashtable>]
   [-SecurityGroup <String[]>]
   [-WriteBackCacheDiskSize <Int32>]
   [-WriteBackCacheMemorySize <Int32>]
   -ProvisioningSchemeName <String>
   [-ConfigurationInfo <String>]
   [-VtpmProvisionPolicy <ProvisioningSchemeVtpmPolicy>]
   [-RunAsynchronously]
   [-PurgeJobOnSuccess]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Creates a new configuration version for a provisioning scheme as specified by the user to be used for hardware update

Examples

Parameters

-ProvisioningSchemeUid

Indicates the Uid of the provisioningscheme

Type: Guid
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ProvisioningSchemeName

Indicates the Name of the provisioningscheme

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-ServiceOffering

The Service Offering to use when creating VMs in Cloud Hypervisors, replacing the present one. Cannot be used alongside either VMCpuCount or VMMemoryMB.

Type: String
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-CpuCount

The number of processors that will be used to create VMs from the provisioning scheme, replacing the present one.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MemoryInMB

The amount of memory that will be used to created VMs from the provisioning scheme in MB, replacing the present one

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-CustomProperties

The properties of the provisioning scheme that are specific to the target hosting infrastructure. See about_Prov_CustomProperties for more information. If a property name already exists its value is updated; otherwise it is added

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MachineProfile

Defines the inventory path to the source VM used by the provisioning scheme as a template. This profile identifies the properties for the VMs created from the scheme. The VM must be in the hosting unit that HostingUnitName or HostingUnitUid refers to. If any properties are present in the MachineProfile but not the CustomProperties, values from the template will be written back to the CustomProperties.See about_Prov_MachineProfile for more details.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-NetworkMapping

Specifies how the attached NICs are mapped to networks. If this parameter is omitted, the current NICs setting of the provisioning scheme is not updated; otherwise the NICs setting is updated, and new machines will be created with the number of NICs specified in the map, with each NIC attached to the specified network. Cannot set to an empty value.

Type: Hashtable
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SecurityGroup

The Security Groups to use when creating VMs in Cloud Hypervisors, replacing the present one.

Type: String[]
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-WriteBackCacheDiskSize

Specifies the size in Gigabytes of the disk to use as a Write Back Cache when UseWriteBackCache is set during the Provisioning Scheme creation. This parameter can only be set or modified if the Provisioning Scheme was previously created with UseWriteBackCache. This parameter only applies to newly created VMs and does not affect VMs which have already been created from the Provisioning Scheme. Setting this parameter to 0 is not allowed.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-WriteBackCacheMemorySize

Specifies the size in Megabytes of the memory to use as a Write Back Cache when UseWriteBackCache is set during the Provisioning Scheme creation. This parameter can only be set or modified if the Provisioning Scheme was previously created with UseWriteBackCache. This parameter only applies to newly created VMs and does not affect VMs which have already been created from the Provisioning Scheme

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ConfigurationInfo

This parameter is for a brief information or details on the personalization

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-VtpmProvisionPolicy

The specified VTPM policy dictates whether provisioning VMs are created by cloning from an existing blueprint or as new instances. This property is applicable only to MCS provisioning schemes. The value can be None, Clone or Clean. This value will not take effect when machine profile does not contain vTPM.

Type: ProvisioningSchemeVtpmPolicy
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RunAsynchronously

Indicates whether an identifier for the task must be returned before completion of the task. The progress of the task can be monitored using ‘get-ProvTask’ command.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PurgeJobOnSuccess

Indicates that the task history is removed from the database when the task completes. This cannot be specified for tasks that run asynchronously.

Type: SwitchParameter
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-LoggingId

Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CitrixCommonParameters

This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -SkipCertificateValidation, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.

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.

Inputs

None

You can’t pipe objects to this cmdlet.

Outputs

Guid

When the RunAsynchronously identifier is specified, this GUID is returned and provides the task identifier.

System.Management.Automation.PSCustomObject

This object provides details of the task that was run and contains the following information:

TaskId <Guid> The identifier for the task that was performed.

Active <bool> Indicates whether the task is still processing or is complete.

Host <string> The name of the host on which the task is running or was run.

DateStarted <DateTime> The date and time when the task was started.

Metadata <Citrix.MachineCreation.Sdk.Metadata[]> The list of metadata stored for the task. For new tasks, this is empty until metadata is added.

CurrentOperation <string> Operation specific phase of the overall “Running” task state.

TaskProgress <double> The progress of the task 0-100%.

LastUpdateTime <DateTime> The date and time of the last task status update.

ActiveElapsedTime <int> Number of seconds the task has taken for active execution.

DateFinished <DateTime> The date and time when the task was completed.

TerminatingError < Citrix.Fma.Sdk.ServiceCore.CommonCmdlets.TaskterminatingError> Diagnostic information if the task completely fails.

Type <Citrix.XDInterServiceTypes.JobType> The type of task. For new prov scheme version task, this is always “NewSchemeVersion”.

Status <string> Where in its lifecycle the task is.

ProvisioningSchemeName <string> The name of the provisioning scheme from which the VM was created.

ProvisioningSchemeUid <Guid> The unique identifier of the provisioning scheme from which the VM was created.

TaskState <Citrix.DesktopUpdateManager.SDK.ProvisionVMState> The state of the task. This can be any of the following:

TaskStateInformation <string> Provides more detailed information about the current task state.

WorkflowStatus <System.Workflow.Runtime.WorkflowStatus> Indicates the status of the workflow that is used to process the task.

TaskExpectedCompletion <DateTime> The date and time at which the task is expected to complete.

New-ProvSchemeVersion