{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"CTXCloudApi SYNOPSIS Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports DESCRIPTION Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports FUNCTION SYNOPSIS Connect-CTXAPI Connect to the cloud and create needed api headers Get-CTXAPI_Applications Return details about published apps Get-CTXAPI_CloudConnectors Details about current Cloud Connectors Get-CTXAPI_CloudServices Return details about cloud services and subscription Get-CTXAPI_ConfigAudit Reports on system config Get-CTXAPI_ConfigLog Get high level configuration changes in the last x days. Get-CTXAPI_ConnectionReport Creates Connection report Get-CTXAPI_DeliveryGroups Return details about Delivery Groups Get-CTXAPI_FailureReport Reports on failures in the last x hours. Get-CTXAPI_HealthCheck Show useful information for daily health check Get-CTXAPI_Hypervisors Return details about hosting (hypervisor) Get-CTXAPI_LowLevelOperations Return details about low lever config change (More detailed) Get-CTXAPI_MachineCatalogs Return details about machine catalogs Get-CTXAPI_Machines Return details about vda machines Get-CTXAPI_MonitorData Collect Monitoring OData for other reports Get-CTXAPI_ResourceLocations Get cloud Resource Locations Get-CTXAPI_ResourceUtilization Resource utilization in the last x hours Get-CTXAPI_Sessions Return details about current sessions Get-CTXAPI_SiteDetails Return details about your farm / site Get-CTXAPI_Tests Run Built in Citrix cloud tests Get-CTXAPI_VDAUptime Uses Registration date to calculate uptime Get-CTXAPI_Zone Get zone details NOTES CTXCloudApi Getting Started You will need access to the Citrix Cloud API. Follow Get API Access to gain access. Install-Module -Name CTXCloudApi -Verbose Import-Module CTXCloudApi -Verbose -Force Get-Command -Module CTXCloudApi Run Connect-CTXAPI with the details obtained from above. This connect and create the needed headers for other commands. Example 1: $splat = @{ Customer_Id = \"xxx\" Client_Id = \"xxx-xxx-xxx-xxx\" Client_Secret = \"yyyyyy==\" Customer_Name = 'HomeLab' } $APIHeader = Connect-CTXAPI @splat Get-CTXAPI_HealthCheck -APIHeader $APIHeader -region eu -ReportPath C:\\Temp\\ HTML Reports When creating a HTML report: The logo can be changed by replacing the variable - `$Global:Logourl` ='URL to your logo' The colors of the report can be changed, by replacing: - `$global:colour1` = '# number of color' - `$global:colour2` = '# number of color' Or permanently replace it by editing the following file - `<Module base>\\Private\\Reports-Variables.ps1` SEE ALSO https://github.com/smitpi/CTXCloudApi","title":"CTXCloudApi"},{"location":"#ctxcloudapi","text":"","title":"CTXCloudApi"},{"location":"#synopsis","text":"Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports","title":"SYNOPSIS"},{"location":"#description","text":"Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports","title":"DESCRIPTION"},{"location":"#function-synopsis","text":"","title":"FUNCTION SYNOPSIS"},{"location":"#connect-ctxapi","text":"Connect to the cloud and create needed api headers","title":"Connect-CTXAPI"},{"location":"#get-ctxapi_applications","text":"Return details about published apps","title":"Get-CTXAPI_Applications"},{"location":"#get-ctxapi_cloudconnectors","text":"Details about current Cloud Connectors","title":"Get-CTXAPI_CloudConnectors"},{"location":"#get-ctxapi_cloudservices","text":"Return details about cloud services and subscription","title":"Get-CTXAPI_CloudServices"},{"location":"#get-ctxapi_configaudit","text":"Reports on system config","title":"Get-CTXAPI_ConfigAudit"},{"location":"#get-ctxapi_configlog","text":"Get high level configuration changes in the last x days.","title":"Get-CTXAPI_ConfigLog"},{"location":"#get-ctxapi_connectionreport","text":"Creates Connection report","title":"Get-CTXAPI_ConnectionReport"},{"location":"#get-ctxapi_deliverygroups","text":"Return details about Delivery Groups","title":"Get-CTXAPI_DeliveryGroups"},{"location":"#get-ctxapi_failurereport","text":"Reports on failures in the last x hours.","title":"Get-CTXAPI_FailureReport"},{"location":"#get-ctxapi_healthcheck","text":"Show useful information for daily health check","title":"Get-CTXAPI_HealthCheck"},{"location":"#get-ctxapi_hypervisors","text":"Return details about hosting (hypervisor)","title":"Get-CTXAPI_Hypervisors"},{"location":"#get-ctxapi_lowleveloperations","text":"Return details about low lever config change (More detailed)","title":"Get-CTXAPI_LowLevelOperations"},{"location":"#get-ctxapi_machinecatalogs","text":"Return details about machine catalogs","title":"Get-CTXAPI_MachineCatalogs"},{"location":"#get-ctxapi_machines","text":"Return details about vda machines","title":"Get-CTXAPI_Machines"},{"location":"#get-ctxapi_monitordata","text":"Collect Monitoring OData for other reports","title":"Get-CTXAPI_MonitorData"},{"location":"#get-ctxapi_resourcelocations","text":"Get cloud Resource Locations","title":"Get-CTXAPI_ResourceLocations"},{"location":"#get-ctxapi_resourceutilization","text":"Resource utilization in the last x hours","title":"Get-CTXAPI_ResourceUtilization"},{"location":"#get-ctxapi_sessions","text":"Return details about current sessions","title":"Get-CTXAPI_Sessions"},{"location":"#get-ctxapi_sitedetails","text":"Return details about your farm / site","title":"Get-CTXAPI_SiteDetails"},{"location":"#get-ctxapi_tests","text":"Run Built in Citrix cloud tests","title":"Get-CTXAPI_Tests"},{"location":"#get-ctxapi_vdauptime","text":"Uses Registration date to calculate uptime","title":"Get-CTXAPI_VDAUptime"},{"location":"#get-ctxapi_zone","text":"Get zone details","title":"Get-CTXAPI_Zone"},{"location":"#notes","text":"","title":"NOTES"},{"location":"#ctxcloudapi_1","text":"","title":"CTXCloudApi"},{"location":"#getting-started","text":"You will need access to the Citrix Cloud API. Follow Get API Access to gain access. Install-Module -Name CTXCloudApi -Verbose Import-Module CTXCloudApi -Verbose -Force Get-Command -Module CTXCloudApi Run Connect-CTXAPI with the details obtained from above. This connect and create the needed headers for other commands.","title":"Getting Started"},{"location":"#example-1","text":"$splat = @{ Customer_Id = \"xxx\" Client_Id = \"xxx-xxx-xxx-xxx\" Client_Secret = \"yyyyyy==\" Customer_Name = 'HomeLab' } $APIHeader = Connect-CTXAPI @splat Get-CTXAPI_HealthCheck -APIHeader $APIHeader -region eu -ReportPath C:\\Temp\\","title":"Example 1:"},{"location":"#html-reports","text":"When creating a HTML report: The logo can be changed by replacing the variable - `$Global:Logourl` ='URL to your logo' The colors of the report can be changed, by replacing: - `$global:colour1` = '# number of color' - `$global:colour2` = '# number of color' Or permanently replace it by editing the following file - `<Module base>\\Private\\Reports-Variables.ps1`","title":"HTML Reports"},{"location":"#see-also","text":"https://github.com/smitpi/CTXCloudApi","title":"SEE ALSO"},{"location":"CTXCloudApi/","text":"CTXCloudApi Module Description Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports CTXCloudApi Cmdlets Connect-CTXAPI Connect to the cloud and create needed api headers Get-CTXAPI_Applications Return details about published apps Get-CTXAPI_CloudConnectors Details about current Cloud Connectors Get-CTXAPI_CloudServices Return details about cloud services and subscription Get-CTXAPI_ConfigAudit Reports on system config Get-CTXAPI_ConfigLog Get high level configuration changes in the last x days. Get-CTXAPI_ConnectionReport Creates Connection report Get-CTXAPI_DeliveryGroups Return details about Delivery Groups Get-CTXAPI_FailureReport Reports on failures in the last x hours. Get-CTXAPI_HealthCheck Show useful information for daily health check Get-CTXAPI_Hypervisors Return details about hosting (hypervisor) Get-CTXAPI_LowLevelOperations Return details about low lever config change (More detailed) Get-CTXAPI_MachineCatalogs Return details about machine catalogs Get-CTXAPI_Machines Return details about vda machines Get-CTXAPI_MonitorData Collect Monitoring OData for other reports Get-CTXAPI_ResourceLocations Get cloud Resource Locations Get-CTXAPI_ResourceUtilization Resource utilization in the last x hours Get-CTXAPI_Sessions Return details about current sessions Get-CTXAPI_SiteDetails Return details about your farm / site Get-CTXAPI_Tests Run Built in Citrix cloud tests Get-CTXAPI_VDAUptime Uses Registration date to calculate uptime Get-CTXAPI_Zone Get zone details","title":"CTXCloudApi Module"},{"location":"CTXCloudApi/#ctxcloudapi-module","text":"","title":"CTXCloudApi Module"},{"location":"CTXCloudApi/#description","text":"Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports","title":"Description"},{"location":"CTXCloudApi/#ctxcloudapi-cmdlets","text":"","title":"CTXCloudApi Cmdlets"},{"location":"CTXCloudApi/#connect-ctxapi","text":"Connect to the cloud and create needed api headers","title":"Connect-CTXAPI"},{"location":"CTXCloudApi/#get-ctxapi_applications","text":"Return details about published apps","title":"Get-CTXAPI_Applications"},{"location":"CTXCloudApi/#get-ctxapi_cloudconnectors","text":"Details about current Cloud Connectors","title":"Get-CTXAPI_CloudConnectors"},{"location":"CTXCloudApi/#get-ctxapi_cloudservices","text":"Return details about cloud services and subscription","title":"Get-CTXAPI_CloudServices"},{"location":"CTXCloudApi/#get-ctxapi_configaudit","text":"Reports on system config","title":"Get-CTXAPI_ConfigAudit"},{"location":"CTXCloudApi/#get-ctxapi_configlog","text":"Get high level configuration changes in the last x days.","title":"Get-CTXAPI_ConfigLog"},{"location":"CTXCloudApi/#get-ctxapi_connectionreport","text":"Creates Connection report","title":"Get-CTXAPI_ConnectionReport"},{"location":"CTXCloudApi/#get-ctxapi_deliverygroups","text":"Return details about Delivery Groups","title":"Get-CTXAPI_DeliveryGroups"},{"location":"CTXCloudApi/#get-ctxapi_failurereport","text":"Reports on failures in the last x hours.","title":"Get-CTXAPI_FailureReport"},{"location":"CTXCloudApi/#get-ctxapi_healthcheck","text":"Show useful information for daily health check","title":"Get-CTXAPI_HealthCheck"},{"location":"CTXCloudApi/#get-ctxapi_hypervisors","text":"Return details about hosting (hypervisor)","title":"Get-CTXAPI_Hypervisors"},{"location":"CTXCloudApi/#get-ctxapi_lowleveloperations","text":"Return details about low lever config change (More detailed)","title":"Get-CTXAPI_LowLevelOperations"},{"location":"CTXCloudApi/#get-ctxapi_machinecatalogs","text":"Return details about machine catalogs","title":"Get-CTXAPI_MachineCatalogs"},{"location":"CTXCloudApi/#get-ctxapi_machines","text":"Return details about vda machines","title":"Get-CTXAPI_Machines"},{"location":"CTXCloudApi/#get-ctxapi_monitordata","text":"Collect Monitoring OData for other reports","title":"Get-CTXAPI_MonitorData"},{"location":"CTXCloudApi/#get-ctxapi_resourcelocations","text":"Get cloud Resource Locations","title":"Get-CTXAPI_ResourceLocations"},{"location":"CTXCloudApi/#get-ctxapi_resourceutilization","text":"Resource utilization in the last x hours","title":"Get-CTXAPI_ResourceUtilization"},{"location":"CTXCloudApi/#get-ctxapi_sessions","text":"Return details about current sessions","title":"Get-CTXAPI_Sessions"},{"location":"CTXCloudApi/#get-ctxapi_sitedetails","text":"Return details about your farm / site","title":"Get-CTXAPI_SiteDetails"},{"location":"CTXCloudApi/#get-ctxapi_tests","text":"Run Built in Citrix cloud tests","title":"Get-CTXAPI_Tests"},{"location":"CTXCloudApi/#get-ctxapi_vdauptime","text":"Uses Registration date to calculate uptime","title":"Get-CTXAPI_VDAUptime"},{"location":"CTXCloudApi/#get-ctxapi_zone","text":"Get zone details","title":"Get-CTXAPI_Zone"},{"location":"Connect-CTXAPI/","text":"Connect-CTXAPI SYNOPSIS Connect to the cloud and create needed api headers SYNTAX Connect-CTXAPI [-Customer_Id] <String> [-Client_Id] <String> [-Client_Secret] <String> [-Customer_Name] <String> [<CommonParameters>] DESCRIPTION Connect to the cloud and create needed api headers EXAMPLES EXAMPLE 1 $splat = @{ Customer_Id = \"xxx\" Client_Id = \"xxx-xxx-xxx-xxx\" Client_Secret = \"yyyyyy==\" Customer_Name = 'HomeLab' } $APIHeader = Connect-CTXAPI @splat PARAMETERS -Customer_Id From Citrix Cloud Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -Client_Id From Citrix Cloud Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -Client_Secret From Citrix Cloud Type: String Parameter Sets: (All) Aliases: Required: True Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False -Customer_Name Name of your Company, or what you want to call your connection Type: String Parameter Sets: (All) Aliases: Required: True Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS NOTES RELATED LINKS","title":"Connect-CTXAPI"},{"location":"Connect-CTXAPI/#connect-ctxapi","text":"","title":"Connect-CTXAPI"},{"location":"Connect-CTXAPI/#synopsis","text":"Connect to the cloud and create needed api headers","title":"SYNOPSIS"},{"location":"Connect-CTXAPI/#syntax","text":"Connect-CTXAPI [-Customer_Id] <String> [-Client_Id] <String> [-Client_Secret] <String> [-Customer_Name] <String> [<CommonParameters>]","title":"SYNTAX"},{"location":"Connect-CTXAPI/#description","text":"Connect to the cloud and create needed api headers","title":"DESCRIPTION"},{"location":"Connect-CTXAPI/#examples","text":"","title":"EXAMPLES"},{"location":"Connect-CTXAPI/#example-1","text":"$splat = @{ Customer_Id = \"xxx\" Client_Id = \"xxx-xxx-xxx-xxx\" Client_Secret = \"yyyyyy==\" Customer_Name = 'HomeLab' } $APIHeader = Connect-CTXAPI @splat","title":"EXAMPLE 1"},{"location":"Connect-CTXAPI/#parameters","text":"","title":"PARAMETERS"},{"location":"Connect-CTXAPI/#-customer_id","text":"From Citrix Cloud Type: String Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-Customer_Id"},{"location":"Connect-CTXAPI/#-client_id","text":"From Citrix Cloud Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-Client_Id"},{"location":"Connect-CTXAPI/#-client_secret","text":"From Citrix Cloud Type: String Parameter Sets: (All) Aliases: Required: True Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-Client_Secret"},{"location":"Connect-CTXAPI/#-customer_name","text":"Name of your Company, or what you want to call your connection Type: String Parameter Sets: (All) Aliases: Required: True Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-Customer_Name"},{"location":"Connect-CTXAPI/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Connect-CTXAPI/#inputs","text":"","title":"INPUTS"},{"location":"Connect-CTXAPI/#outputs","text":"","title":"OUTPUTS"},{"location":"Connect-CTXAPI/#notes","text":"","title":"NOTES"},{"location":"Connect-CTXAPI/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_Applications/","text":"Get-CTXAPI_Applications SYNOPSIS Return details about published apps SYNTAX Get-CTXAPI_Applications [-APIHeader] <Object> [<CommonParameters>] DESCRIPTION Return details about published apps EXAMPLES EXAMPLE 1 Get-CTXAPI_Applications -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_Applications"},{"location":"Get-CTXAPI_Applications/#get-ctxapi_applications","text":"","title":"Get-CTXAPI_Applications"},{"location":"Get-CTXAPI_Applications/#synopsis","text":"Return details about published apps","title":"SYNOPSIS"},{"location":"Get-CTXAPI_Applications/#syntax","text":"Get-CTXAPI_Applications [-APIHeader] <Object> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_Applications/#description","text":"Return details about published apps","title":"DESCRIPTION"},{"location":"Get-CTXAPI_Applications/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_Applications/#example-1","text":"Get-CTXAPI_Applications -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_Applications/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_Applications/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_Applications/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_Applications/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_Applications/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_Applications/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_Applications/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_Applications/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_CloudConnectors/","text":"Get-CTXAPI_CloudConnectors SYNOPSIS Details about current Cloud Connectors SYNTAX Get-CTXAPI_CloudConnectors [-APIHeader] <Object> [<CommonParameters>] DESCRIPTION Details about current Cloud Connectors EXAMPLES EXAMPLE 1 Get-CTXAPI_CloudConnectors -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_CloudConnectors"},{"location":"Get-CTXAPI_CloudConnectors/#get-ctxapi_cloudconnectors","text":"","title":"Get-CTXAPI_CloudConnectors"},{"location":"Get-CTXAPI_CloudConnectors/#synopsis","text":"Details about current Cloud Connectors","title":"SYNOPSIS"},{"location":"Get-CTXAPI_CloudConnectors/#syntax","text":"Get-CTXAPI_CloudConnectors [-APIHeader] <Object> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_CloudConnectors/#description","text":"Details about current Cloud Connectors","title":"DESCRIPTION"},{"location":"Get-CTXAPI_CloudConnectors/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_CloudConnectors/#example-1","text":"Get-CTXAPI_CloudConnectors -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_CloudConnectors/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_CloudConnectors/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_CloudConnectors/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_CloudConnectors/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_CloudConnectors/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_CloudConnectors/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_CloudConnectors/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_CloudConnectors/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_CloudServices/","text":"Get-CTXAPI_CloudServices SYNOPSIS Return details about cloud services and subscription SYNTAX Get-CTXAPI_CloudServices [-APIHeader] <Object> [<CommonParameters>] DESCRIPTION Return details about cloud services and subscription EXAMPLES EXAMPLE 1 Get-CTXAPI_CloudServices -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_CloudServices"},{"location":"Get-CTXAPI_CloudServices/#get-ctxapi_cloudservices","text":"","title":"Get-CTXAPI_CloudServices"},{"location":"Get-CTXAPI_CloudServices/#synopsis","text":"Return details about cloud services and subscription","title":"SYNOPSIS"},{"location":"Get-CTXAPI_CloudServices/#syntax","text":"Get-CTXAPI_CloudServices [-APIHeader] <Object> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_CloudServices/#description","text":"Return details about cloud services and subscription","title":"DESCRIPTION"},{"location":"Get-CTXAPI_CloudServices/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_CloudServices/#example-1","text":"Get-CTXAPI_CloudServices -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_CloudServices/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_CloudServices/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_CloudServices/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_CloudServices/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_CloudServices/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_CloudServices/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_CloudServices/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_CloudServices/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_ConfigAudit/","text":"Get-CTXAPI_ConfigAudit SYNOPSIS Reports on system config SYNTAX Get-CTXAPI_ConfigAudit [-APIHeader] <Object> [-Export] <String> [[-ReportPath] <String>] [<CommonParameters>] DESCRIPTION Reports on machine catalog, delivery groups and published desktops EXAMPLES EXAMPLE 1 Get-CTXAPI_ConfigAudit -APIHeader $APIHeader -Export Excel -ReportPath C:\\Temp PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -Export In what format to export the reports Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -ReportPath Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS NOTES RELATED LINKS","title":"Get-CTXAPI_ConfigAudit"},{"location":"Get-CTXAPI_ConfigAudit/#get-ctxapi_configaudit","text":"","title":"Get-CTXAPI_ConfigAudit"},{"location":"Get-CTXAPI_ConfigAudit/#synopsis","text":"Reports on system config","title":"SYNOPSIS"},{"location":"Get-CTXAPI_ConfigAudit/#syntax","text":"Get-CTXAPI_ConfigAudit [-APIHeader] <Object> [-Export] <String> [[-ReportPath] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_ConfigAudit/#description","text":"Reports on machine catalog, delivery groups and published desktops","title":"DESCRIPTION"},{"location":"Get-CTXAPI_ConfigAudit/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_ConfigAudit/#example-1","text":"Get-CTXAPI_ConfigAudit -APIHeader $APIHeader -Export Excel -ReportPath C:\\Temp","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_ConfigAudit/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_ConfigAudit/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_ConfigAudit/#-export","text":"In what format to export the reports Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-Export"},{"location":"Get-CTXAPI_ConfigAudit/#-reportpath","text":"Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False","title":"-ReportPath"},{"location":"Get-CTXAPI_ConfigAudit/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_ConfigAudit/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_ConfigAudit/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_ConfigAudit/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_ConfigAudit/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_ConfigLog/","text":"Get-CTXAPI_ConfigLog SYNOPSIS Get high level configuration changes in the last x days. SYNTAX Get-CTXAPI_ConfigLog [-APIHeader] <Object> [-Days] <String> [<CommonParameters>] DESCRIPTION Get high level configuration changes in the last x days. EXAMPLES EXAMPLE 1 Get-CTXAPI_ConfigLog -APIHeader $APIHeader -Days 15 PARAMETERS -APIHeader Use Connect-CTXAPI to create headers. Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -Days Number of days to report on. Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS NOTES RELATED LINKS","title":"Get-CTXAPI_ConfigLog"},{"location":"Get-CTXAPI_ConfigLog/#get-ctxapi_configlog","text":"","title":"Get-CTXAPI_ConfigLog"},{"location":"Get-CTXAPI_ConfigLog/#synopsis","text":"Get high level configuration changes in the last x days.","title":"SYNOPSIS"},{"location":"Get-CTXAPI_ConfigLog/#syntax","text":"Get-CTXAPI_ConfigLog [-APIHeader] <Object> [-Days] <String> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_ConfigLog/#description","text":"Get high level configuration changes in the last x days.","title":"DESCRIPTION"},{"location":"Get-CTXAPI_ConfigLog/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_ConfigLog/#example-1","text":"Get-CTXAPI_ConfigLog -APIHeader $APIHeader -Days 15","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_ConfigLog/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_ConfigLog/#-apiheader","text":"Use Connect-CTXAPI to create headers. Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_ConfigLog/#-days","text":"Number of days to report on. Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-Days"},{"location":"Get-CTXAPI_ConfigLog/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_ConfigLog/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_ConfigLog/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_ConfigLog/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_ConfigLog/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_ConnectionReport/","text":"Get-CTXAPI_ConnectionReport SYNOPSIS Creates Connection report SYNTAX Fetch odata (Default) Get-CTXAPI_ConnectionReport -APIHeader <Object> [-region <String>] [-hours <Int32>] [-Export <String>] [-ReportPath <String>] [<CommonParameters>] Got odata Get-CTXAPI_ConnectionReport [-MonitorData <Object>] [-Export <String>] [-ReportPath <String>] [<CommonParameters>] DESCRIPTION Report on connections in the last x hours EXAMPLES EXAMPLE 1 Get-CTXAPI_ConnectionReport -MonitorData $MonitorData -Export HTML -ReportPath c:\\temp PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: Fetch odata Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -MonitorData Use Get-CTXAPI_MonitorData to create OData Type: Object Parameter Sets: Got odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -region You Cloud region Type: String Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -hours Duration of the report Type: Int32 Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: 24 Accept pipeline input: False Accept wildcard characters: False -Export In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: Host Accept pipeline input: False Accept wildcard characters: False -ReportPath Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS NOTES RELATED LINKS","title":"Get-CTXAPI_ConnectionReport"},{"location":"Get-CTXAPI_ConnectionReport/#get-ctxapi_connectionreport","text":"","title":"Get-CTXAPI_ConnectionReport"},{"location":"Get-CTXAPI_ConnectionReport/#synopsis","text":"Creates Connection report","title":"SYNOPSIS"},{"location":"Get-CTXAPI_ConnectionReport/#syntax","text":"","title":"SYNTAX"},{"location":"Get-CTXAPI_ConnectionReport/#fetch-odata-default","text":"Get-CTXAPI_ConnectionReport -APIHeader <Object> [-region <String>] [-hours <Int32>] [-Export <String>] [-ReportPath <String>] [<CommonParameters>]","title":"Fetch odata (Default)"},{"location":"Get-CTXAPI_ConnectionReport/#got-odata","text":"Get-CTXAPI_ConnectionReport [-MonitorData <Object>] [-Export <String>] [-ReportPath <String>] [<CommonParameters>]","title":"Got odata"},{"location":"Get-CTXAPI_ConnectionReport/#description","text":"Report on connections in the last x hours","title":"DESCRIPTION"},{"location":"Get-CTXAPI_ConnectionReport/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_ConnectionReport/#example-1","text":"Get-CTXAPI_ConnectionReport -MonitorData $MonitorData -Export HTML -ReportPath c:\\temp","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_ConnectionReport/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_ConnectionReport/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: Fetch odata Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_ConnectionReport/#-monitordata","text":"Use Get-CTXAPI_MonitorData to create OData Type: Object Parameter Sets: Got odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-MonitorData"},{"location":"Get-CTXAPI_ConnectionReport/#-region","text":"You Cloud region Type: String Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-region"},{"location":"Get-CTXAPI_ConnectionReport/#-hours","text":"Duration of the report Type: Int32 Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: 24 Accept pipeline input: False Accept wildcard characters: False","title":"-hours"},{"location":"Get-CTXAPI_ConnectionReport/#-export","text":"In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: Host Accept pipeline input: False Accept wildcard characters: False","title":"-Export"},{"location":"Get-CTXAPI_ConnectionReport/#-reportpath","text":"Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False","title":"-ReportPath"},{"location":"Get-CTXAPI_ConnectionReport/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_ConnectionReport/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_ConnectionReport/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_ConnectionReport/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_ConnectionReport/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_DeliveryGroups/","text":"Get-CTXAPI_DeliveryGroups SYNOPSIS Return details about Delivery Groups SYNTAX Get-CTXAPI_DeliveryGroups [-APIHeader] <Object> [<CommonParameters>] DESCRIPTION Return details about Delivery Groups EXAMPLES EXAMPLE 1 Get-CTXAPI_DeliveryGroup -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_DeliveryGroups"},{"location":"Get-CTXAPI_DeliveryGroups/#get-ctxapi_deliverygroups","text":"","title":"Get-CTXAPI_DeliveryGroups"},{"location":"Get-CTXAPI_DeliveryGroups/#synopsis","text":"Return details about Delivery Groups","title":"SYNOPSIS"},{"location":"Get-CTXAPI_DeliveryGroups/#syntax","text":"Get-CTXAPI_DeliveryGroups [-APIHeader] <Object> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_DeliveryGroups/#description","text":"Return details about Delivery Groups","title":"DESCRIPTION"},{"location":"Get-CTXAPI_DeliveryGroups/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_DeliveryGroups/#example-1","text":"Get-CTXAPI_DeliveryGroup -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_DeliveryGroups/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_DeliveryGroups/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_DeliveryGroups/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_DeliveryGroups/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_DeliveryGroups/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_DeliveryGroups/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_DeliveryGroups/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_DeliveryGroups/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_FailureReport/","text":"Get-CTXAPI_FailureReport SYNOPSIS Reports on failures in the last x hours. SYNTAX Fetch odata (Default) Get-CTXAPI_FailureReport -APIHeader <Object> [-region <String>] [-hours <Int32>] -FailureType <String> [-Export <String>] [-ReportPath <String>] [<CommonParameters>] Got odata Get-CTXAPI_FailureReport [-MonitorData <Object>] -FailureType <String> [-Export <String>] [-ReportPath <String>] [<CommonParameters>] DESCRIPTION Reports on machine or connewction failures in the last x hours. EXAMPLES EXAMPLE 1 Get-CTXAPI_FailureReport -MonitorData $MonitorData -FailureType Connection PARAMETERS -APIHeader Use Connect-CTXAPI to create headers. Type: Object Parameter Sets: Fetch odata Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -MonitorData Use Get-CTXAPI_MonitorData to create OData. Type: Object Parameter Sets: Got odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -region Your Cloud instance hosted region. Type: String Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -hours Amount of time to report on. Type: Int32 Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: 24 Accept pipeline input: False Accept wildcard characters: False -FailureType Type of failure to report on Type: String Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -Export In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: Host Accept pipeline input: False Accept wildcard characters: False -ReportPath Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_FailureReport"},{"location":"Get-CTXAPI_FailureReport/#get-ctxapi_failurereport","text":"","title":"Get-CTXAPI_FailureReport"},{"location":"Get-CTXAPI_FailureReport/#synopsis","text":"Reports on failures in the last x hours.","title":"SYNOPSIS"},{"location":"Get-CTXAPI_FailureReport/#syntax","text":"","title":"SYNTAX"},{"location":"Get-CTXAPI_FailureReport/#fetch-odata-default","text":"Get-CTXAPI_FailureReport -APIHeader <Object> [-region <String>] [-hours <Int32>] -FailureType <String> [-Export <String>] [-ReportPath <String>] [<CommonParameters>]","title":"Fetch odata (Default)"},{"location":"Get-CTXAPI_FailureReport/#got-odata","text":"Get-CTXAPI_FailureReport [-MonitorData <Object>] -FailureType <String> [-Export <String>] [-ReportPath <String>] [<CommonParameters>]","title":"Got odata"},{"location":"Get-CTXAPI_FailureReport/#description","text":"Reports on machine or connewction failures in the last x hours.","title":"DESCRIPTION"},{"location":"Get-CTXAPI_FailureReport/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_FailureReport/#example-1","text":"Get-CTXAPI_FailureReport -MonitorData $MonitorData -FailureType Connection","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_FailureReport/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_FailureReport/#-apiheader","text":"Use Connect-CTXAPI to create headers. Type: Object Parameter Sets: Fetch odata Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_FailureReport/#-monitordata","text":"Use Get-CTXAPI_MonitorData to create OData. Type: Object Parameter Sets: Got odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-MonitorData"},{"location":"Get-CTXAPI_FailureReport/#-region","text":"Your Cloud instance hosted region. Type: String Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-region"},{"location":"Get-CTXAPI_FailureReport/#-hours","text":"Amount of time to report on. Type: Int32 Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: 24 Accept pipeline input: False Accept wildcard characters: False","title":"-hours"},{"location":"Get-CTXAPI_FailureReport/#-failuretype","text":"Type of failure to report on Type: String Parameter Sets: (All) Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-FailureType"},{"location":"Get-CTXAPI_FailureReport/#-export","text":"In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: Host Accept pipeline input: False Accept wildcard characters: False","title":"-Export"},{"location":"Get-CTXAPI_FailureReport/#-reportpath","text":"Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False","title":"-ReportPath"},{"location":"Get-CTXAPI_FailureReport/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_FailureReport/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_FailureReport/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_FailureReport/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_FailureReport/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_FailureReport/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_HealthCheck/","text":"Get-CTXAPI_HealthCheck SYNOPSIS Show useful information for daily health check SYNTAX Get-CTXAPI_HealthCheck [-APIHeader] <Object> [-region] <String> [[-ReportPath] <String>] [<CommonParameters>] DESCRIPTION Show useful information for daily health check EXAMPLES EXAMPLE 1 Get-CTXAPI_HealthCheck -APIHeader $APIHeader -region eu -ReportPath C:\\Temp PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -region Your Cloud instance hosted region. Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -ReportPath Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS NOTES RELATED LINKS","title":"Get-CTXAPI_HealthCheck"},{"location":"Get-CTXAPI_HealthCheck/#get-ctxapi_healthcheck","text":"","title":"Get-CTXAPI_HealthCheck"},{"location":"Get-CTXAPI_HealthCheck/#synopsis","text":"Show useful information for daily health check","title":"SYNOPSIS"},{"location":"Get-CTXAPI_HealthCheck/#syntax","text":"Get-CTXAPI_HealthCheck [-APIHeader] <Object> [-region] <String> [[-ReportPath] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_HealthCheck/#description","text":"Show useful information for daily health check","title":"DESCRIPTION"},{"location":"Get-CTXAPI_HealthCheck/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_HealthCheck/#example-1","text":"Get-CTXAPI_HealthCheck -APIHeader $APIHeader -region eu -ReportPath C:\\Temp","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_HealthCheck/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_HealthCheck/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_HealthCheck/#-region","text":"Your Cloud instance hosted region. Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-region"},{"location":"Get-CTXAPI_HealthCheck/#-reportpath","text":"Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False","title":"-ReportPath"},{"location":"Get-CTXAPI_HealthCheck/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_HealthCheck/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_HealthCheck/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_HealthCheck/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_HealthCheck/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_Hypervisors/","text":"Get-CTXAPI_Hypervisors SYNOPSIS Return details about hosting (hypervisor) SYNTAX Get-CTXAPI_Hypervisors [-APIHeader] <Object> [<CommonParameters>] DESCRIPTION Return details about hosting (hypervisor) EXAMPLES EXAMPLE 1 Get-CTXAPI_Hypervisor -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_Hypervisors"},{"location":"Get-CTXAPI_Hypervisors/#get-ctxapi_hypervisors","text":"","title":"Get-CTXAPI_Hypervisors"},{"location":"Get-CTXAPI_Hypervisors/#synopsis","text":"Return details about hosting (hypervisor)","title":"SYNOPSIS"},{"location":"Get-CTXAPI_Hypervisors/#syntax","text":"Get-CTXAPI_Hypervisors [-APIHeader] <Object> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_Hypervisors/#description","text":"Return details about hosting (hypervisor)","title":"DESCRIPTION"},{"location":"Get-CTXAPI_Hypervisors/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_Hypervisors/#example-1","text":"Get-CTXAPI_Hypervisor -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_Hypervisors/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_Hypervisors/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_Hypervisors/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_Hypervisors/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_Hypervisors/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_Hypervisors/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_Hypervisors/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_Hypervisors/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_LowLevelOperations/","text":"Get-CTXAPI_LowLevelOperations SYNOPSIS Return details about low lever config change (More detailed) SYNTAX Get-CTXAPI_LowLevelOperations [-APIHeader] <Object> [-HighLevelID] <String> [<CommonParameters>] DESCRIPTION Return details about low lever config change (More detailed) EXAMPLES EXAMPLE 1 $ConfigLog = Get-CTXAPI_ConfigLog -APIHeader $APIHeader -Days 7 $LowLevelOperations = Get-CTXAPI_LowLevelOperations -APIHeader $APIHeader -HighLevelID $ConfigLog[0].id PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -HighLevelID Unique id for a config change. From the Get-CTXAPI_ConfigLog function. Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_LowLevelOperations"},{"location":"Get-CTXAPI_LowLevelOperations/#get-ctxapi_lowleveloperations","text":"","title":"Get-CTXAPI_LowLevelOperations"},{"location":"Get-CTXAPI_LowLevelOperations/#synopsis","text":"Return details about low lever config change (More detailed)","title":"SYNOPSIS"},{"location":"Get-CTXAPI_LowLevelOperations/#syntax","text":"Get-CTXAPI_LowLevelOperations [-APIHeader] <Object> [-HighLevelID] <String> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_LowLevelOperations/#description","text":"Return details about low lever config change (More detailed)","title":"DESCRIPTION"},{"location":"Get-CTXAPI_LowLevelOperations/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_LowLevelOperations/#example-1","text":"$ConfigLog = Get-CTXAPI_ConfigLog -APIHeader $APIHeader -Days 7 $LowLevelOperations = Get-CTXAPI_LowLevelOperations -APIHeader $APIHeader -HighLevelID $ConfigLog[0].id","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_LowLevelOperations/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_LowLevelOperations/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_LowLevelOperations/#-highlevelid","text":"Unique id for a config change. From the Get-CTXAPI_ConfigLog function. Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-HighLevelID"},{"location":"Get-CTXAPI_LowLevelOperations/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_LowLevelOperations/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_LowLevelOperations/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_LowLevelOperations/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_LowLevelOperations/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_LowLevelOperations/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_MachineCatalogs/","text":"Get-CTXAPI_MachineCatalogs SYNOPSIS Return details about machine catalogs SYNTAX Get-CTXAPI_MachineCatalogs [-APIHeader] <Object> [<CommonParameters>] DESCRIPTION Return details about machine catalogs EXAMPLES EXAMPLE 1 $MachineCatalogs = Get-CTXAPI_MachineCatalogs -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_MachineCatalogs"},{"location":"Get-CTXAPI_MachineCatalogs/#get-ctxapi_machinecatalogs","text":"","title":"Get-CTXAPI_MachineCatalogs"},{"location":"Get-CTXAPI_MachineCatalogs/#synopsis","text":"Return details about machine catalogs","title":"SYNOPSIS"},{"location":"Get-CTXAPI_MachineCatalogs/#syntax","text":"Get-CTXAPI_MachineCatalogs [-APIHeader] <Object> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_MachineCatalogs/#description","text":"Return details about machine catalogs","title":"DESCRIPTION"},{"location":"Get-CTXAPI_MachineCatalogs/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_MachineCatalogs/#example-1","text":"$MachineCatalogs = Get-CTXAPI_MachineCatalogs -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_MachineCatalogs/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_MachineCatalogs/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_MachineCatalogs/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_MachineCatalogs/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_MachineCatalogs/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_MachineCatalogs/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_MachineCatalogs/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_MachineCatalogs/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_Machines/","text":"Get-CTXAPI_Machines SYNOPSIS Return details about vda machines SYNTAX Get-CTXAPI_Machines [-APIHeader] <Object> [-GetPubDesktop] [<CommonParameters>] DESCRIPTION Return details about vda machines EXAMPLES EXAMPLE 1 $machines = Get-CTXAPI_Machines -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -GetPubDesktop Get published desktop details Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_Machines"},{"location":"Get-CTXAPI_Machines/#get-ctxapi_machines","text":"","title":"Get-CTXAPI_Machines"},{"location":"Get-CTXAPI_Machines/#synopsis","text":"Return details about vda machines","title":"SYNOPSIS"},{"location":"Get-CTXAPI_Machines/#syntax","text":"Get-CTXAPI_Machines [-APIHeader] <Object> [-GetPubDesktop] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_Machines/#description","text":"Return details about vda machines","title":"DESCRIPTION"},{"location":"Get-CTXAPI_Machines/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_Machines/#example-1","text":"$machines = Get-CTXAPI_Machines -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_Machines/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_Machines/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_Machines/#-getpubdesktop","text":"Get published desktop details Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-GetPubDesktop"},{"location":"Get-CTXAPI_Machines/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_Machines/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_Machines/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_Machines/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_Machines/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_Machines/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_MonitorData/","text":"Get-CTXAPI_MonitorData SYNOPSIS Collect Monitoring OData for other reports SYNTAX Get-CTXAPI_MonitorData [-APIHeader] <Object> [-region] <String> [-hours] <Int32> [<CommonParameters>] DESCRIPTION Collect Monitoring OData for other reports EXAMPLES EXAMPLE 1 $MonitorData = Get-CTXAPI_MonitorData -APIHeader $APIHeader -region eu -hours 24 PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -region Your Cloud instance hosted region. Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False -hours Amount of time to report on. Type: Int32 Parameter Sets: (All) Aliases: Required: True Position: 3 Default value: 0 Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS NOTES RELATED LINKS","title":"Get-CTXAPI_MonitorData"},{"location":"Get-CTXAPI_MonitorData/#get-ctxapi_monitordata","text":"","title":"Get-CTXAPI_MonitorData"},{"location":"Get-CTXAPI_MonitorData/#synopsis","text":"Collect Monitoring OData for other reports","title":"SYNOPSIS"},{"location":"Get-CTXAPI_MonitorData/#syntax","text":"Get-CTXAPI_MonitorData [-APIHeader] <Object> [-region] <String> [-hours] <Int32> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_MonitorData/#description","text":"Collect Monitoring OData for other reports","title":"DESCRIPTION"},{"location":"Get-CTXAPI_MonitorData/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_MonitorData/#example-1","text":"$MonitorData = Get-CTXAPI_MonitorData -APIHeader $APIHeader -region eu -hours 24","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_MonitorData/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_MonitorData/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_MonitorData/#-region","text":"Your Cloud instance hosted region. Type: String Parameter Sets: (All) Aliases: Required: True Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-region"},{"location":"Get-CTXAPI_MonitorData/#-hours","text":"Amount of time to report on. Type: Int32 Parameter Sets: (All) Aliases: Required: True Position: 3 Default value: 0 Accept pipeline input: False Accept wildcard characters: False","title":"-hours"},{"location":"Get-CTXAPI_MonitorData/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_MonitorData/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_MonitorData/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_MonitorData/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_MonitorData/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_ResourceLocations/","text":"Get-CTXAPI_ResourceLocations SYNOPSIS Get cloud Resource Locations SYNTAX Get-CTXAPI_ResourceLocations [-APIHeader] <Object> [<CommonParameters>] DESCRIPTION Get cloud Resource Locations EXAMPLES EXAMPLE 1 Get-CTXAPI_ResourceLocation -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS NOTES RELATED LINKS","title":"Get-CTXAPI_ResourceLocations"},{"location":"Get-CTXAPI_ResourceLocations/#get-ctxapi_resourcelocations","text":"","title":"Get-CTXAPI_ResourceLocations"},{"location":"Get-CTXAPI_ResourceLocations/#synopsis","text":"Get cloud Resource Locations","title":"SYNOPSIS"},{"location":"Get-CTXAPI_ResourceLocations/#syntax","text":"Get-CTXAPI_ResourceLocations [-APIHeader] <Object> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_ResourceLocations/#description","text":"Get cloud Resource Locations","title":"DESCRIPTION"},{"location":"Get-CTXAPI_ResourceLocations/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_ResourceLocations/#example-1","text":"Get-CTXAPI_ResourceLocation -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_ResourceLocations/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_ResourceLocations/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_ResourceLocations/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_ResourceLocations/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_ResourceLocations/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_ResourceLocations/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_ResourceLocations/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_ResourceUtilization/","text":"Get-CTXAPI_ResourceUtilization SYNOPSIS Resource utilization in the last x hours SYNTAX Fetch odata (Default) Get-CTXAPI_ResourceUtilization -APIHeader <Object> [-region <String>] [-hours <Int32>] [-Export <String>] [-ReportPath <String>] [<CommonParameters>] Got odata Get-CTXAPI_ResourceUtilization [-MonitorData <Object>] [-Export <String>] [-ReportPath <String>] [<CommonParameters>] DESCRIPTION Resource utilization in the last x hours EXAMPLES EXAMPLE 1 Get-CTXAPI_ResourceUtilization -MonitorData $MonitorData -Export excel -ReportPath C:\\temp\\ PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: Fetch odata Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -MonitorData Use Get-CTXAPI_MonitorData to create OData Type: Object Parameter Sets: Got odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -region Your Cloud instance hosted region. Type: String Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -hours Amount of time to report on. Type: Int32 Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: 24 Accept pipeline input: False Accept wildcard characters: False -Export In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: Host Accept pipeline input: False Accept wildcard characters: False -ReportPath Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS NOTES RELATED LINKS","title":"Get-CTXAPI_ResourceUtilization"},{"location":"Get-CTXAPI_ResourceUtilization/#get-ctxapi_resourceutilization","text":"","title":"Get-CTXAPI_ResourceUtilization"},{"location":"Get-CTXAPI_ResourceUtilization/#synopsis","text":"Resource utilization in the last x hours","title":"SYNOPSIS"},{"location":"Get-CTXAPI_ResourceUtilization/#syntax","text":"","title":"SYNTAX"},{"location":"Get-CTXAPI_ResourceUtilization/#fetch-odata-default","text":"Get-CTXAPI_ResourceUtilization -APIHeader <Object> [-region <String>] [-hours <Int32>] [-Export <String>] [-ReportPath <String>] [<CommonParameters>]","title":"Fetch odata (Default)"},{"location":"Get-CTXAPI_ResourceUtilization/#got-odata","text":"Get-CTXAPI_ResourceUtilization [-MonitorData <Object>] [-Export <String>] [-ReportPath <String>] [<CommonParameters>]","title":"Got odata"},{"location":"Get-CTXAPI_ResourceUtilization/#description","text":"Resource utilization in the last x hours","title":"DESCRIPTION"},{"location":"Get-CTXAPI_ResourceUtilization/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_ResourceUtilization/#example-1","text":"Get-CTXAPI_ResourceUtilization -MonitorData $MonitorData -Export excel -ReportPath C:\\temp\\","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_ResourceUtilization/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_ResourceUtilization/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: Fetch odata Aliases: Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_ResourceUtilization/#-monitordata","text":"Use Get-CTXAPI_MonitorData to create OData Type: Object Parameter Sets: Got odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-MonitorData"},{"location":"Get-CTXAPI_ResourceUtilization/#-region","text":"Your Cloud instance hosted region. Type: String Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-region"},{"location":"Get-CTXAPI_ResourceUtilization/#-hours","text":"Amount of time to report on. Type: Int32 Parameter Sets: Fetch odata Aliases: Required: False Position: Named Default value: 24 Accept pipeline input: False Accept wildcard characters: False","title":"-hours"},{"location":"Get-CTXAPI_ResourceUtilization/#-export","text":"In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: Host Accept pipeline input: False Accept wildcard characters: False","title":"-Export"},{"location":"Get-CTXAPI_ResourceUtilization/#-reportpath","text":"Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: Named Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False","title":"-ReportPath"},{"location":"Get-CTXAPI_ResourceUtilization/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_ResourceUtilization/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_ResourceUtilization/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_ResourceUtilization/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_ResourceUtilization/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_Sessions/","text":"Get-CTXAPI_Sessions SYNOPSIS Return details about current sessions SYNTAX Get-CTXAPI_Sessions [-APIHeader] <Object> [<CommonParameters>] DESCRIPTION Return details about current sessions EXAMPLES EXAMPLE 1 Get-CTXAPI_Session -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_Sessions"},{"location":"Get-CTXAPI_Sessions/#get-ctxapi_sessions","text":"","title":"Get-CTXAPI_Sessions"},{"location":"Get-CTXAPI_Sessions/#synopsis","text":"Return details about current sessions","title":"SYNOPSIS"},{"location":"Get-CTXAPI_Sessions/#syntax","text":"Get-CTXAPI_Sessions [-APIHeader] <Object> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_Sessions/#description","text":"Return details about current sessions","title":"DESCRIPTION"},{"location":"Get-CTXAPI_Sessions/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_Sessions/#example-1","text":"Get-CTXAPI_Session -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_Sessions/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_Sessions/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_Sessions/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_Sessions/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_Sessions/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_Sessions/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_Sessions/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_Sessions/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_SiteDetails/","text":"Get-CTXAPI_SiteDetails SYNOPSIS Return details about your farm / site SYNTAX Get-CTXAPI_SiteDetails [-APIHeader] <Object> [<CommonParameters>] DESCRIPTION Return details about your farm / site EXAMPLES EXAMPLE 1 Get-CTXAPI_SiteDetail -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_SiteDetails"},{"location":"Get-CTXAPI_SiteDetails/#get-ctxapi_sitedetails","text":"","title":"Get-CTXAPI_SiteDetails"},{"location":"Get-CTXAPI_SiteDetails/#synopsis","text":"Return details about your farm / site","title":"SYNOPSIS"},{"location":"Get-CTXAPI_SiteDetails/#syntax","text":"Get-CTXAPI_SiteDetails [-APIHeader] <Object> [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_SiteDetails/#description","text":"Return details about your farm / site","title":"DESCRIPTION"},{"location":"Get-CTXAPI_SiteDetails/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_SiteDetails/#example-1","text":"Get-CTXAPI_SiteDetail -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_SiteDetails/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_SiteDetails/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_SiteDetails/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_SiteDetails/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_SiteDetails/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_SiteDetails/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_SiteDetails/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_SiteDetails/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_Tests/","text":"Get-CTXAPI_Tests SYNOPSIS Run Built in Citrix cloud tests SYNTAX Get-CTXAPI_Tests [[-APIHeader] <Object>] [-SiteTest] [-HypervisorsTest] [-DeliveryGroupsTest] [-MachineCatalogsTest] [[-Export] <String>] [[-ReportPath] <String>] [<CommonParameters>] DESCRIPTION Run Built in Citrix cloud tests EXAMPLES EXAMPLE 1 Get-CTXAPI_Tests -APIHeader $APIHeader -SiteTest -HypervisorsTest -DeliveryGroupsTest -MachineCatalogsTest -Export HTML -ReportPath C:\\temp PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -SiteTest Perform Site test Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False -HypervisorsTest Perform the Hypervisors Test Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False -DeliveryGroupsTest Perform the Delivery Groups Test Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False -MachineCatalogsTest Perform the Machine Catalogs Test Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False -Export In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: Host Accept pipeline input: False Accept wildcard characters: False -ReportPath Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Collections.Hashtable NOTES RELATED LINKS","title":"Get-CTXAPI_Tests"},{"location":"Get-CTXAPI_Tests/#get-ctxapi_tests","text":"","title":"Get-CTXAPI_Tests"},{"location":"Get-CTXAPI_Tests/#synopsis","text":"Run Built in Citrix cloud tests","title":"SYNOPSIS"},{"location":"Get-CTXAPI_Tests/#syntax","text":"Get-CTXAPI_Tests [[-APIHeader] <Object>] [-SiteTest] [-HypervisorsTest] [-DeliveryGroupsTest] [-MachineCatalogsTest] [[-Export] <String>] [[-ReportPath] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_Tests/#description","text":"Run Built in Citrix cloud tests","title":"DESCRIPTION"},{"location":"Get-CTXAPI_Tests/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_Tests/#example-1","text":"Get-CTXAPI_Tests -APIHeader $APIHeader -SiteTest -HypervisorsTest -DeliveryGroupsTest -MachineCatalogsTest -Export HTML -ReportPath C:\\temp","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_Tests/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_Tests/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_Tests/#-sitetest","text":"Perform Site test Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-SiteTest"},{"location":"Get-CTXAPI_Tests/#-hypervisorstest","text":"Perform the Hypervisors Test Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-HypervisorsTest"},{"location":"Get-CTXAPI_Tests/#-deliverygroupstest","text":"Perform the Delivery Groups Test Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-DeliveryGroupsTest"},{"location":"Get-CTXAPI_Tests/#-machinecatalogstest","text":"Perform the Machine Catalogs Test Type: SwitchParameter Parameter Sets: (All) Aliases: Required: False Position: Named Default value: False Accept pipeline input: False Accept wildcard characters: False","title":"-MachineCatalogsTest"},{"location":"Get-CTXAPI_Tests/#-export","text":"In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: Host Accept pipeline input: False Accept wildcard characters: False","title":"-Export"},{"location":"Get-CTXAPI_Tests/#-reportpath","text":"Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False","title":"-ReportPath"},{"location":"Get-CTXAPI_Tests/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_Tests/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_Tests/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_Tests/#systemcollectionshashtable","text":"","title":"System.Collections.Hashtable"},{"location":"Get-CTXAPI_Tests/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_Tests/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_VDAUptime/","text":"Get-CTXAPI_VDAUptime SYNOPSIS Uses Registration date to calculate uptime SYNTAX Get-CTXAPI_VDAUptime [-APIHeader] <Object> [[-Export] <String>] [[-ReportPath] <String>] [<CommonParameters>] DESCRIPTION Uses Registration date to calculate uptime EXAMPLES EXAMPLE 1 Get-CTXAPI_VDAUptime -APIHeader $APIHeader -Export excel -ReportPath C:\\temp\\ PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False -Export In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: Host Accept pipeline input: False Accept wildcard characters: False -ReportPath Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS NOTES RELATED LINKS","title":"Get-CTXAPI_VDAUptime"},{"location":"Get-CTXAPI_VDAUptime/#get-ctxapi_vdauptime","text":"","title":"Get-CTXAPI_VDAUptime"},{"location":"Get-CTXAPI_VDAUptime/#synopsis","text":"Uses Registration date to calculate uptime","title":"SYNOPSIS"},{"location":"Get-CTXAPI_VDAUptime/#syntax","text":"Get-CTXAPI_VDAUptime [-APIHeader] <Object> [[-Export] <String>] [[-ReportPath] <String>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_VDAUptime/#description","text":"Uses Registration date to calculate uptime","title":"DESCRIPTION"},{"location":"Get-CTXAPI_VDAUptime/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_VDAUptime/#example-1","text":"Get-CTXAPI_VDAUptime -APIHeader $APIHeader -Export excel -ReportPath C:\\temp\\","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_VDAUptime/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_VDAUptime/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: True Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_VDAUptime/#-export","text":"In what format to export the reports. Type: String Parameter Sets: (All) Aliases: Required: False Position: 2 Default value: Host Accept pipeline input: False Accept wildcard characters: False","title":"-Export"},{"location":"Get-CTXAPI_VDAUptime/#-reportpath","text":"Destination folder for the exported report. Type: String Parameter Sets: (All) Aliases: Required: False Position: 3 Default value: $env:temp Accept pipeline input: False Accept wildcard characters: False","title":"-ReportPath"},{"location":"Get-CTXAPI_VDAUptime/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_VDAUptime/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_VDAUptime/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_VDAUptime/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_VDAUptime/#related-links","text":"","title":"RELATED LINKS"},{"location":"Get-CTXAPI_Zone/","text":"Get-CTXAPI_Zone SYNOPSIS Get zone details SYNTAX Get-CTXAPI_Zone [[-APIHeader] <Object>] [<CommonParameters>] DESCRIPTION Get zone details EXAMPLES EXAMPLE 1 Get-CTXAPI_Zone -APIHeader $APIHeader PARAMETERS -APIHeader Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False 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 OUTPUTS System.Object[] NOTES RELATED LINKS","title":"Get-CTXAPI_Zone"},{"location":"Get-CTXAPI_Zone/#get-ctxapi_zone","text":"","title":"Get-CTXAPI_Zone"},{"location":"Get-CTXAPI_Zone/#synopsis","text":"Get zone details","title":"SYNOPSIS"},{"location":"Get-CTXAPI_Zone/#syntax","text":"Get-CTXAPI_Zone [[-APIHeader] <Object>] [<CommonParameters>]","title":"SYNTAX"},{"location":"Get-CTXAPI_Zone/#description","text":"Get zone details","title":"DESCRIPTION"},{"location":"Get-CTXAPI_Zone/#examples","text":"","title":"EXAMPLES"},{"location":"Get-CTXAPI_Zone/#example-1","text":"Get-CTXAPI_Zone -APIHeader $APIHeader","title":"EXAMPLE 1"},{"location":"Get-CTXAPI_Zone/#parameters","text":"","title":"PARAMETERS"},{"location":"Get-CTXAPI_Zone/#-apiheader","text":"Use Connect-CTXAPI to create headers Type: Object Parameter Sets: (All) Aliases: Required: False Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False","title":"-APIHeader"},{"location":"Get-CTXAPI_Zone/#commonparameters","text":"This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters .","title":"CommonParameters"},{"location":"Get-CTXAPI_Zone/#inputs","text":"","title":"INPUTS"},{"location":"Get-CTXAPI_Zone/#outputs","text":"","title":"OUTPUTS"},{"location":"Get-CTXAPI_Zone/#systemobject","text":"","title":"System.Object[]"},{"location":"Get-CTXAPI_Zone/#notes","text":"","title":"NOTES"},{"location":"Get-CTXAPI_Zone/#related-links","text":"","title":"RELATED LINKS"},{"location":"about_CTXCloudApi/","text":"CTXCloudApi about_CTXCloudApi SHORT DESCRIPTION Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports LONG DESCRIPTION Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports Connect-CTXAPI - Connect to the cloud and create needed api headers Get-CTXAPI_Applications - Return details about published apps Get-CTXAPI_CloudConnectors - Details about current Cloud Connectors Get-CTXAPI_CloudServices - Return details about cloud services and subscription Get-CTXAPI_ConfigAudit - Reports on system config Get-CTXAPI_ConfigLog - Get high level configuration changes in the last x days. Get-CTXAPI_ConnectionReport - Creates Connection report Get-CTXAPI_DeliveryGroups - Return details about Delivery Groups Get-CTXAPI_FailureReport - Reports on failures in the last x hours. Get-CTXAPI_HealthCheck - Show useful information for daily health check Get-CTXAPI_Hypervisors - Return details about hosting (hypervisor) Get-CTXAPI_LowLevelOperations - Return details about low lever config change (More detailed) Get-CTXAPI_MachineCatalogs - Return details about machine catalogs Get-CTXAPI_Machines - Return details about vda machines Get-CTXAPI_MonitorData - Collect Monitoring OData for other reports Get-CTXAPI_ResourceLocations - Get cloud Resource Locations Get-CTXAPI_ResourceUtilization - Resource utilization in the last x hours Get-CTXAPI_Sessions - Return details about current sessions Get-CTXAPI_SiteDetails - Return details about your farm / site Get-CTXAPI_Tests - Run Built in Citrix cloud tests Get-CTXAPI_VDAUptime - Uses Registration date to calculate uptime Get-CTXAPI_Zone - Get zone details EXAMPLES -------------------------- EXAMPLE 1 -------------------------- PS C:>$splat = @{ Customer_Id = \"xxx\" Client_Id = \"xxx-xxx-xxx-xxx\" Client_Secret = \"yyyyyy==\" Customer_Name = 'HomeLab' } $APIHeader = Connect-CTXAPI @splat -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Applications -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_CloudConnectors -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_CloudServices -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ConfigAudit -APIHeader $APIHeader -Export Excel -ReportPath C:\\Temp -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ConfigLog -APIHeader $APIHeader -Days 15 -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ConnectionReport -MonitorData $MonitorData -Export HTML -ReportPath c:\\temp -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_DeliveryGroup -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_FailureReport -MonitorData $MonitorData -FailureType Connection -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_HealthCheck -APIHeader $APIHeader -region eu -ReportPath C:\\Temp -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Hypervisor -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>$ConfigLog = Get-CTXAPI_ConfigLog -APIHeader $APIHeader -Days 7 $LowLevelOperations = Get-CTXAPI_LowLevelOperations -APIHeader $APIHeader -HighLevelID $ConfigLog[0].id -------------------------- EXAMPLE 1 -------------------------- PS C:>$MachineCatalogs = Get-CTXAPI_MachineCatalogs -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>$machines = Get-CTXAPI_Machines -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>$MonitorData = Get-CTXAPI_MonitorData -APIHeader $APIHeader -region eu -hours 24 -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ResourceLocation -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ResourceUtilization -MonitorData $MonitorData -Export excel -ReportPath C:\\temp\\ -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Session -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_SiteDetail -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Tests -APIHeader $APIHeader -SiteTest -HypervisorsTest -DeliveryGroupsTest -MachineCatalogsTest -Export HTML -ReportPath C:\\temp -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_VDAUptime -APIHeader $APIHeader -Export excel -ReportPath C:\\temp\\ -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Zone -APIHeader $APIHeader NOTES CTXCloudApi Getting Started You will need access to the Citrix Cloud API. Follow Get API Access to gain access. Install-Module -Name CTXCloudApi -Verbose Import-Module CTXCloudApi -Verbose -Force Get-Command -Module CTXCloudApi Run Connect-CTXAPI with the details obtained from above. This connect and create the needed headers for other commands. Example 1: $splat = @{ Customer_Id = \"xxx\" Client_Id = \"xxx-xxx-xxx-xxx\" Client_Secret = \"yyyyyy==\" Customer_Name = 'HomeLab' } $APIHeader = Connect-CTXAPI @splat Get-CTXAPI_HealthCheck -APIHeader $APIHeader -region eu -ReportPath C:\\Temp\\ HTML Reports When creating a HTML report: The logo can be changed by replacing the variable - `$Global:Logourl` ='URL to your logo' The colors of the report can be changed, by replacing: - `$global:colour1` = '# number of color' - `$global:colour2` = '# number of color' Or permanently replace it by editing the following file - `<Module base>\\Private\\Reports-Variables.ps1` SEE ALSO https://github.com/smitpi/CTXCloudApi","title":"CTXCloudApi"},{"location":"about_CTXCloudApi/#ctxcloudapi","text":"","title":"CTXCloudApi"},{"location":"about_CTXCloudApi/#about_ctxcloudapi","text":"","title":"about_CTXCloudApi"},{"location":"about_CTXCloudApi/#short-description","text":"Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports","title":"SHORT DESCRIPTION"},{"location":"about_CTXCloudApi/#long-description","text":"Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere. Start with Connect-CTXAPI to connect, then run other reports Connect-CTXAPI - Connect to the cloud and create needed api headers Get-CTXAPI_Applications - Return details about published apps Get-CTXAPI_CloudConnectors - Details about current Cloud Connectors Get-CTXAPI_CloudServices - Return details about cloud services and subscription Get-CTXAPI_ConfigAudit - Reports on system config Get-CTXAPI_ConfigLog - Get high level configuration changes in the last x days. Get-CTXAPI_ConnectionReport - Creates Connection report Get-CTXAPI_DeliveryGroups - Return details about Delivery Groups Get-CTXAPI_FailureReport - Reports on failures in the last x hours. Get-CTXAPI_HealthCheck - Show useful information for daily health check Get-CTXAPI_Hypervisors - Return details about hosting (hypervisor) Get-CTXAPI_LowLevelOperations - Return details about low lever config change (More detailed) Get-CTXAPI_MachineCatalogs - Return details about machine catalogs Get-CTXAPI_Machines - Return details about vda machines Get-CTXAPI_MonitorData - Collect Monitoring OData for other reports Get-CTXAPI_ResourceLocations - Get cloud Resource Locations Get-CTXAPI_ResourceUtilization - Resource utilization in the last x hours Get-CTXAPI_Sessions - Return details about current sessions Get-CTXAPI_SiteDetails - Return details about your farm / site Get-CTXAPI_Tests - Run Built in Citrix cloud tests Get-CTXAPI_VDAUptime - Uses Registration date to calculate uptime Get-CTXAPI_Zone - Get zone details","title":"LONG DESCRIPTION"},{"location":"about_CTXCloudApi/#examples","text":"-------------------------- EXAMPLE 1 -------------------------- PS C:>$splat = @{ Customer_Id = \"xxx\" Client_Id = \"xxx-xxx-xxx-xxx\" Client_Secret = \"yyyyyy==\" Customer_Name = 'HomeLab' } $APIHeader = Connect-CTXAPI @splat -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Applications -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_CloudConnectors -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_CloudServices -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ConfigAudit -APIHeader $APIHeader -Export Excel -ReportPath C:\\Temp -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ConfigLog -APIHeader $APIHeader -Days 15 -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ConnectionReport -MonitorData $MonitorData -Export HTML -ReportPath c:\\temp -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_DeliveryGroup -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_FailureReport -MonitorData $MonitorData -FailureType Connection -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_HealthCheck -APIHeader $APIHeader -region eu -ReportPath C:\\Temp -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Hypervisor -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>$ConfigLog = Get-CTXAPI_ConfigLog -APIHeader $APIHeader -Days 7 $LowLevelOperations = Get-CTXAPI_LowLevelOperations -APIHeader $APIHeader -HighLevelID $ConfigLog[0].id -------------------------- EXAMPLE 1 -------------------------- PS C:>$MachineCatalogs = Get-CTXAPI_MachineCatalogs -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>$machines = Get-CTXAPI_Machines -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>$MonitorData = Get-CTXAPI_MonitorData -APIHeader $APIHeader -region eu -hours 24 -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ResourceLocation -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_ResourceUtilization -MonitorData $MonitorData -Export excel -ReportPath C:\\temp\\ -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Session -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_SiteDetail -APIHeader $APIHeader -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Tests -APIHeader $APIHeader -SiteTest -HypervisorsTest -DeliveryGroupsTest -MachineCatalogsTest -Export HTML -ReportPath C:\\temp -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_VDAUptime -APIHeader $APIHeader -Export excel -ReportPath C:\\temp\\ -------------------------- EXAMPLE 1 -------------------------- PS C:>Get-CTXAPI_Zone -APIHeader $APIHeader","title":"EXAMPLES"},{"location":"about_CTXCloudApi/#notes","text":"","title":"NOTES"},{"location":"about_CTXCloudApi/#ctxcloudapi_1","text":"","title":"CTXCloudApi"},{"location":"about_CTXCloudApi/#getting-started","text":"You will need access to the Citrix Cloud API. Follow Get API Access to gain access. Install-Module -Name CTXCloudApi -Verbose Import-Module CTXCloudApi -Verbose -Force Get-Command -Module CTXCloudApi Run Connect-CTXAPI with the details obtained from above. This connect and create the needed headers for other commands.","title":"Getting Started"},{"location":"about_CTXCloudApi/#example-1","text":"$splat = @{ Customer_Id = \"xxx\" Client_Id = \"xxx-xxx-xxx-xxx\" Client_Secret = \"yyyyyy==\" Customer_Name = 'HomeLab' } $APIHeader = Connect-CTXAPI @splat Get-CTXAPI_HealthCheck -APIHeader $APIHeader -region eu -ReportPath C:\\Temp\\","title":"Example 1:"},{"location":"about_CTXCloudApi/#html-reports","text":"When creating a HTML report: The logo can be changed by replacing the variable - `$Global:Logourl` ='URL to your logo' The colors of the report can be changed, by replacing: - `$global:colour1` = '# number of color' - `$global:colour2` = '# number of color' Or permanently replace it by editing the following file - `<Module base>\\Private\\Reports-Variables.ps1`","title":"HTML Reports"},{"location":"about_CTXCloudApi/#see-also","text":"https://github.com/smitpi/CTXCloudApi","title":"SEE ALSO"}]}
|