Product Documentation

Citrix.Host.Admin.V2

Sep 29, 2015

Overview

Name Description
HypHostSnapin The Host Service PowerShell snap-in provides administrative functions for
Hyp Filtering Describes the common filtering options for XenDesktop cmdlets.

Cmdlets

Name Description
Add-HypHostingUnitMetadata Adds metadata on the given HostingUnit.
Add-HypHostingUnitNetwork Makes additional hypervisor networks available for use in a HostingUnit.
Add-HypHostingUnitStorage Adds storage locations to a hosting unit.
Add-HypHypervisorConnectionAddress Add a connection address to a hypervisor connection.
Add-HypHypervisorConnectionMetadata Adds metadata on the given HypervisorConnection.
Add-HypHypervisorConnectionScope Add the specified HypervisorConnection(s) to the given scope(s).
Add-HypMetadata Adds metadata to a hypervisor connection or a hosting unit.
Get-HypConfigurationDataForItem Retrieves the configuration data for an item in the Host Service provider path. Note: For this release, only VM items are supported for this operation.
Get-HypConfigurationObjectForItem Retrieves the configuration data for an item in the Host Service provider path. Note: For this release, only VM items are supported for this operation.
Get-HypConnectionRegion Enumerates the regions of a hypervisor connection that are based on cloud technology.
Get-HypDBConnection Gets the database string for the specified data store used by the Host Service.
Get-HypDBSchema Gets a script that creates the Host Service database schema for the specified data store.
Get-HypDBVersionChangeScript Gets a script that updates the Host Service database schema.
Get-HypHypervisorPlugin Gets the available hypervisor types.
Get-HypInstalledDBVersion Gets a list of all available database schema versions for the Host Service.
Get-HypScopedObject Gets the details of the scoped objects for the Host Service.
Get-HypService Gets the service record entries for the Host Service.
Get-HypServiceAddedCapability Gets any added capabilities for the Host Service on the controller.
Get-HypServiceInstance Gets the service instance entries for the Host Service.
Get-HypServiceStatus Gets the current status of the Host Service on the controller.
Get-HypVMMacAddress Retrieves a list the MAC addresses for the VMs in the specified connection.
Get-HypVolumeServiceConfiguration Gets instances of the VolumeServiceConfiguration that are configured for this site.
Get-HypXenServerAddress Gets all the available addresses for a XenServer hypervisor connection.
Grant-HypSecurityGroupEgress Adds an egress rule to a security group.
Grant-HypSecurityGroupIngress Adds an ingress rule to a security group.
New-HypVMSnapshot Creates a new snapshot for the specified VM item path.
Remove-HypHostingUnitMetadata Removes metadata from the given HostingUnit.
Remove-HypHostingUnitNetwork Removes networks from a hosting unit.
Remove-HypHostingUnitStorage Removes storage from a hosting unit.
Remove-HypHypervisorConnectionAddress Removes addresses from the list of available connection addresses.
Remove-HypHypervisorConnectionMetadata Removes metadata from the given HypervisorConnection.
Remove-HypHypervisorConnectionScope Remove the specified HypervisorConnection(s) from the given scope(s).
Remove-HypMetadata Removes metadata from a hypervisor connection or hosting unit.
Remove-HypServiceMetadata Removes metadata from the given Service.
Reset-HypServiceGroupMembership Reloads the access permissions and configuration service locations for the Host Service.
Revoke-HypSecurityGroupEgress Removes an egress rule from a security group.
Revoke-HypSecurityGroupIngress Removes an ingress rule from a security group.
Set-HypAdminConnection Set the controller to be used by the cmdlets that form the Host service PowerShell snap-in.
Set-HypDBConnection Configures a database connection for the Host Service.
Set-HypHostingUnitMetadata Adds or updates metadata on the given HostingUnit.
Set-HypHostingUnitStorage Sets options for a storage location on a hosting unit.
Set-HypHypervisorConnectionMetadata Adds or updates metadata on the given HypervisorConnection.
Set-HypServiceMetadata Adds or updates metadata on the given Service.
Set-HypVolumeServiceConfiguration Applies a change to one of the VolumeServiceConfiguration instances in the site.
Start-HypVM Starts a VM.
Stop-HypVM Stops a VM by issuing a Shutdown request
Test-HypDBConnection Tests a database connection for the Host Service.
Test-HypHostingUnitNameAvailable Checks to ensure that the proposed name for a hosting unit is unused.
Test-HypHypervisorConnectionNameAvailable Checks to ensure that the proposed name for a hypervisor connection is unused.
Update-HypHypervisorConnection Requests the host service to update the connection properties that depend on the version of hypervisor in use.