Developer Documentation
Citrix Daas SDK

Test-HypHypervisorConnection

November 26, 2024
Contributed by: 
C

Checks to ensure that the hypervisor connection has the required permission.

Syntax

Test-HypHypervisorConnection
    [-LiteralPath] <String>
    [-SecurePassword <SecureString>]
    [-Password <String>]
    [-CustomProperties <String>]
    [-UserName <String>]
    [<CitrixCommonParameters>]
    [<CommonParameters>]
<!--NeedCopy-->

Description

Use this command to check that the hypervisor connection has the required permissions. This check is done based on the hypervisor connection type, as each hypervisor will have their set of attributes for authentication.

Examples

EXAMPLE 1

A SecurePassword can be generated using Get-Credential cmdlet. LiteralPath can we retrived by executing Get-ChildItem XDHyp:\Connections

$result = Test-HypHypervisorConnection -LiteralPath "XDHyp:\Connections\ConnectionName" -UserName "yourusername" -Password "yourpassword"
<!--NeedCopy-->

Parameters

-LiteralPath

Hosting connection path eg: XDHyp:\Connections\AzureCon

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

-SecurePassword

Password for the connection

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

-Password

Password for the connection

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

-CustomProperties

Custom properties for the connection. The following parameters can be passed through CustomerProperties:

  1. [Vmware only] Location: Mandatory parameter for Vmware connection, string representing a path to a resource in Vmware.
  2. [Vmware only] PermissionType: Optional string parameter representing the type of permission to be checked. Possible values are ‘Browse’ and ‘PowerManagement’. Default value is ‘PowerManagement’.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-UserName

User name for the connection

Type: String
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

None

You can’t pipe objects to this cmdlet.

Outputs

HypervisorConnectionTestResult[]

An array of HypervisorConnectionTestResult which contains missing permissions, corrective action and the category with the description.

Notes

In the case of failure, we are given direction for corrective action and what permissions are missing.

Category CorrectiveAction MissingPermissions

Simulate Principal Policy please add/check iam:SimulatePrincipalPolicy permission User: arn:aws:iam::215706369028:us…

Test-HypHypervisorConnection
November 26, 2024
Contributed by: 
C
November 26, 2024
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.