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

Get-VusService

December 4, 2024
Contributed by: 
C

Introduced in: Citrix Virtual Apps and Desktop 7 2411

Gets the service record entries for the VdaUpdateService Service.

Syntax

Get-VusService
   [-Metadata <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Returns instances of the VdaUpdateService Service that the service publishes. The service records contain account security identifier information that can be used to remove each service from the database.

A database connection for the service is required to use this command.

Examples

EXAMPLE 1

Get all the instances of the VdaUpdateService Service running in the current service group.

Get-VusService

Uid                : 1
ServiceHostId      : aef6f464-f1ee-4042-a523-66982e0cecd0
DNSName            : MyServer.company.com
MachineName        : MYSERVER
CurrentState       : On
LastStartTime      : 04/04/2011 15:25:38
LastActivityTime   : 04/04/2011 15:33:39
OSType             : Win32NT
OSVersion          : 6.1.7600.0
ServiceVersion     : 5.1.0.0
DatabaseUserName   : NT AUTHORITY\NETWORK SERVICE
Sid                : S-1-5-21-2316621082-1546847349-2782505528-1165
ActiveSiteServices : {MySiteService1, MySiteService2...}
<!--NeedCopy-->

Parameters

-Metadata

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.

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

-Property

Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.

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

-ReturnTotalRecordCount

When specified, the cmdlet outputs an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Vus_Filtering for details.

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

-MaxRecordCount

Specifies the maximum number of records to return.

Type: Int32
Position: Named
Default value: 250
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Skip

Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.

Type: Int32
Position: Named
Default value: 0
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SortBy

Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.

Type: String
Position: Named
Default value: The default sort order is by name or unique identifier.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Filter

Gets records that match a PowerShell-style filter expression. See about_Vus_Filtering for details.

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

-FilterScope

Gets only results allowed by the specified scope id.

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.VdaUpdateService.Sdk.Service

The Get-VusServiceInstance command returns an object containing the following properties.

  • Uid <Integer>

    Specifies the unique identifier for the service in the group. The unique identifier is an index number.

  • ServiceHostId <Guid>

    Specifies the unique identifier for the service instance.

  • DNSName <String>

    Specifies the domain name of the host on which the service runs.

  • MachineName <String>

    Specifies the short name of the host on which the service runs.

  • CurrentState <Citrix.Fma.Sdk.ServiceCore.ServiceState>

    Specifies whether the service is running, started but inactive, stopped, or failed.

  • LastStartTime <DateTime>

    Specifies the date and time at which the service was last restarted.

  • LastActivityTime <DateTime>

    Specifies the date and time at which the service was last stopped or restarted.

  • OSType

    Specifies the operating system installed on the host on which the service runs.

  • OSVersion

    Specifies the version of the operating system installed on the host on which the service runs.

  • ServiceVersion

    Specifies the version number of the service instance. The version number is a string that reflects the full build version of the service.

  • DatabaseUserName <string>

    Specifies the Active Directory account name with permissions to access the database for this service instance. This will be either the machine account or, if the database is running on a controller, the NetworkService account.

  • Sid <string>

    Specifies the Active Directory account security identifier for the machine on which the service instance is running.

  • ActiveSiteServices <string[]>

    Specifies the names of active site services currently running in the service. Site services are components that perform long-running background processing in some services. This field is empty for services that do not contain site services.

Notes

If the command fails, the following errors can be returned:

  • UnknownObject

    One of the specified objects was not found.

  • PartialData

    Only a subset of the available data was returned.

  • InvalidFilter

    A filtering expression was supplied that could not be interpreted for this cmdlet.

  • CouldNotQueryDatabase

    The query required to get the database was not defined.

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

  • PermissionDenied

    You do not have permission to execute this command.

  • AuthorizationError

    There was a problem communicating with the Citrix Delegated Administration Service.

  • CommunicationError

    There was a problem communicating with the remote service.

  • ExceptionThrown

    An unexpected error occurred. For more details, see the Windows event logs on the controller or the Citrix Virtual Apps and Desktops logs.

Get-VusService
December 4, 2024
Contributed by: 
C
December 4, 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.