Citrix Virtual Apps and Desktops SDK

Add-ProvSchemeControllerAddress

Adds a list of controller addresses to a provisioning scheme, not recommended any more due to an enhancement in that the list of controller address can be automatically retrieved from the broker.

Syntax

Add-ProvSchemeControllerAddress
   [-ProvisioningSchemeName] <String>
   [-ControllerAddress] <String[]>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Add-ProvSchemeControllerAddress
   -ProvisioningSchemeUid <Guid>
   [-ControllerAddress] <String[]>
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Provides the ability to associate controller hosts, or a set of brokers, with a specific provisioning scheme. This optional data is passed to the machines created by the Machine Creation Services, where it is used to associate the newly created machine with a broker. The list is returned along with the assigned provisioning scheme.

Examples

EXAMPLE 1

Add a set of controllers to the provisioning scheme with the identifier “01a4a008-8ce8-4165-ba9c-cdf15a6b0501”.

Add-ProvSchemeControllerAddress -ProvisioningSchemeUid "01a4a008-8ce8-4165-ba9c-cdf15a6b0501" -ControllerAddress (ddcA.citrix.com,ddcB.citrix.com,ddcC.citrix2.com)

CleanOnBoot                  : True
ControllerAddress            : {ddcA.citrix.com,ddcB.citrix.com,ddcC.citrix2.com}
CpuCount                     : 1
DiskSize                     : 20
HostingUnitName              : HostUnit1
HostingUnitUid               : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
IdentityPoolName             : idPool1
IdentityPoolUid              : 03743136-e43b-4a87-af74-ab71686b3c16
MachineCount                 : 0
MachineProfile               : 
MasterImageVM                : Base.vm/base.snapshot
MasterImageVMDate            : 17/05/2020 09:53:40
MemoryMB                     : 1024
Metadata                     : {Department = Sales}
MetadataMap                  : {[Department = Sales]}
ProvisioningSchemeName       : Scheme2
ProvisioningSchemeUid        : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
ProvisioningSchemeVersion    : 1
TaskId                       : 00000000-0000-0000-0000-000000000000
VMMetadata                   : {0, 1, 0, 0...}
PersonalVDiskDriveLetter     :
PersonalVDiskDriveSize       : 0
UsePersonalVDiskStorage      : False
NetworkMaps                  : {0}
Scopes                       :
DedicatedTenancy             : False
GpuTypeId                    :
ResetAdministratorPasswords  : False
SecurityGroups               : {}
ServiceOffering              :
TenancyType                  : Shared
AzureAdJoinType              :
CurrentMasterImageUid        : c0571690-4f57-4476-901b-fe64d6aecb79
CustomProperties             :
IdentityType:                : ActiveDirectory
UseFullDiskCloneProvisioning : False
UseWriteBackCache            : True
WriteBackCacheDiskSize       : 24
WriteBackCacheMemorySize     : 256
Warnings                     : {}
WriteBackCacheDiskIndex      : 0
<!--NeedCopy-->

EXAMPLE 2

Add controller addresses to a provisioning scheme using a ProvisioningScheme object.

Get-ProvScheme -ProvisioningSchemeName scheme1 | Add-ProvSchemeControllerAddress -ControllerAddress (ddcA.citrix.com,ddcB.citrix.com,ddcC.citrix2.com)

CleanOnBoot                  : True
ControllerAddress            : {ddcA.citrix.com,ddcB.citrix.com,ddcC.citrix2.com}
CpuCount                     : 1
DiskSize                     : 20
HostingUnitName              : HostUnit1
HostingUnitUid               : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
IdentityPoolName             : idPool1
IdentityPoolUid              : 03743136-e43b-4a87-af74-ab71686b3c16
MachineCount                 : 0
MachineProfile               : 
MasterImageVM                : Base.vm/base.snapshot
MasterImageVMDate            : 17/05/2020 09:53:40
MemoryMB                     : 1024
Metadata                     : {Department = Sales}
MetadataMap                  : {[Department = Sales]}
ProvisioningSchemeName       : Scheme2
ProvisioningSchemeUid        : 01a4a008-8ce8-4165-ba9c-cdf15a6b0501
ProvisioningSchemeVersion    : 1
TaskId                       : 00000000-0000-0000-0000-000000000000
VMMetadata                   : {0, 1, 0, 0...}
PersonalVDiskDriveLetter     :
PersonalVDiskDriveSize       : 0
UsePersonalVDiskStorage      : False
NetworkMaps                  : {0}
Scopes                       :
DedicatedTenancy             : False
GpuTypeId                    :
ResetAdministratorPasswords  : False
SecurityGroups               : {}
ServiceOffering              :
TenancyType                  : Shared
AzureAdJoinType              :
CurrentMasterImageUid        : c0571690-4f57-4476-901b-fe64d6aecb79
CustomProperties             :
IdentityType:                : ActiveDirectory
UseFullDiskCloneProvisioning : False
UseWriteBackCache            : True
WriteBackCacheDiskSize       : 24
WriteBackCacheMemorySize     : 256
Warnings                     : {}
WriteBackCacheDiskIndex      : 0
<!--NeedCopy-->

Parameters

-ProvisioningSchemeUid

The unique identifier of the provisioning scheme that the list of addresses is to be added to.

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

-ProvisioningSchemeName

The name for the provisioning scheme that the list of addresses is to be added to.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ControllerAddress

Specifies the array of controller DNS names to be added to the provisioning scheme.

