New-ProvImageDefinition
Introduced in: Citrix Virtual Apps and Desktop 7 2303
Create a new image definition.
Syntax
New-ProvImageDefinition
[-ImageDefinitionName] <String>
[-Description <String>]
-OsType <OsType>
-VDASessionSupport <VDASessionSupport>
[-Metadata <Hashtable>]
[-Scope <String[]>]
[-LoggingId <Guid>]
[-SkipCertificateValidation]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Lets you create a new image definition. An image definition can contain multiple image versions (See New-ProvImageVersion). The image definition defines basic information of all its image versions.
Examples
EXAMPLE 1
Create a new image definition with name "MyImage".
New-ProvImageDefinition ImageDefinitionName MyImage -OsType Windows -VDASessionSupport MultiSession -Description "Windows image" -Scope @()
CreateTime : 1/1/2022 12:00:00
Description : Windows image
OsType : Windows
VDASessionSupport : MultiSession
ImageDefinitionName : MyImage
ImageDefinitionUid : 7585f0de-192e-4847-a6d8-22713c3a2f42
LatestVersion : 0
VersionsCount : 0
Scopes :
Parameters
-OsType
A value indicating the OS type for the image definition.
| Type: | OsType |
| Accepted values: | Windows, Linux |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-VDASessionSupport
A value indicating the VDA session support for the image definition.
| Type: | VDASessionSupport |
| Accepted values: | MultiSession, SingleSession |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2402 |
-ImageDefinitionName
The name of the image definition to be created.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
| Disallowed characters: | \/;:#.*?=<>\|[]()"' |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2402 |
-Description
A value indicating the image description.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Metadata
The metadata to be associated with this image definition.
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2402 |
-Scope
The administration scopes to be applied to the image definition.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
-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 |
-SkipCertificateValidation
Forces the cmdlet to skip checking SSL certificates. By default, the cmdlet will check the certificate from the server. If the certificate is not valid, the cmdlet will not connect to the server.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2511 |
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
None
You can't pipe objects to this cmdlet.
Outputs
Citrix.MachineCreation.Sdk.ImageDefinition
This object provides details of the image definitions and contains the following information:
CreationTime \<DateTime\>
The date and time when the image definition was created.
Description \<string\>
The description for this image definition.
OsType \<string\>
The OS type for this image definition.
VDASessionSupport \<string\>
The session support of VDA for this image definition.
ImageDefinitionName \<string\>
The name of this image Definition.
ImageDefinitionUid \<Guid\>
The unique identifier for this image definition.
LatestVersion \<int\>
The latest version number in this definition.
VersionsCount \<int\>
The total versions count in this definition.
Metadata \<System.Collections.Generic.Dictionary\[string, string\];\>
The metadata to apply to the image definition, if specified.
Scopes \<Citrix.Fma.Sdk.ServiceCoreScopeReference\[\]\>
The delegated administration scopes to which the image definition will belong.
Notes
In the case of failure, the following errors can result.
Error Codes
ScopeNotFound One or more of the scopes nominated for the image definition do not exist.
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.
ConfigurationLoggingError
The operation could not be performed because of a configuration logging error.
ExceptionThrown
An unexpected error occurred. To locate more details, see the Windows event logs on the controller being used or examine the XenDesktop logs.
UnsupportedByServer
The requested operation is not supported by this version of the service.