Developer Documentation
Citrix Virtual Apps and Desktops SDK
Current Release 2402 2311 2305 2303 2212 2209 2206 2203 2112 2109 2103 1912
View PDF

Add-HypHostingUnitNetwork

March 11, 2024
Contributed by: 
C

Makes additional hypervisor networks available for use in a HostingUnit.

Syntax


Add-HypHostingUnitNetwork [-LiteralPath] <String> [-NetworkPath] <String> [-LoggingId <Guid>] [-BearerToken <String>] [-AdminClientIP <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [-AdminAddress <String>] [<CommonParameters>]

<!--NeedCopy-->

Detailed Description

Use this command to extend the set of hypervisor networks that are made available through the HostingUnit to the Citrix Machine Creation Service. When new machines are created, their virtual NICs can be associated only with networks that are in this set. This command cannot be used if the connection for the hosting unit is in maintenance mode.

Parameters

Name Description Required? Pipeline Input Default Value
LiteralPath Specifies the path to the hosting unit to which the network will be added. The path must be in one of the following formats: :\HostingUnits\ or :\HostingUnits\{} true false  
NetworkPath Specifies the path to the network that will be added. The path must be in one of the following formats: :\Connections\\MyNetwork.network or :\Connections{}\MyNetwork.network or :\HostingUnits\\MyNetwork.network or :\HostingUnits{}\MyNetwork.network true true (ByValue)  
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. false false  
BearerToken Specifies the bearer token assigned to the calling user false false  
AdminClientIP Specifies the client IP of the calling user false false  
TraceParent Specifies the trace parent assigned for internal diagnostic tracing use false false  
TraceState Specifies the trace state assigned for internal diagnostic tracing use false false  
VirtualSiteId Specifies the virtual site the PowerShell snap-in will connect to. false false  
AdminAddress Specifies the address of a XenDesktop controller to which the PowerShell snap-in connects. This can be a host name or an IP address. false false LocalHost. When a value is provided by any cmdlet, this value becomes the default.

Input Type

System.String 

You Can Pipe A String That Contains A Path To Add-Hyphostingunitnetwork (Networkpath Parameter).

Return Values

Citrix.Host.Sdk.Hostingunit

Add-HypHostingUnitNetwork returns an object containing the new definition of the hosting unit.

  • HostingUnitUid <Guid> Specifies the unique identifier for the hosting unit.

  • HostingUnitName <string> Specifies the name of the hosting unit.

  • HypervisorConnection <Citrix.Host.Sdk.HypervisorConnection> Specifies the connection that the hosting unit uses to access a hypervisor.

  • RootId <string> Identifies, to the hypervisor, the root of the hosting unit.

  • RootPath <string> The hosting unit provider path that represents the root of the hosting unit.

  • Storage <Citrix.Host.Sdk.Storage[]> The list of storage items that the hosting unit can use.

  • PersonalvDiskStorage <Citrix.XDPowerShell.Storage[]> The list of storage items that the hosting unit can use for storing personal data.

  • VMTaggingEnabled <Boolean> Specifies whether or not the metadata in the hypervisor can be used to store information about the XenDesktop Machine Creation Service.

  • NetworkId <string> The hypervisor’s internal identifier that represents the default network specified for the hosting unit.

  • NetworkPath <string> The hosting unit provider path to the default network specified for the hosting unit.

  • Metadata <Citrix.Host.Sdk.Metadata[]> A list of key value pairs that can store additional information about the hosting unit.

  • PermittedNetworks <Citrix.Host.Sdk.Network[]> A full list of the hypervisor networks that are exposed for use in the hosting unit.

Notes

The network path must be valid for the hosting unit. The rules that are applied are as follows: XenServer (HypervisorConnection Type = XenServer) NA VMWare vSphere/ESX (HypervisorConnection Type = vCenter) The network path must be directly contained in the root path item of the hosting unit. Microsoft SCVMM/Hyper-v (HypervisorConnection Type = SCVMM) NA In the case of failure, the following errors can result.

  • HostingUnitsPathInvalid: The path provided is not to an item in a subdirectory of a hosting unit item.

  • HostingUnitNetworkPathInvalid: The specified path is invalid.

  • HostingUnitNetworkPathInvalid: The network path cannot be found or is invalid. See notes above about validity.

  • HostingUnitNetworkDuplicateObjectExists: The specified network path is already part of the hosting unit.

  • HypervisorInMaintenanceMode: The hypervisor for the connection is in maintenance mode.

  • 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.

  • DataStoreException: 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. To locate more details, see the Windows event logs on the controller being used, or examine the XenDesktop logs.

Examples

Example 1 


c:\PS>Add-HypHostingUnitNetwork -LiteralPath XDHyp:\HostingUnits\MyHostingUnit -NetworkPath 'XDHyp:\HostingUnits\MyHostingUnits\newNetwork.network'

          HostingUnitUid       : bcd3d649-86d1-4aa8-8ec2-d322b6a2c457

          HostingUnitName      : MyHostingUnit

          HypervisorConnection : MyConnection

          RootPath             : /

          RootId               :

          NetworkPath          : /Network 0.network

          NetworkId            : ab47080b-ca15-771a-c8dc-6ad9650158f1

          Storage              : {/Local storage.storage}

          PersonalvDiskStorage : {}

          VMTaggingEnabled     : True

          Metadata             : {}

          PermittedNetworks    : {/Network 0.network, /newNetwork.network}

<!--NeedCopy-->

Description

The command adds a new network called “newNetwork.network” to the hosting unit called “MyHostingUnit”.

Example 2 


XDHyp:\HostingUnits\MyHostingUnit>Add-HypHostingUnitNetwork -LiteralPath . -NetworkPath 'XDHyp:\HostingUnits\MyHostingUnits\newNetwork.network'

          HostingUnitUid       : bcd3d649-86d1-4aa8-8ec2-d322b6a2c457

          HostingUnitName      : MyHostingUnit

          HypervisorConnection : MyConnection

          RootPath             : /

          RootId               :

          NetworkPath          : /Network 0.network

          NetworkId            : ab47080b-ca15-771a-c8dc-6ad9650158f1

          Storage              : {/Local storage.storage}

          PersonalvDiskStorage : {}

          VMTaggingEnabled     : True

          Metadata             : {}

          PermittedNetworks    : {/Network 0.network, /newNetwork.network}

<!--NeedCopy-->

Description

The command adds a new network called “newNetwork.network” to the current directory. The dot (.) represents the current location (not its contents).

Example 3 


XDHyp:\HostingUnits\MyHostingUnit>dir \*.network | Add-HypHostingUnitNetwork -LiteralPath XDHyp:\HostingUnits\MyHostingUnit

<!--NeedCopy-->

Description

The command adds all of the networks that are available in the hosting unit to the specified hosting unit.

Example 4 


c:\PS>Add-HypHostingUnitNetwork -LiteralPath XDHyp:\HostingUnits\MyHostingUnit -NetworkPath 'XDHyp:\HostingUnits\MyHostingUnits\newNetwork.network'

          HostingUnitUid       : bcd3d649-86d1-4aa8-8ec2-d322b6a2c457

          HostingUnitName      : MyHostingUnit

          HypervisorConnection : MyConnection

          RootPath             : /

          RootId               :

          NetworkPath          : /Network 0.network

          NetworkId            : ab47080b-ca15-771a-c8dc-6ad9650158f1

          Storage              : {/Local storage.storage}

          PersonalvDiskStorage : {}

          VMTaggingEnabled     : True

          Metadata             : {}

          PermittedNetworks    : {/Network 0.network, /newNetwork.network}

<!--NeedCopy-->

Description

The command adds a new network location called “newNetwork.network” to the hosting unit called “MyHostingUnit”.

Add-HypHostingUnitNetwork
March 11, 2024
Contributed by: 
C
March 11, 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.