{"id":28697673,"url":"https://github.com/vatesfr/xo-powershell","last_synced_at":"2025-06-14T10:05:37.901Z","repository":{"id":286088767,"uuid":"956646158","full_name":"vatesfr/xo-powershell","owner":"vatesfr","description":"PowerShell module for Xen-Orchestra","archived":false,"fork":false,"pushed_at":"2025-05-22T13:47:30.000Z","size":177,"stargazers_count":17,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-14T00:02:47.491Z","etag":null,"topics":["powershell","vates","virtualization","xcp-ng","xen","xen-orchestra"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vatesfr.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-03-28T15:57:09.000Z","updated_at":"2025-05-27T19:53:17.000Z","dependencies_parsed_at":"2025-05-20T21:34:08.657Z","dependency_job_id":null,"html_url":"https://github.com/vatesfr/xo-powershell","commit_stats":null,"previous_names":["vatesfr/xo-powershell"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/vatesfr/xo-powershell","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vatesfr%2Fxo-powershell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vatesfr%2Fxo-powershell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vatesfr%2Fxo-powershell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vatesfr%2Fxo-powershell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vatesfr","download_url":"https://codeload.github.com/vatesfr/xo-powershell/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vatesfr%2Fxo-powershell/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259798069,"owners_count":22912770,"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":["powershell","vates","virtualization","xcp-ng","xen","xen-orchestra"],"created_at":"2025-06-14T10:05:36.381Z","updated_at":"2025-06-14T10:05:37.889Z","avatar_url":"https://github.com/vatesfr.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PowerShell Module for Xen Orchestra\n\nA PowerShell module to interact with Xen Orchestra's REST API, allowing you to manage your XenServer/XCP-ng virtualization environment directly from PowerShell.\n\n## Requirements\n- PowerShell 7.0 or later\n- Access to a Xen Orchestra instance\n- A valid API token\n\n## Installation\n\nYou can install from sources or from the PowerShell Gallery (easier).\n\n### From PowerShell Gallery\n\n```powershell\nInstall-Module -Name xo-powershell -AllowPrerelease\n```\n\n### From sources\n\n1. Clone this repository or download the module files\n2. Place them in a directory of your choice\n3. Import the module:\n\n```powershell\nImport-Module ./xo-powershell.psd1\n```\n\n## Authentication\n\nYou need to authenticate with your Xen Orchestra instance before running commands:\n\n### Using a token directly\n\n```powershell\nConnect-XoSession -HostName \"https://your-xo-server\" -Token \"your-api-token\"\n```\n\n## Available Commands\n\n### Session Management\n- `Test-XoSession` - Test connection to Xen Orchestra\n- `Connect-XoSession` - Connect to Xen Orchestra (`Connect-XenOrchestra` is an alias)\n- `Disconnect-XoSession` - Disconnect from Xen Orchestra (`Disconnect-XenOrchestra` is an alias)\n\n### VM Management\n- `Get-XoVm` - Get list of VMs or a specific VM\n- `Start-XoVm` - Start one or more VMs\n- `Stop-XoVm` - Stop one or more VMs (use -Force for hard shutdown)\n- `Restart-XoVm` - Restart one or more VMs (use -Force for hard reboot)\n- `New-XoVmSnapshot` - Create VM snapshot\n- `Get-XoVmSnapshot` - Get VM snapshots\n- `Suspend-XoVm` - Suspend one or more VMs\n\n### Storage Management\n- `Get-XoSr` - Get storage repositories\n- `Get-XoVdi` - Get virtual disk images\n- `Get-XoVmVdi` - Get disks attached to a VM\n- `Export-XoVdi` - Export a VDI to a file in VHD or RAW format\n\n### VDI Snapshot Management\n- `Get-XoVdiSnapshot` - Get VDI snapshots\n- `Export-XoVdiSnapshot` - Export a VDI snapshot to a file in VHD or RAW format\n\n### Server Management\n- `Get-XoServer` - Get server information\n\n### Host Management\n- `Get-XoHost` - Get host information\n\n### Task Management\n- `Get-XoTask` - Get task information (`Get-XoTaskDetails` is an alias)\n- `Wait-XoTask` - Wait for task completion\n\n## Examples\n\n### Working with VMs\n\nList all running VMs:\n```powershell\nGet-XoVm -PowerState Running\n```\n\nGet a specific VM:\n```powershell\nGet-XoVm -VmUuid \"12345678-abcd-1234-abcd-1234567890ab\"\n```\n\nStart multiple VMs:\n```powershell\nGet-XoVm -PowerState Halted | Start-XoVm\n```\n\nCreate a snapshot of a VM:\n```powershell\nNew-XoVmSnapshot -VmUuid \"12345678-abcd-1234-abcd-1234567890ab\" -SnapshotName \"Before Update\"\n```\n\n### Working with Disks\n\nGet all disks for a VM:\n```powershell\nGet-XoVmVdi -VmUuid \"12345678-abcd-1234-abcd-1234567890ab\"\n```\n\nExport a VDI to a file:\n```powershell\nExport-XoVdi -VdiId \"a1b2c3d4\" -Format vhd -OutFile \"C:\\exports\\disk_backup.vhd\"\n```\n\n### Working with Servers and Hosts\n\nList all servers:\n```powershell\nGet-XoServer\n```\n\nList all hosts:\n```powershell\nGet-XoHost\n```\n\n## Pipeline Support\n\nMost commands support pipeline input, allowing for operations like:\n\n```powershell\nGet-XoVm | Where-Object { $_.Name -like \"*Test*\" } | Stop-XoVm\n```\n\n```powershell\nGet-XoVm -PowerState Running | Where-Object { $_.Memory -gt 4GB } | Suspend-XoVm\n```\n\n## Contributing\nContributions are welcome! Please feel free to submit a Pull Request.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvatesfr%2Fxo-powershell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvatesfr%2Fxo-powershell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvatesfr%2Fxo-powershell/lists"}