2.9 KiB
Executable File
external help file, Module Name, online version, schema
| external help file | Module Name | online version | schema |
|---|---|---|---|
| VMware.HV.Helper-help.xml | VMware.HV.Helper | 2.0.0 |
Get-HVPoolSpec
SYNOPSIS
Gets desktop specification
SYNTAX
Get-HVPoolSpec [-DesktopInfo] <DesktopInfo> [[-FilePath] <String>] [[-HvServer] <Object>] [-WhatIf] [-Confirm]
[<CommonParameters>]
DESCRIPTION
Converts DesktopInfo Object to DesktopSpec. Also Converts view API Ids to human readable names
EXAMPLES
EXAMPLE 1
Get-HVPoolSpec -DesktopInfo $DesktopInfoObj
Converts DesktopInfo to DesktopSpec
EXAMPLE 2
Get-HVPool -PoolName 'LnkClnJson' | Get-HVPoolSpec -FilePath "C:\temp\LnkClnJson.json"
Converts DesktopInfo to DesktopSpec and also dumps json object
PARAMETERS
-DesktopInfo
An object with detailed description of a desktop instance.
Type: DesktopInfo
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-FilePath
{{ Fill FilePath Description }}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-HvServer
Reference to Horizon View Server to query the virtual machines from. If the value is not passed or null then first element from global:DefaultHVServers would be considered in-place of hvServer
Type: Object
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: 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.
INPUTS
OUTPUTS
Returns desktop specification
NOTES
| Author | Praveen Mathamsetty. |
| Author email | pmathamsetty@vmware.com |
| Version | 1.1 |
===Tested Against Environment====
| Horizon View Server Version | 7.0.2, 7.1.0 |
| PowerCLI Version | PowerCLI 6.5, PowerCLI 6.5.1 |
| PowerShell Version | 5.0 |