{"id":21809884,"url":"https://github.com/smitpi/ctxcloudapi","last_synced_at":"2025-06-12T08:06:08.937Z","repository":{"id":50688723,"uuid":"354162922","full_name":"smitpi/CTXCloudApi","owner":"smitpi","description":"Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere.","archived":false,"fork":false,"pushed_at":"2022-12-06T19:39:08.000Z","size":7755,"stargazers_count":6,"open_issues_count":5,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-13T21:52:36.424Z","etag":null,"topics":["citrix","citrix-cloud","powershell"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smitpi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-03T00:16:13.000Z","updated_at":"2024-08-02T17:01:29.000Z","dependencies_parsed_at":"2023-01-23T22:47:46.711Z","dependency_job_id":null,"html_url":"https://github.com/smitpi/CTXCloudApi","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/smitpi/CTXCloudApi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smitpi%2FCTXCloudApi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smitpi%2FCTXCloudApi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smitpi%2FCTXCloudApi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smitpi%2FCTXCloudApi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smitpi","download_url":"https://codeload.github.com/smitpi/CTXCloudApi/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smitpi%2FCTXCloudApi/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259426970,"owners_count":22855553,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["citrix","citrix-cloud","powershell"],"created_at":"2024-11-27T13:28:58.745Z","updated_at":"2025-06-12T08:06:08.908Z","avatar_url":"https://github.com/smitpi.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CTXCloudApi\n \n## Description\nA wrapper for Citrix Cloud CVAD API. You do not require the installed SDK anymore. With this module you can manage your clients cloud infrastructure from anywhere. Start with the Connect-CTXAPI function to connect, it will create the needed headers for the other functions.\n \n## Getting Started\n- Install from PowerShell Gallery [PS Gallery](https://www.powershellgallery.com/packages/CTXCloudApi)\n```\nInstall-Module -Name CTXCloudApi -Verbose\n```\n- or run this script to install from GitHub [GitHub Repo](https://github.com/smitpi/CTXCloudApi)\n```\n$CurrentLocation = Get-Item .\n$ModuleDestination = (Join-Path (Get-Item (Join-Path (Get-Item $profile).Directory 'Modules')).FullName -ChildPath CTXCloudApi)\ngit clone --depth 1 https://github.com/smitpi/CTXCloudApi $ModuleDestination 2\u003e\u00261 | Write-Host -ForegroundColor Yellow\nSet-Location $ModuleDestination\ngit filter-branch --prune-empty --subdirectory-filter Output HEAD 2\u003e\u00261 | Write-Host -ForegroundColor Yellow\nSet-Location $CurrentLocation\n```\n- Then import the module into your session\n```\nImport-Module CTXCloudApi -Verbose -Force\n```\n- or run these commands for more help and details.\n```\nGet-Command -Module CTXCloudApi\nGet-Help about_CTXCloudApi\n```\nDocumentation can be found at: [Github_Pages](https://smitpi.github.io/CTXCloudApi)\n \n## Functions\n- [`Add-CTXAPI_DefaultsToProfile`](https://smitpi.github.io/CTXCloudApi/Add-CTXAPI_DefaultsToProfile) -- This function will add connection settings to PSDefaultParameter and your profile.\n- [`Connect-CTXAPI`](https://smitpi.github.io/CTXCloudApi/Connect-CTXAPI) -- Connect to the cloud and create needed api headers\n- [`Get-CTXAPI_Application`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Application) -- Return details about published apps\n- [`Get-CTXAPI_CloudConnector`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_CloudConnector) -- Details about current Cloud Connectors\n- [`Get-CTXAPI_CloudService`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_CloudService) -- Return details about cloud services and subscription\n- [`Get-CTXAPI_ConfigAudit`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ConfigAudit) -- Reports on system config.\n- [`Get-CTXAPI_ConfigLog`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ConfigLog) -- Get high level configuration changes in the last x days.\n- [`Get-CTXAPI_ConnectionReport`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ConnectionReport) -- Creates Connection report\n- [`Get-CTXAPI_DeliveryGroup`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_DeliveryGroup) -- Return details about Delivery Groups\n- [`Get-CTXAPI_FailureReport`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_FailureReport) -- Reports on failures in the last x hours.\n- [`Get-CTXAPI_HealthCheck`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_HealthCheck) -- Show useful information for daily health check\n- [`Get-CTXAPI_Hypervisor`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Hypervisor) -- Return details about hosting (hypervisor)\n- [`Get-CTXAPI_LowLevelOperation`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_LowLevelOperation) -- Return details about low lever config change (More detailed)\n- [`Get-CTXAPI_Machine`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Machine) -- Return details about vda machines\n- [`Get-CTXAPI_MachineCatalog`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_MachineCatalog) -- Return details about machine Catalogs\n- [`Get-CTXAPI_MonitorData`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_MonitorData) -- Collect Monitoring OData for other reports\n- [`Get-CTXAPI_ResourceLocation`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ResourceLocation) -- Get cloud Resource Locations\n- [`Get-CTXAPI_ResourceUtilization`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ResourceUtilization) -- Resource utilization in the last x hours\n- [`Get-CTXAPI_Session`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Session) -- Return details about current sessions\n- [`Get-CTXAPI_SiteDetail`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_SiteDetail) -- Return details about your farm / site\n- [`Get-CTXAPI_Test`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Test) -- Run Built in Citrix cloud tests\n- [`Get-CTXAPI_VDAUptime`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_VDAUptime) -- Uses Registration date to calculate uptime\n- [`Get-CTXAPI_Zone`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Zone) -- Get zone details\n- [`Set-CTXAPI_ReportColour`](https://smitpi.github.io/CTXCloudApi/Set-CTXAPI_ReportColour) -- Set the colour and logo for HTML Reports\n- [`Test-CTXAPI_Header`](https://smitpi.github.io/CTXCloudApi/Test-CTXAPI_Header) -- Checks that the connection is still valid, and the token hasn't expired.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmitpi%2Fctxcloudapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmitpi%2Fctxcloudapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmitpi%2Fctxcloudapi/lists"}