Get-BrokerTelemetryData
Introduced in: Citrix Virtual Apps and Desktop 7 2012
Generates list of registered instances of Public cloud workloads
Syntax
Get-BrokerTelemetryData
[-RegistrationTime <DateTime>]
[-SID <String>]
[-Uid <Int64>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
Returns list of Public cloud workloads and their telemetry usage metadata
-------------------------- BrokerTelemetryData Object
Data objects for filtering
-
Instance (System.String)InstanceMetadata Object
-
InstanceType (System.String)Instance type of the machine provided in a AWS instance
-
Location (System.String)Location of the hosted machine
-
MachineType (System.String)Machine type of the instance in a GCP machine
-
ProjectId (System.String)Project Id of the account in GCP project
-
RegistrationTime (System.DateTime?)Actual Registration Time of the VDA
-
ResourceGroupName (System.String)Resource Group name of the resource in an Azure environment
-
ResourceId (System.String)Resource ID of the resource in Azure environment
-
SID (System.String)SId of the instance
-
SubscriptionId (System.String)Subscription record for Azure
-
Timestamp (System.DateTime?)Metadata timestamp received from the VDA
-
Uid (System.Int64)Uid of the instance metadata
-
VmId (System.String)VmId of the instance
-
VmSize (System.String)VM size of the Azure instance
Examples
EXAMPLE 1
Generates list of all registered VDA for public cloud workloads
Get-BrokerTelemetryData
Parameters
-RegistrationTime
VDA Registration time of the service instance
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SID
Gets machines with a specific machine SID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2106 |
-Uid
Id of the registered VDA instance
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnTotalRecordCount
When specified, this causes the cmdlet to output 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_Broker_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_Broker_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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2106 |
-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 |
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
Input cannot be piped to this cmdlet
Outputs
Citrix.Broker.Admin.SDK.TelemetryData
Notes
None
None