Type: String[]
Position: 3
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
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, -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

Citrix.MachineCreation.Sdk.ProvisioningScheme

You can pipe an object containing a parameter called ‘ProvisioningSchemeName’ to Add-ProvSchemeControllerAddress.

Outputs

Citrix.MachineCreation.Sdk.ProvisioningScheme

Add-ProvSchemeControllerAddress returns the updated ProvisioningScheme object containing the union of the old and new controller address lists.

CleanOnBoot <bool>

Indicates whether the VMs created will be reset to a clean state on each start.

ControllerAddress <string[]>

The DNS names of the controllers associated with this provisioning scheme.

CpuCount <int>

The number of processors that will be used to create VMs.

DiskSize <int>

The disk size (in GB) that will be used to create VMs.

HostingUnitName <string>

The name of the hosting unit being used by this provisioning scheme.

HostingUnitUid <Guid>

The unique identifier of the hosting unit being used by this provisioning scheme.

IdentityPoolName <string>

The name of the identity pool being used by this provisioning scheme.

IdentityPoolUid <Guid>

The unique identifier of the identity pool being used by this provisioning scheme.

MachineCount <int>

The count of machines created with this provisioning scheme.

MachineProfile <string>

The inventory path to the source VM used by the provisioning scheme as a template.

MasterImageVM <string>

The inventory path to the VM snapshot copy used by this provisioning scheme.

MasterImageVMDate <DateTime>

The date and time when the VM snapshot copy used by this provisioning scheme was made.

MemoryMB <int>

The maximum amount of memory that will be used to created VMs in MB.

Metadata <Citrix.MachineCreation.Sdk.Metadata[]>

The metadata associated with this provisioning scheme.

MetadataMap <IDictionary[string, string];>

The metadata associated with this provisioning scheme arranged in key value pairs.

ProvisioningSchemeName <string>

The name of this provisioning scheme.

ProvisioningSchemeUid <Guid>

The unique identifier for this provisioning scheme.

ProvisioningSchemeVersion <int>

The version of the provisioning scheme.

TaskId <Guid>

The identifier of any current task that is running for the provisioning scheme.

VMMetadata <char[]>

The metadata that will be used to created VMs in a plain text format.

PersonalVDiskDriveLetter <char>

The drive letter for the personal vDisk.

PersonalVDiskDriveSize <int>

The size of the personal vDisk in GB.

UsePersonalVDiskStorage <bool>

Indicates whether this provisioning scheme uses personal vDisk storage.

NetworkMaps <Citrix.MachineCreation.Sdk.NetworkMap[]>

The NIC/network mappings that will be used to create VMs.

Scope <Citrix.MachineCreation.Sdk.ScopeReference[]>

The administration scopes associated with this provisioning scheme.

DedicatedTenancy <bool>

Indicates whether dedicated tenancy is used when creating VMs in Cloud Hypervisors.

GpuTypeId <string>

The id of the GPU (Graphics Processor Unit) Type used by this scheme. It is null if there is no GPU.

ResetAdministratorPasswords <bool>

Indicates whether the passwords for administrator accounts are reset on created machines.

ServiceOffering <string>

The service offering that the scheme uses when creating VMs in Cloud Hypervisors.

SecurityGroups <string[]>

The security groups that will be applied to machines created in Cloud Hypervisors.

TenancyType <string>

Tenancy type to be used when creating VMs in Cloud Hypervisors. (See New-ProvScheme.)

AzureAdJoinType <string>

Deprecated.

CurrentMasterImageUid <Guid>

The unique identifier of the current master image used by the provisioning scheme. (See Get-ProvSchemeMasterVMImageHistory.)

CustomProperties <string>

Properties of the provisioning scheme which that are specific to the target hosting infrastructure. (See about_Prov_CustomProperties)

IdentityType <string>

Identity type used to join created machines to a directory service. (See New-ProvScheme.)

UseFullDiskCloneProvisioning <bool>

Indicates whether VMs will be created using the dedicated full disk clone feature.

UseWriteBackCache <bool>

Indicates whether this provisioning scheme will use the write-back cache feature.

WriteBackCacheDiskSize <int>

The size of the write-back cache disk to be used in GB. Specify only when UseWriteBackCache is true.

WriteBackCacheMemorySize <int>

The size of the write-back memory cache in MB. Specify only when UseWriteBackCache is true.

Warnings <Citrix.MachineCreation.Sdk.ProvSchemeWarning[]>

Warning states that have occurred with this provisioning scheme.

WriteBackCacheDiskIndex <int>

The disk index for the write-back cache disk. Specify only when UseWriteBackCache is true.

Notes

In the case of failure, the following errors can result.

Error Codes


ProvisioningSchemeNotFound

The specified provisioning scheme could not be located.

PermissionDenied

The user does not have administrative rights to perform this operation.

ConfigurationLoggingError

The operation could not be performed because of a configuration logging error

DatabaseError

An error occurred in the service while attempting a database operation.

DatabaseNotConfigured

The operation could not be completed because the database for the service is not configured.

ServiceStatusInvalidDb

An error occurred in the service while attempting a database operation - communication with the database failed for

for various reasons.

CommunicationError

An error occurred while communicating with the service.

PermissionDenied

The user does not have administrative rights to perform this operation.

ExceptionThrown

An unexpected error occurred. For more details, see the Windows event logs on the controller being used or Citrix Virtual Apps and Desktops logs.

Add-ProvSchemeControllerAddress