https://github.com/smitpi/ctxcloudapi
Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere.
https://github.com/smitpi/ctxcloudapi
citrix citrix-cloud powershell
Last synced: 8 months ago
JSON representation
Wrapper for Citrix Cloud CVAD API. You dont require the installed SDK anymore and manage your clients cloud infrastructure from anywhere.
- Host: GitHub
- URL: https://github.com/smitpi/ctxcloudapi
- Owner: smitpi
- License: mit
- Created: 2021-04-03T00:16:13.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-06T19:39:08.000Z (about 3 years ago)
- Last Synced: 2025-04-13T21:52:36.424Z (10 months ago)
- Topics: citrix, citrix-cloud, powershell
- Language: PowerShell
- Homepage:
- Size: 7.4 MB
- Stars: 6
- Watchers: 1
- Forks: 2
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CTXCloudApi
## Description
A 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.
## Getting Started
- Install from PowerShell Gallery [PS Gallery](https://www.powershellgallery.com/packages/CTXCloudApi)
```
Install-Module -Name CTXCloudApi -Verbose
```
- or run this script to install from GitHub [GitHub Repo](https://github.com/smitpi/CTXCloudApi)
```
$CurrentLocation = Get-Item .
$ModuleDestination = (Join-Path (Get-Item (Join-Path (Get-Item $profile).Directory 'Modules')).FullName -ChildPath CTXCloudApi)
git clone --depth 1 https://github.com/smitpi/CTXCloudApi $ModuleDestination 2>&1 | Write-Host -ForegroundColor Yellow
Set-Location $ModuleDestination
git filter-branch --prune-empty --subdirectory-filter Output HEAD 2>&1 | Write-Host -ForegroundColor Yellow
Set-Location $CurrentLocation
```
- Then import the module into your session
```
Import-Module CTXCloudApi -Verbose -Force
```
- or run these commands for more help and details.
```
Get-Command -Module CTXCloudApi
Get-Help about_CTXCloudApi
```
Documentation can be found at: [Github_Pages](https://smitpi.github.io/CTXCloudApi)
## Functions
- [`Add-CTXAPI_DefaultsToProfile`](https://smitpi.github.io/CTXCloudApi/Add-CTXAPI_DefaultsToProfile) -- This function will add connection settings to PSDefaultParameter and your profile.
- [`Connect-CTXAPI`](https://smitpi.github.io/CTXCloudApi/Connect-CTXAPI) -- Connect to the cloud and create needed api headers
- [`Get-CTXAPI_Application`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Application) -- Return details about published apps
- [`Get-CTXAPI_CloudConnector`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_CloudConnector) -- Details about current Cloud Connectors
- [`Get-CTXAPI_CloudService`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_CloudService) -- Return details about cloud services and subscription
- [`Get-CTXAPI_ConfigAudit`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ConfigAudit) -- Reports on system config.
- [`Get-CTXAPI_ConfigLog`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ConfigLog) -- Get high level configuration changes in the last x days.
- [`Get-CTXAPI_ConnectionReport`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ConnectionReport) -- Creates Connection report
- [`Get-CTXAPI_DeliveryGroup`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_DeliveryGroup) -- Return details about Delivery Groups
- [`Get-CTXAPI_FailureReport`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_FailureReport) -- Reports on failures in the last x hours.
- [`Get-CTXAPI_HealthCheck`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_HealthCheck) -- Show useful information for daily health check
- [`Get-CTXAPI_Hypervisor`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Hypervisor) -- Return details about hosting (hypervisor)
- [`Get-CTXAPI_LowLevelOperation`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_LowLevelOperation) -- Return details about low lever config change (More detailed)
- [`Get-CTXAPI_Machine`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Machine) -- Return details about vda machines
- [`Get-CTXAPI_MachineCatalog`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_MachineCatalog) -- Return details about machine Catalogs
- [`Get-CTXAPI_MonitorData`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_MonitorData) -- Collect Monitoring OData for other reports
- [`Get-CTXAPI_ResourceLocation`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ResourceLocation) -- Get cloud Resource Locations
- [`Get-CTXAPI_ResourceUtilization`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_ResourceUtilization) -- Resource utilization in the last x hours
- [`Get-CTXAPI_Session`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Session) -- Return details about current sessions
- [`Get-CTXAPI_SiteDetail`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_SiteDetail) -- Return details about your farm / site
- [`Get-CTXAPI_Test`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Test) -- Run Built in Citrix cloud tests
- [`Get-CTXAPI_VDAUptime`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_VDAUptime) -- Uses Registration date to calculate uptime
- [`Get-CTXAPI_Zone`](https://smitpi.github.io/CTXCloudApi/Get-CTXAPI_Zone) -- Get zone details
- [`Set-CTXAPI_ReportColour`](https://smitpi.github.io/CTXCloudApi/Set-CTXAPI_ReportColour) -- Set the colour and logo for HTML Reports
- [`Test-CTXAPI_Header`](https://smitpi.github.io/CTXCloudApi/Test-CTXAPI_Header) -- Checks that the connection is still valid, and the token hasn't expired.