en-US/about_CTXCloudApi.help.txt
|
CTXCloudApi about_CTXCloudApi SHORT DESCRIPTION CTXCloudApi is a PowerShell module for Citrix DaaS (CVAD) Manage & Monitor OData APIs. It eliminates the need for the Citrix SDK and provides a single, secure connection via `Connect-CTXAPI`, after which you can manage and query applications, delivery groups, machine catalogs, hypervisors, sessions, and monitoring data across Citrix Cloud tenants. The module includes robust reporting and export options (Excel/HTML) to support inventory, uptime, failures, utilization, and configuration audits. NOTES Functions in this module: Connect-CTXAPI -- Connects to Citrix Cloud and creates required API headers. Get-CTXAPI_Application -- Returns details about published applications (handles pagination). Get-CTXAPI_CloudService -- Returns details about cloud services and subscription. Get-CTXAPI_ConfigAudit -- Reports on system config. Get-CTXAPI_ConfigLog -- Returns high-level configuration changes in the last X days. Get-CTXAPI_ConnectionReport -- Creates a connection report from CVAD Monitor data. Get-CTXAPI_DeliveryGroup -- Returns details about Delivery Groups (handles pagination). Get-CTXAPI_FailureReport -- Reports on connection or machine failures in the last X hours. Get-CTXAPI_Hypervisor -- Returns details about hosting (hypervisor) connections (handles pagination). Get-CTXAPI_LowLevelOperation -- Returns details about low-level configuration changes (more detailed). Get-CTXAPI_Machine -- Returns details about VDA machines (handles pagination). Get-CTXAPI_MachineCatalog -- Returns details about Machine Catalogs (handles pagination). Get-CTXAPI_MonitorData -- Collect Monitoring OData for other reports. Get-CTXAPI_ResourceLocation -- Returns cloud Resource Locations. Get-CTXAPI_ResourceUtilization -- Resource utilization in the last X hours. Get-CTXAPI_Session -- Returns details about current sessions (handles pagination). Get-CTXAPI_SiteDetail -- Returns details about your CVAD site. Get-CTXAPI_VDAUptime -- Calculate VDA uptime and export or return results. Get-CTXAPI_Zone -- Returns Zone details (handles pagination). Test-CTXAPI_Header -- Checks that the connection is still valid, and the token hasn't expired. SEE ALSO https://github.com/smitpi/CTXCloudApi https://smitpi.github.io/CTXCloudApi/ |