New-BrokerHypervisorConnection
Creates a new hypervisor connection.
Syntax
New-BrokerHypervisorConnection
[-HypHypervisorConnectionUid] <Guid>
[-PreferredController <String>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The New-BrokerHypervisorConnection cmdlet creates a new hypervisor connection.
Examples
EXAMPLE 1
This command creates a new hypervisor connection with a preferred controller.
New-BrokerHypervisorConnection -PreferredController "domainName\controllerName" -HypHypervisorConnectionUid "d16f4e56-b85e-4ba6-b745-0e978ae4f192"
EXAMPLE 2
This command creates a new hypervisor connection, and leaves it to the system to select a preferred controller.
New-BrokerHypervisorConnection -HypHypervisorConnectionUid "d16f4e56-b85e-4ba6-b745-0e978ae4f192"
Parameters
-HypHypervisorConnectionUid
The Guid that identifies the hypervisor connection, as defined in DUM.
| Type: | Guid |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-PreferredController
The preferred controller machine for the hypervisor connection. Can be specified as (first match is used):
-
Full SAM name.
-
Full DNS name.
-
SID value.
-
NetBIOS name (SAM without domain).
-
Partial DNS name (DNS name without some or all domain information).
Where not specified, the system selects preferred controller machine based on loading.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-LoggingId
Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop 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
None
You can't pipe objects to this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.HypervisorConnection
New-BrokerHypervisorConnection returns an opaque object containing information about the hypervisor connection.