diff --git a/docs/PVE_API_COVERAGE.md b/docs/PVE_API_COVERAGE.md new file mode 100644 index 0000000..9d020aa --- /dev/null +++ b/docs/PVE_API_COVERAGE.md @@ -0,0 +1,72 @@ +# Proxmox VE API Coverage + +This document tracks which PVE API areas are implemented in PSProxmoxVE and which are planned for future releases. + +**Last updated:** 2026-03-20 +**Module version:** 0.1.0-preview +**Total cmdlets:** 74 + +## Implemented + +| Area | Cmdlets | API Endpoints | +|------|---------|---------------| +| **Connection** | 3 | `POST /access/ticket`, `DELETE /access/ticket` | +| **Nodes** | 2 | `GET /nodes`, `GET /nodes/{node}/status` | +| **VMs (QEMU)** | 18 | `/nodes/{node}/qemu/*` (CRUD, lifecycle, clone, migrate, resize, config, guest agent) | +| **Containers (LXC)** | 14 | `/nodes/{node}/lxc/*` (CRUD, lifecycle, clone, migrate, config, snapshots) | +| **Storage** | 6 | `/storage`, `/nodes/{node}/storage/{storage}/*` (CRUD, content, upload, download) | +| **Snapshots** | 4 | `/nodes/{node}/qemu/{vmid}/snapshot/*` (CRUD, rollback) | +| **Container Snapshots** | 4 | `/nodes/{node}/lxc/{vmid}/snapshot/*` (CRUD, rollback) | +| **Networking** | 5 | `/nodes/{node}/network/*` (CRUD, apply) | +| **SDN Zones** | 3 | `/cluster/sdn/zones/*` (CRUD) | +| **SDN VNets** | 3 | `/cluster/sdn/vnets/*` (CRUD) | +| **SDN Subnets** | 3 | `/cluster/sdn/vnets/{vnet}/subnets/*` (CRUD) | +| **Users** | 4 | `/access/users/*` (CRUD) | +| **Roles** | 3 | `/access/roles/*` (CRUD) | +| **Permissions** | 2 | `/access/acl` (get, set) | +| **API Tokens** | 3 | `/access/users/{userid}/tokens/*` (CRUD) | +| **Templates** | 4 | VM template conversion, listing, cloning, removal | +| **Cloud-Init** | 3 | `/nodes/{node}/qemu/{vmid}/config` (cloud-init fields), `/nodes/{node}/qemu/{vmid}/cloudinit/regenerate` | +| **Tasks** | 2 | `/nodes/{node}/tasks/{upid}/status` (get, wait) | + +## Not Yet Implemented + +### High-Value Gaps + +These are the most impactful areas for real-world automation that are not yet covered. + +| Area | Key Endpoints | Use Case | Priority | +|------|--------------|----------|----------| +| **Firewall** | `/cluster/firewall/*`, `/nodes/{node}/firewall/*`, `/nodes/{node}/qemu/{vmid}/firewall/*` | Security automation, rule management, IP sets, aliases | High | +| **Backup / vzdump** | `/nodes/{node}/vzdump`, `/cluster/backup/*` | Disaster recovery, scheduled backups, backup job management | High | +| **Pool Management** | `/pools/*` | Multi-tenant environments, resource grouping | Medium | + +### Lower Priority Gaps + +| Area | Key Endpoints | Notes | +|------|--------------|-------| +| **Ceph** | `/nodes/{node}/ceph/*` | OSD, monitor, pool, and MDS management | +| **HA (High Availability)** | `/cluster/ha/*` | HA groups, resources, and fencing configuration | +| **Replication** | `/cluster/replication/*` | ZFS replication between nodes | +| **Access Groups** | `/access/groups/*` | User group management | +| **Access Domains/Realms** | `/access/domains/*` | LDAP, AD, OpenID realm configuration | +| **PBS Integration** | N/A (separate API) | Proxmox Backup Server operations | +| **Cluster Config** | `/cluster/config/*` | Cluster join, node management, totem config | +| **ACME / Certificates** | `/cluster/acme/*`, `/nodes/{node}/certificates/*` | Let's Encrypt certificate automation | +| **Node Management** | `/nodes/{node}/apt/*`, `/nodes/{node}/disks/*`, `/nodes/{node}/services/*` | Package updates, disk management, service control | +| **Metrics** | `/cluster/metrics/*` | External metrics server configuration | +| **Additional VM Agent** | `/nodes/{node}/qemu/{vmid}/agent/*` | File read/write, OS info, suspend/resume via agent | +| **SDN IPAM** | `/cluster/sdn/ipams/*` | IP address management for SDN | +| **SDN DNS** | `/cluster/sdn/dns/*` | DNS integration for SDN | +| **SDN Controllers** | `/cluster/sdn/controllers/*` | SDN controller configuration | + +## Contributing New Cmdlets + +See [CONTRIBUTING.md](../CONTRIBUTING.md) for the full guide. In short: + +1. Create service methods in `PSProxmoxVE.Core/Services/` +2. Create model classes in `PSProxmoxVE.Core/Models/` if needed +3. Create cmdlet classes in `PSProxmoxVE/Cmdlets/` +4. Add cmdlet names to `CmdletsToExport` in the manifest +5. Add Pester tests +6. Update this document and the README cmdlet reference diff --git a/docs/cmdlets/Connect-PveServer.md b/docs/cmdlets/Connect-PveServer.md new file mode 100644 index 0000000..2ad625b --- /dev/null +++ b/docs/cmdlets/Connect-PveServer.md @@ -0,0 +1,160 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Connect-PveServer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +### Credential (Default) +``` +Connect-PveServer [-Server] [-Port ] -Credential [-SkipCertificateCheck] + [-PassThru] [-ProgressAction ] [] +``` + +### ApiToken +``` +Connect-PveServer [-Server] [-Port ] -ApiToken [-SkipCertificateCheck] [-PassThru] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ApiToken +API token in USER@REALM!TOKENID=UUID format. + +```yaml +Type: String +Parameter Sets: ApiToken +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Credential +Username and password. +Username must include realm (e.g. +root@pam). + +```yaml +Type: PSCredential +Parameter Sets: Credential +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PassThru +Output the session object to the pipeline. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Port +API port. +Defaults to 8006. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +Hostname or IP of the Proxmox VE server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipCertificateCheck +Skip TLS certificate validation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Authentication.PveSession +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Copy-PveContainer.md b/docs/cmdlets/Copy-PveContainer.md new file mode 100644 index 0000000..199edfa --- /dev/null +++ b/docs/cmdlets/Copy-PveContainer.md @@ -0,0 +1,227 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Copy-PveContainer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Copy-PveContainer -SourceNode -VmId [-NewVmId ] [-NewName ] + [-TargetNode ] [-Full] [-Storage ] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Full +Perform a full (non-linked) clone. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewName +Hostname for the new clone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewVmId +Container ID for the new clone. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceNode +The node where the source container resides. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNode +Target node for the clone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Copy-PveVm.md b/docs/cmdlets/Copy-PveVm.md new file mode 100644 index 0000000..ef6afef --- /dev/null +++ b/docs/cmdlets/Copy-PveVm.md @@ -0,0 +1,227 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Copy-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Copy-PveVm -SourceNode -VmId [-NewVmId ] [-NewName ] [-TargetNode ] + [-Full] [-Storage ] [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Full +Perform a full (non-linked) clone. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewName +Display name for the new clone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewVmId +VM ID for the new clone. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SourceNode +The node where the source VM resides. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNode +Target node for the clone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Disconnect-PveServer.md b/docs/cmdlets/Disconnect-PveServer.md new file mode 100644 index 0000000..b7e6c6c --- /dev/null +++ b/docs/cmdlets/Disconnect-PveServer.md @@ -0,0 +1,90 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Disconnect-PveServer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Disconnect-PveServer [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveApiToken.md b/docs/cmdlets/Get-PveApiToken.md new file mode 100644 index 0000000..a0fbc0f --- /dev/null +++ b/docs/cmdlets/Get-PveApiToken.md @@ -0,0 +1,105 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveApiToken + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveApiToken [-UserId] [[-TokenId] ] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenId +The API token identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user ID in user@realm format. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Users.PveApiToken +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveCloudInitConfig.md b/docs/cmdlets/Get-PveCloudInitConfig.md new file mode 100644 index 0000000..df42f78 --- /dev/null +++ b/docs/cmdlets/Get-PveCloudInitConfig.md @@ -0,0 +1,105 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveCloudInitConfig + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveCloudInitConfig [-Node] [-VmId] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveVmConfig +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveContainer.md b/docs/cmdlets/Get-PveContainer.md new file mode 100644 index 0000000..1497464 --- /dev/null +++ b/docs/cmdlets/Get-PveContainer.md @@ -0,0 +1,151 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveContainer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveContainer [-Node ] [-VmId ] [-Name ] [-Status ] [-Tag ] + [-Session ] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +Filter by name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Filter by status (e.g. +running, stopped). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Filter by tag. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Containers.PveContainer +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveContainerConfig.md b/docs/cmdlets/Get-PveContainerConfig.md new file mode 100644 index 0000000..62b05ee --- /dev/null +++ b/docs/cmdlets/Get-PveContainerConfig.md @@ -0,0 +1,106 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveContainerConfig + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveContainerConfig -Node -VmId [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Containers.PveContainerConfig +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveContainerSnapshot.md b/docs/cmdlets/Get-PveContainerSnapshot.md new file mode 100644 index 0000000..443b707 --- /dev/null +++ b/docs/cmdlets/Get-PveContainerSnapshot.md @@ -0,0 +1,120 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveContainerSnapshot + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveContainerSnapshot [-Node] [-VmId] [-Name ] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +Filter by snapshot name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveSnapshot +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveNetwork.md b/docs/cmdlets/Get-PveNetwork.md new file mode 100644 index 0000000..f947a8d --- /dev/null +++ b/docs/cmdlets/Get-PveNetwork.md @@ -0,0 +1,122 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveNetwork + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveNetwork [-Node] [-Iface ] [-Type ] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Iface +The network interface name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: NodeName + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Filter by interface type (e.g. +bridge, bond). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: bridge, bond, eth, alias, vlan, OVSBridge, OVSBond, OVSPort, OVSIntPort, any_bridge, any_local_bridge + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Network.PveNetwork +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveNode.md b/docs/cmdlets/Get-PveNode.md new file mode 100644 index 0000000..364bcc1 --- /dev/null +++ b/docs/cmdlets/Get-PveNode.md @@ -0,0 +1,90 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveNode + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveNode [[-Name] ] [-Session ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +Filter by node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Nodes.PveNode +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveNodeStatus.md b/docs/cmdlets/Get-PveNodeStatus.md new file mode 100644 index 0000000..f38e52c --- /dev/null +++ b/docs/cmdlets/Get-PveNodeStatus.md @@ -0,0 +1,90 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveNodeStatus + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveNodeStatus [-Node] [-Session ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Nodes.PveNodeStatus +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PvePermission.md b/docs/cmdlets/Get-PvePermission.md new file mode 100644 index 0000000..f8783d5 --- /dev/null +++ b/docs/cmdlets/Get-PvePermission.md @@ -0,0 +1,106 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PvePermission + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PvePermission [[-Path] ] [-UserId ] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Path +Filter by resource path (e.g. +/, /vms/100). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user ID in user@realm format. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Users.PvePermission +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveRole.md b/docs/cmdlets/Get-PveRole.md new file mode 100644 index 0000000..92a3972 --- /dev/null +++ b/docs/cmdlets/Get-PveRole.md @@ -0,0 +1,90 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveRole + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveRole [[-RoleId] ] [-Session ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -RoleId +The role identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Users.PveRole +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveSdnSubnet.md b/docs/cmdlets/Get-PveSdnSubnet.md new file mode 100644 index 0000000..8e28229 --- /dev/null +++ b/docs/cmdlets/Get-PveSdnSubnet.md @@ -0,0 +1,106 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveSdnSubnet + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveSdnSubnet [-Vnet] [-Subnet ] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +Filter by subnet CIDR (e.g. +10.0.0.0/24). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vnet +The SDN VNet name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Network.PveSdnSubnet +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveSdnVnet.md b/docs/cmdlets/Get-PveSdnVnet.md new file mode 100644 index 0000000..414c749 --- /dev/null +++ b/docs/cmdlets/Get-PveSdnVnet.md @@ -0,0 +1,105 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveSdnVnet + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveSdnVnet [[-Zone] ] [-Vnet ] [-Session ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vnet +The SDN VNet name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The SDN zone name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Network.PveSdnVnet +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveSdnZone.md b/docs/cmdlets/Get-PveSdnZone.md new file mode 100644 index 0000000..aa71f59 --- /dev/null +++ b/docs/cmdlets/Get-PveSdnZone.md @@ -0,0 +1,90 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveSdnZone + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveSdnZone [[-Zone] ] [-Session ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The SDN zone name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Network.PveSdnZone +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveSnapshot.md b/docs/cmdlets/Get-PveSnapshot.md new file mode 100644 index 0000000..08d4e05 --- /dev/null +++ b/docs/cmdlets/Get-PveSnapshot.md @@ -0,0 +1,120 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveSnapshot + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveSnapshot [-Node] [-VmId] [-Name ] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +Filter by snapshot name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveSnapshot +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveStorage.md b/docs/cmdlets/Get-PveStorage.md new file mode 100644 index 0000000..2fd625f --- /dev/null +++ b/docs/cmdlets/Get-PveStorage.md @@ -0,0 +1,137 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveStorage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveStorage [-Node ] [-Storage ] [-Type ] [-ContentType ] + [-Session ] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContentType +Filter by content type (e.g. +iso, backup). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: NodeName + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +Filter by storage type (e.g. +dir, nfs, zfspool). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Storage.PveStorage +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveStorageContent.md b/docs/cmdlets/Get-PveStorageContent.md new file mode 100644 index 0000000..290d039 --- /dev/null +++ b/docs/cmdlets/Get-PveStorageContent.md @@ -0,0 +1,121 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveStorageContent + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveStorageContent [-Node] [-Storage] [-ContentType ] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -ContentType +Filter by content type (e.g. +iso, vztmpl, backup). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Storage.PveStorageContent +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveTask.md b/docs/cmdlets/Get-PveTask.md new file mode 100644 index 0000000..a37c9e9 --- /dev/null +++ b/docs/cmdlets/Get-PveTask.md @@ -0,0 +1,105 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveTask + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveTask [-Node] [-Upid] [-Session ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Upid +The task UPID. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveTemplate.md b/docs/cmdlets/Get-PveTemplate.md new file mode 100644 index 0000000..768fd92 --- /dev/null +++ b/docs/cmdlets/Get-PveTemplate.md @@ -0,0 +1,105 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveTemplate + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveTemplate [[-Node] ] [-Name ] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +Filter by template name (supports wildcards). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveVm +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveUser.md b/docs/cmdlets/Get-PveUser.md new file mode 100644 index 0000000..547e16a --- /dev/null +++ b/docs/cmdlets/Get-PveUser.md @@ -0,0 +1,105 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveUser [[-UserId] ] [-Enabled] [-Session ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Enabled +Return only enabled users. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: EnabledOnly + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user ID in user@realm format. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Users.PveUser +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveVm.md b/docs/cmdlets/Get-PveVm.md new file mode 100644 index 0000000..97667d1 --- /dev/null +++ b/docs/cmdlets/Get-PveVm.md @@ -0,0 +1,166 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveVm [-Node ] [-VmId ] [-Name ] [-Status ] [-Tag ] [-TemplatesOnly] + [-Session ] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Name +Filter by name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Status +Filter by status (e.g. +running, stopped). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +Filter by tag. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplatesOnly +Return only VMs marked as templates. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveVm +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveVmConfig.md b/docs/cmdlets/Get-PveVmConfig.md new file mode 100644 index 0000000..bcbbf4b --- /dev/null +++ b/docs/cmdlets/Get-PveVmConfig.md @@ -0,0 +1,106 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveVmConfig + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveVmConfig -Node -VmId [-Session ] [-ProgressAction ] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveVmConfig +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Get-PveVmGuestNetwork.md b/docs/cmdlets/Get-PveVmGuestNetwork.md new file mode 100644 index 0000000..c9f864e --- /dev/null +++ b/docs/cmdlets/Get-PveVmGuestNetwork.md @@ -0,0 +1,105 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Get-PveVmGuestNetwork + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Get-PveVmGuestNetwork [-Node] [-VmId] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveGuestNetworkInterface +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Invoke-PveCloudInitRegenerate.md b/docs/cmdlets/Invoke-PveCloudInitRegenerate.md new file mode 100644 index 0000000..38b9e67 --- /dev/null +++ b/docs/cmdlets/Invoke-PveCloudInitRegenerate.md @@ -0,0 +1,151 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Invoke-PveCloudInitRegenerate + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Invoke-PveCloudInitRegenerate [-Node] [-VmId] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Invoke-PveNetworkApply.md b/docs/cmdlets/Invoke-PveNetworkApply.md new file mode 100644 index 0000000..a1ab9ca --- /dev/null +++ b/docs/cmdlets/Invoke-PveNetworkApply.md @@ -0,0 +1,136 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Invoke-PveNetworkApply + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Invoke-PveNetworkApply [-Node] [-Wait] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Invoke-PveStorageDownload.md b/docs/cmdlets/Invoke-PveStorageDownload.md new file mode 100644 index 0000000..5ed94cf --- /dev/null +++ b/docs/cmdlets/Invoke-PveStorageDownload.md @@ -0,0 +1,199 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Invoke-PveStorageDownload + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Invoke-PveStorageDownload [-Node] [-Storage] [-Url] [-Filename] + [-ContentType ] [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ContentType +Content type category. +Defaults to iso. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: iso, vztmpl, backup, import + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Filename +Filename to save the download as. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 3 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Url +The URL to download the file from. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Invoke-PveVmGuestExec.md b/docs/cmdlets/Invoke-PveVmGuestExec.md new file mode 100644 index 0000000..37a4cf3 --- /dev/null +++ b/docs/cmdlets/Invoke-PveVmGuestExec.md @@ -0,0 +1,166 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Invoke-PveVmGuestExec + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Invoke-PveVmGuestExec [-Node] [-VmId] [-Command] [-Args ] + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Args +Arguments to pass to the command. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Command +The command to execute inside the guest. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### System.Management.Automation.PSObject +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Move-PveContainer.md b/docs/cmdlets/Move-PveContainer.md new file mode 100644 index 0000000..723104e --- /dev/null +++ b/docs/cmdlets/Move-PveContainer.md @@ -0,0 +1,182 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Move-PveContainer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Move-PveContainer -Node -VmId -TargetNode [-Online] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Online +Perform live migration (container stays running). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNode +The destination node for migration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Move-PveVm.md b/docs/cmdlets/Move-PveVm.md new file mode 100644 index 0000000..515cd52 --- /dev/null +++ b/docs/cmdlets/Move-PveVm.md @@ -0,0 +1,182 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Move-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Move-PveVm -Node -VmId -TargetNode [-Online] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Online +Perform live migration (VM stays running). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNode +The destination node for migration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveApiToken.md b/docs/cmdlets/New-PveApiToken.md new file mode 100644 index 0000000..51277a4 --- /dev/null +++ b/docs/cmdlets/New-PveApiToken.md @@ -0,0 +1,182 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveApiToken + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveApiToken [-UserId] [-TokenId] [-Comment ] [-Expire ] + [-PrivilegeSeparation] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Comment +Description for this token. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expire +Token expiry as a Unix timestamp. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PrivilegeSeparation +Enable token privilege separation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenId +The API token identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user ID in user@realm format. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Users.PveApiToken +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveContainer.md b/docs/cmdlets/New-PveContainer.md new file mode 100644 index 0000000..058f065 --- /dev/null +++ b/docs/cmdlets/New-PveContainer.md @@ -0,0 +1,352 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveContainer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveContainer [-Node] [-VmId ] [-Hostname ] [-Memory ] [-Swap ] + [-Cores ] [-RootFsSize ] [-RootFsStorage ] [-OsTemplate ] + [-Password ] [-SshPublicKeys ] [-Unprivileged] [-Network ] [-Bridge ] + [-Start] [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Bridge +Network bridge to attach to (e.g. +vmbr0). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cores +Number of CPU cores to allocate. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hostname +The hostname for the container. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Memory +Memory limit in MiB. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Network +Network interface name (e.g. +eth0). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsTemplate +OS template to use for the container. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Root password for the container. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RootFsSize +Size of the root filesystem (e.g. +8G). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RootFsStorage +Storage pool for the root filesystem. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshPublicKeys +SSH public keys for the root user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Start +Start the container after creation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Swap +Swap size in MiB. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Unprivileged +Run in unprivileged mode (default true). + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveContainerSnapshot.md b/docs/cmdlets/New-PveContainerSnapshot.md new file mode 100644 index 0000000..922bb34 --- /dev/null +++ b/docs/cmdlets/New-PveContainerSnapshot.md @@ -0,0 +1,181 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveContainerSnapshot + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveContainerSnapshot [-Node] [-VmId] [-Name] [-Description ] [-Wait] + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description for the snapshot. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The snapshot name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveNetwork.md b/docs/cmdlets/New-PveNetwork.md new file mode 100644 index 0000000..5ccb0c9 --- /dev/null +++ b/docs/cmdlets/New-PveNetwork.md @@ -0,0 +1,290 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveNetwork + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveNetwork [-Node] [-Iface] [-Type] [-Address ] [-Netmask ] + [-Gateway ] [-BridgePorts ] [-BondSlaves ] [-VlanId ] [-Mtu ] + [-Autostart] [-Comments ] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Address +IPv4 address for the interface. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Autostart +Start interface automatically at boot. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BondSlaves +Bond slave interfaces (space-separated names). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BridgePorts +Bridge ports (space-separated interface names). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +Comments or notes for this interface. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Gateway +IPv4 gateway address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Iface +The network interface name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mtu +MTU override. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Netmask +IPv4 subnet mask. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The interface type (e.g. +bridge, bond, vlan). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: bridge, bond, eth, alias, vlan, OVSBridge, OVSBond, OVSPort, OVSIntPort + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VlanId +VLAN tag ID. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveRole.md b/docs/cmdlets/New-PveRole.md new file mode 100644 index 0000000..0d4b1ca --- /dev/null +++ b/docs/cmdlets/New-PveRole.md @@ -0,0 +1,136 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveRole + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveRole [-RoleId] [[-Privileges] ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Privileges +Comma-separated list of privileges. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleId +The role identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Users.PveRole +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveSdnSubnet.md b/docs/cmdlets/New-PveSdnSubnet.md new file mode 100644 index 0000000..859eef4 --- /dev/null +++ b/docs/cmdlets/New-PveSdnSubnet.md @@ -0,0 +1,198 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveSdnSubnet + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveSdnSubnet [-Vnet] [-Subnet] [-Gateway ] [-Snat] [-DnsZonePrefix ] + [-DhcpRange ] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DhcpRange +DHCP range for automatic IP assignment. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsZonePrefix +DNS zone prefix for this subnet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Gateway +Gateway IP address for the subnet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Snat +Enable source NAT for this subnet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +The subnet in CIDR notation (e.g. +10.0.0.0/24). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vnet +The SDN VNet name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveSdnVnet.md b/docs/cmdlets/New-PveSdnVnet.md new file mode 100644 index 0000000..63e0fd2 --- /dev/null +++ b/docs/cmdlets/New-PveSdnVnet.md @@ -0,0 +1,181 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveSdnVnet + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveSdnVnet [-Vnet] [-Zone] [-Tag ] [-Alias ] [-VlanAware] + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Alias +Alias or description for the VNet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tag +VLAN tag for VLAN-type zones. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VlanAware +Enable VLAN awareness on this VNet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vnet +The SDN VNet name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The SDN zone name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveSdnZone.md b/docs/cmdlets/New-PveSdnZone.md new file mode 100644 index 0000000..b5bfc22 --- /dev/null +++ b/docs/cmdlets/New-PveSdnZone.md @@ -0,0 +1,244 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveSdnZone + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveSdnZone [-Zone] [-Type] [-Peers ] [-Bridge ] [-Mtu ] + [-Dns ] [-ReverseDns ] [-DnsZone ] [-Ipam ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Bridge +Bridge interface for this zone. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Dns +DNS server for automatic registration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DnsZone +DNS zone name for registration. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Ipam +IPAM plugin to use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mtu +MTU override for this zone. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Peers +VXLAN peer list or multicast address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReverseDns +Reverse DNS server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The zone type (e.g. +vlan, vxlan, evpn, simple). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: vlan, vxlan, evpn, simple, qinq + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The SDN zone name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveSnapshot.md b/docs/cmdlets/New-PveSnapshot.md new file mode 100644 index 0000000..ffc3e9e --- /dev/null +++ b/docs/cmdlets/New-PveSnapshot.md @@ -0,0 +1,196 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveSnapshot + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveSnapshot [-Node] [-VmId] [-Name] [-Description ] [-IncludeVmState] + [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description for the snapshot. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IncludeVmState +Include VM memory state in the snapshot. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The snapshot name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveStorage.md b/docs/cmdlets/New-PveStorage.md new file mode 100644 index 0000000..6654bb4 --- /dev/null +++ b/docs/cmdlets/New-PveStorage.md @@ -0,0 +1,320 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveStorage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveStorage [-Storage] [-Type] [-Content ] [-Path ] [-Server ] + [-Export ] [-VgName ] [-ThinPool ] [-Pool ] [-CephPool ] + [-MonHost ] [-Shared] [-Disable] [-Nodes ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -CephPool +Ceph pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Content +Comma-separated content types to support. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disable +Create the storage in disabled state. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Export +NFS export path or CIFS share name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MonHost +Ceph monitor host list. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Nodes +Limit access to these nodes (comma-separated). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Base directory path (for dir type). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Pool +ZFS pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Server +NFS/CIFS server hostname or IP. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Shared +Storage is shared across cluster nodes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ThinPool +LVM thin pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +The storage type (e.g. +dir, nfs, lvm, zfspool). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: dir, nfs, lvm, lvmthin, zfspool, zfs, cephfs, rbd, iscsi, iscsidirect, glusterfs, cifs, pbs + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VgName +LVM volume group name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Storage.PveStorage +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveTemplate.md b/docs/cmdlets/New-PveTemplate.md new file mode 100644 index 0000000..93f3504 --- /dev/null +++ b/docs/cmdlets/New-PveTemplate.md @@ -0,0 +1,151 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveTemplate + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveTemplate [-Node] [-VmId] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveUser.md b/docs/cmdlets/New-PveUser.md new file mode 100644 index 0000000..5777510 --- /dev/null +++ b/docs/cmdlets/New-PveUser.md @@ -0,0 +1,227 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveUser [-UserId] [-Password ] [-FirstName ] [-LastName ] + [-Email ] [-Groups ] [-Comment ] [-Expire ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Comment +Comment or notes for this user. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +The user's email address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expire +Account expiry as a Unix timestamp. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirstName +The user's first name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Groups +Comma-separated list of groups. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastName +The user's last name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Password for the user. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user ID in user@realm format. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Users.PveUser +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveVm.md b/docs/cmdlets/New-PveVm.md new file mode 100644 index 0000000..a478c5c --- /dev/null +++ b/docs/cmdlets/New-PveVm.md @@ -0,0 +1,371 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveVm [-Node] [-VmId ] [-Name ] [-Memory ] [-Cores ] + [-Sockets ] [-CpuType ] [-Bios ] [-Machine ] [-DiskSize ] + [-DiskStorage ] [-DiskFormat ] [-Network ] [-Bridge ] [-OsType ] + [-Start] [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] + [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Bios +BIOS type: seabios (default) or ovmf (UEFI). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Bridge +Network bridge to attach to (e.g. +vmbr0). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cores +Number of CPU cores per socket. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CpuType +Emulated CPU type (e.g. +host, x86-64-v2-AES). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskFormat +Disk format (e.g. +raw, qcow2). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskSize +Size of the primary disk (e.g. +32G). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DiskStorage +Storage pool for the primary disk. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Machine +Emulated machine type (e.g. +q35, i440fx). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Memory +Memory size in MiB. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The display name of the VM. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Network +Network interface model (e.g. +virtio, e1000). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OsType +Guest OS type hint (e.g. +l26, win10). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sockets +Number of CPU sockets. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Start +Start the VM after creation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/New-PveVmFromTemplate.md b/docs/cmdlets/New-PveVmFromTemplate.md new file mode 100644 index 0000000..e78b368 --- /dev/null +++ b/docs/cmdlets/New-PveVmFromTemplate.md @@ -0,0 +1,213 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# New-PveVmFromTemplate + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +New-PveVmFromTemplate [-TemplateNode] [-VmId] [-NewVmId] [-NewName ] + [-TargetNode ] [-Full] [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Full +Perform a full (non-linked) clone. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewName +Name for the new VM. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NewVmId +VM ID for the new cloned VM. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetNode +Target node for the new VM. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TemplateNode +The node where the template resides. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Node + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveApiToken.md b/docs/cmdlets/Remove-PveApiToken.md new file mode 100644 index 0000000..fbc811a --- /dev/null +++ b/docs/cmdlets/Remove-PveApiToken.md @@ -0,0 +1,136 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveApiToken + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveApiToken [-UserId] [-TokenId] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TokenId +The API token identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -UserId +The user ID in user@realm format. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveContainer.md b/docs/cmdlets/Remove-PveContainer.md new file mode 100644 index 0000000..c76fba6 --- /dev/null +++ b/docs/cmdlets/Remove-PveContainer.md @@ -0,0 +1,182 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveContainer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveContainer -Node -VmId [-Purge] [-Force] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force the operation without additional checks. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Purge +Remove all associated resources. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveContainerSnapshot.md b/docs/cmdlets/Remove-PveContainerSnapshot.md new file mode 100644 index 0000000..766c1de --- /dev/null +++ b/docs/cmdlets/Remove-PveContainerSnapshot.md @@ -0,0 +1,166 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveContainerSnapshot + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveContainerSnapshot [-Node] [-VmId] [-Name] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The snapshot name to remove. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveNetwork.md b/docs/cmdlets/Remove-PveNetwork.md new file mode 100644 index 0000000..ae06db5 --- /dev/null +++ b/docs/cmdlets/Remove-PveNetwork.md @@ -0,0 +1,136 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveNetwork + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveNetwork [-Node] [-Iface] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Iface +The network interface name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveRole.md b/docs/cmdlets/Remove-PveRole.md new file mode 100644 index 0000000..1bd317a --- /dev/null +++ b/docs/cmdlets/Remove-PveRole.md @@ -0,0 +1,121 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveRole + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveRole [-RoleId] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RoleId +The role identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveSdnSubnet.md b/docs/cmdlets/Remove-PveSdnSubnet.md new file mode 100644 index 0000000..a2bac08 --- /dev/null +++ b/docs/cmdlets/Remove-PveSdnSubnet.md @@ -0,0 +1,136 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveSdnSubnet + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveSdnSubnet [-Vnet] [-Subnet] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Subnet +The subnet CIDR to remove. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Vnet +The SDN VNet name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveSdnVnet.md b/docs/cmdlets/Remove-PveSdnVnet.md new file mode 100644 index 0000000..70ed51c --- /dev/null +++ b/docs/cmdlets/Remove-PveSdnVnet.md @@ -0,0 +1,121 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveSdnVnet + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveSdnVnet [-Vnet] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Vnet +The SDN VNet name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveSdnZone.md b/docs/cmdlets/Remove-PveSdnZone.md new file mode 100644 index 0000000..221a760 --- /dev/null +++ b/docs/cmdlets/Remove-PveSdnZone.md @@ -0,0 +1,121 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveSdnZone + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveSdnZone [-Zone] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Zone +The SDN zone name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveSnapshot.md b/docs/cmdlets/Remove-PveSnapshot.md new file mode 100644 index 0000000..12c5eb5 --- /dev/null +++ b/docs/cmdlets/Remove-PveSnapshot.md @@ -0,0 +1,166 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveSnapshot + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveSnapshot [-Node] [-VmId] [-Name] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The snapshot name to remove. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveStorage.md b/docs/cmdlets/Remove-PveStorage.md new file mode 100644 index 0000000..53c2609 --- /dev/null +++ b/docs/cmdlets/Remove-PveStorage.md @@ -0,0 +1,121 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveStorage + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveStorage [-Storage] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveTemplate.md b/docs/cmdlets/Remove-PveTemplate.md new file mode 100644 index 0000000..bfc8267 --- /dev/null +++ b/docs/cmdlets/Remove-PveTemplate.md @@ -0,0 +1,166 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveTemplate + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveTemplate [-Node] [-VmId] [-Purge] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Purge +Remove all associated resources. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveUser.md b/docs/cmdlets/Remove-PveUser.md new file mode 100644 index 0000000..acb7902 --- /dev/null +++ b/docs/cmdlets/Remove-PveUser.md @@ -0,0 +1,121 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveUser [-UserId] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user ID in user@realm format. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Remove-PveVm.md b/docs/cmdlets/Remove-PveVm.md new file mode 100644 index 0000000..4e4a99c --- /dev/null +++ b/docs/cmdlets/Remove-PveVm.md @@ -0,0 +1,182 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Remove-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Remove-PveVm -Node -VmId [-Purge] [-Force] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force +Force the operation without additional checks. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Purge +Remove all associated resources. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Reset-PveVm.md b/docs/cmdlets/Reset-PveVm.md new file mode 100644 index 0000000..1d2cb95 --- /dev/null +++ b/docs/cmdlets/Reset-PveVm.md @@ -0,0 +1,152 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Reset-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Reset-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Resize-PveVmDisk.md b/docs/cmdlets/Resize-PveVmDisk.md new file mode 100644 index 0000000..595bd14 --- /dev/null +++ b/docs/cmdlets/Resize-PveVmDisk.md @@ -0,0 +1,184 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Resize-PveVmDisk + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Resize-PveVmDisk -Node -VmId -Disk -Size [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Disk +The disk slot to resize (e.g. +virtio0, scsi0). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Size +New disk size (e.g. +50G or +10G to grow). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Restart-PveContainer.md b/docs/cmdlets/Restart-PveContainer.md new file mode 100644 index 0000000..d613418 --- /dev/null +++ b/docs/cmdlets/Restart-PveContainer.md @@ -0,0 +1,167 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Restart-PveContainer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Restart-PveContainer -Node -VmId [-Timeout ] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Maximum time to wait for the task. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Restart-PveVm.md b/docs/cmdlets/Restart-PveVm.md new file mode 100644 index 0000000..280df8f --- /dev/null +++ b/docs/cmdlets/Restart-PveVm.md @@ -0,0 +1,167 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Restart-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Restart-PveVm -Node -VmId [-Timeout ] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Maximum time to wait for the task. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Restore-PveContainerSnapshot.md b/docs/cmdlets/Restore-PveContainerSnapshot.md new file mode 100644 index 0000000..14af519 --- /dev/null +++ b/docs/cmdlets/Restore-PveContainerSnapshot.md @@ -0,0 +1,166 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Restore-PveContainerSnapshot + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Restore-PveContainerSnapshot [-Node] [-VmId] [-Name] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The snapshot name to roll back to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Restore-PveSnapshot.md b/docs/cmdlets/Restore-PveSnapshot.md new file mode 100644 index 0000000..d56b3c4 --- /dev/null +++ b/docs/cmdlets/Restore-PveSnapshot.md @@ -0,0 +1,166 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Restore-PveSnapshot + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Restore-PveSnapshot [-Node] [-VmId] [-Name] [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Name +The snapshot name to roll back to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Resume-PveVm.md b/docs/cmdlets/Resume-PveVm.md new file mode 100644 index 0000000..46408f5 --- /dev/null +++ b/docs/cmdlets/Resume-PveVm.md @@ -0,0 +1,152 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Resume-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Resume-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Send-PveIso.md b/docs/cmdlets/Send-PveIso.md new file mode 100644 index 0000000..56b437b --- /dev/null +++ b/docs/cmdlets/Send-PveIso.md @@ -0,0 +1,198 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Send-PveIso + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Send-PveIso [-Node] [-Storage] [-Path] [-Checksum ] + [-ChecksumAlgorithm ] [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Checksum +Checksum value to verify the upload. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ChecksumAlgorithm +Checksum algorithm (md5, sha1, sha256, sha512). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: md5, sha1, sha256, sha512 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +Local path to the ISO file to upload. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Storage +The storage pool name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Set-PveCloudInitConfig.md b/docs/cmdlets/Set-PveCloudInitConfig.md new file mode 100644 index 0000000..4171530 --- /dev/null +++ b/docs/cmdlets/Set-PveCloudInitConfig.md @@ -0,0 +1,259 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Set-PveCloudInitConfig + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-PveCloudInitConfig [-Node] [-VmId] [-Hostname ] [-CiUser ] + [-Password ] [-SshKeys ] [-IpConfig0 ] [-Nameserver ] + [-Searchdomain ] [-Wait] [-Session ] [-ProgressAction ] [-WhatIf] + [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -CiUser +Cloud-init default username. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: User + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hostname +Cloud-init hostname override. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -IpConfig0 +IP config string (e.g. +ip=192.168.1.50/24,gw=...). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Nameserver +DNS nameserver(s) to inject. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +Cloud-init default user password. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Searchdomain +DNS search domain to inject. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SshKeys +SSH public keys to inject. + +```yaml +Type: String[] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Set-PveContainerConfig.md b/docs/cmdlets/Set-PveContainerConfig.md new file mode 100644 index 0000000..8ff107f --- /dev/null +++ b/docs/cmdlets/Set-PveContainerConfig.md @@ -0,0 +1,289 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Set-PveContainerConfig + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-PveContainerConfig -Node -VmId [-Hostname ] [-Cores ] [-Memory ] + [-Swap ] [-Description ] [-Tags ] [-Nameserver ] [-SearchDomain ] + [-AdditionalConfig ] [-Delete ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AdditionalConfig +Extra config keys as a hashtable. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cores +Number of CPU cores to allocate. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delete +Comma-separated config keys to delete. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description or notes for the container. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Hostname +The hostname for the container. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Memory +Memory limit in MiB. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Nameserver +DNS nameservers (space-separated). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -SearchDomain +DNS search domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Swap +Swap size in MiB. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +Semicolon-separated list of tags. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Set-PveNetwork.md b/docs/cmdlets/Set-PveNetwork.md new file mode 100644 index 0000000..7c88910 --- /dev/null +++ b/docs/cmdlets/Set-PveNetwork.md @@ -0,0 +1,303 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Set-PveNetwork + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-PveNetwork [-Node] [-Iface] [-Address ] [-Netmask ] [-Gateway ] + [-Address6 ] [-Netmask6 ] [-Gateway6 ] [-BridgePorts ] [-BondSlaves ] + [-Mtu ] [-Autostart] [-Comments ] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Address +IPv4 address for the interface. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Address6 +IPv6 address for the interface. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Autostart +Start interface automatically at boot. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BondSlaves +Bond slave interfaces (space-separated names). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BridgePorts +Bridge ports (space-separated interface names). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Comments +Comments or notes for this interface. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Gateway +IPv4 gateway address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Gateway6 +IPv6 gateway address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Iface +The network interface name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Mtu +MTU override. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Netmask +IPv4 subnet mask. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Netmask6 +IPv6 prefix length. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Set-PvePermission.md b/docs/cmdlets/Set-PvePermission.md new file mode 100644 index 0000000..06907cc --- /dev/null +++ b/docs/cmdlets/Set-PvePermission.md @@ -0,0 +1,199 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Set-PvePermission + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-PvePermission [-Path] [-UgId] [-Role] [-Type ] [-Propagate] [-Delete] + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delete +Remove the ACL entry instead of adding it. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Path +The resource path (e.g. +/, /vms/100). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Propagate +Propagate this ACL to child paths. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Role +The role to assign (e.g. +Administrator). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Type +ACL entry type: user or group. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: +Accepted values: user, group + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UgId +The user or group identifier. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Set-PveUser.md b/docs/cmdlets/Set-PveUser.md new file mode 100644 index 0000000..d89f9e9 --- /dev/null +++ b/docs/cmdlets/Set-PveUser.md @@ -0,0 +1,242 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Set-PveUser + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-PveUser [-UserId] [-Password ] [-FirstName ] [-LastName ] + [-Email ] [-Groups ] [-Comment ] [-Expire ] [-Enable ] + [-Session ] [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Comment +Updated comment or notes. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Email +Updated email address. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable +Enable or disable the user account. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Expire +Account expiry as a Unix timestamp. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -FirstName +Updated first name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Groups +Updated group membership (comma-separated). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LastName +Updated last name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Password +New password for the user. + +```yaml +Type: SecureString +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserId +The user ID in user@realm format. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Set-PveVmConfig.md b/docs/cmdlets/Set-PveVmConfig.md new file mode 100644 index 0000000..fa71cf0 --- /dev/null +++ b/docs/cmdlets/Set-PveVmConfig.md @@ -0,0 +1,307 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Set-PveVmConfig + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Set-PveVmConfig -Node -VmId [-Cores ] [-Sockets ] [-Memory ] + [-CpuType ] [-Description ] [-Tags ] [-Bios ] [-Machine ] + [-OsType ] [-AdditionalConfig ] [-Delete ] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -AdditionalConfig +Extra config keys as a hashtable. + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Bios +BIOS type: seabios or ovmf. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Cores +Number of CPU cores per socket. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CpuType +Emulated CPU type (e.g. +host, x86-64-v2-AES). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Delete +Comma-separated config keys to delete. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description +Description or notes for the VM. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Machine +Emulated machine type (e.g. +q35, i440fx). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Memory +Memory size in MiB. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -OsType +Guest OS type hint (e.g. +l26, win10). + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Sockets +Number of CPU sockets. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tags +Semicolon-separated list of tags. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### System.Object +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Start-PveContainer.md b/docs/cmdlets/Start-PveContainer.md new file mode 100644 index 0000000..bfc860c --- /dev/null +++ b/docs/cmdlets/Start-PveContainer.md @@ -0,0 +1,152 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Start-PveContainer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Start-PveContainer -Node -VmId [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Start-PveVm.md b/docs/cmdlets/Start-PveVm.md new file mode 100644 index 0000000..141a37b --- /dev/null +++ b/docs/cmdlets/Start-PveVm.md @@ -0,0 +1,152 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Start-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Start-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Stop-PveContainer.md b/docs/cmdlets/Stop-PveContainer.md new file mode 100644 index 0000000..2577614 --- /dev/null +++ b/docs/cmdlets/Stop-PveContainer.md @@ -0,0 +1,152 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Stop-PveContainer + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Stop-PveContainer -Node -VmId [-Wait] [-Session ] + [-ProgressAction ] [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The container identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Stop-PveVm.md b/docs/cmdlets/Stop-PveVm.md new file mode 100644 index 0000000..b80dc64 --- /dev/null +++ b/docs/cmdlets/Stop-PveVm.md @@ -0,0 +1,152 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Stop-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Stop-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Suspend-PveVm.md b/docs/cmdlets/Suspend-PveVm.md new file mode 100644 index 0000000..c9ec0ad --- /dev/null +++ b/docs/cmdlets/Suspend-PveVm.md @@ -0,0 +1,152 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Suspend-PveVm + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Suspend-PveVm -Node -VmId [-Wait] [-Session ] [-ProgressAction ] + [-WhatIf] [-Confirm] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Confirm +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -Wait +Wait for the task to complete before returning. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +Shows what would happen if the cmdlet runs. +The cmdlet is not run. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +### System.Int32 +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Test-PveConnection.md b/docs/cmdlets/Test-PveConnection.md new file mode 100644 index 0000000..22af742 --- /dev/null +++ b/docs/cmdlets/Test-PveConnection.md @@ -0,0 +1,75 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Test-PveConnection + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Test-PveConnection [-Detailed] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Detailed +Return the session object instead of a boolean. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### None +## OUTPUTS + +### System.Boolean +### PSProxmoxVE.Core.Authentication.PveSession +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Test-PveVmGuestAgent.md b/docs/cmdlets/Test-PveVmGuestAgent.md new file mode 100644 index 0000000..f254f18 --- /dev/null +++ b/docs/cmdlets/Test-PveVmGuestAgent.md @@ -0,0 +1,105 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Test-PveVmGuestAgent + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Test-PveVmGuestAgent [-Node] [-VmId] [-Session ] + [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VmId +The VM identifier. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.Int32 +## OUTPUTS + +### System.Boolean +## NOTES + +## RELATED LINKS diff --git a/docs/cmdlets/Wait-PveTask.md b/docs/cmdlets/Wait-PveTask.md new file mode 100644 index 0000000..e18db32 --- /dev/null +++ b/docs/cmdlets/Wait-PveTask.md @@ -0,0 +1,135 @@ +--- +external help file: PSProxmoxVE.dll-Help.xml +Module Name: PSProxmoxVE +online version: +schema: 2.0.0 +--- + +# Wait-PveTask + +## SYNOPSIS +{{ Fill in the Synopsis }} + +## SYNTAX + +``` +Wait-PveTask [-Node] [-Upid] [-Timeout ] [-PollInterval ] + [-Session ] [-ProgressAction ] [] +``` + +## DESCRIPTION +{{ Fill in the Description }} + +## EXAMPLES + +### Example 1 +```powershell +PS C:\> {{ Add example code here }} +``` + +{{ Add example description here }} + +## PARAMETERS + +### -Node +The PVE node name. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PollInterval +How often to poll task status. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Session +{{ Fill Session Description }} + +```yaml +Type: PveSession +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Timeout +Maximum time to wait for the task. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Upid +The task UPID. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + +### -ProgressAction +{{ Fill ProgressAction Description }} + +```yaml +Type: ActionPreference +Parameter Sets: (All) +Aliases: proga + +Required: False +Position: Named +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](http://go.microsoft.com/fwlink/?LinkID=113216). + +## INPUTS + +### System.String +## OUTPUTS + +### PSProxmoxVE.Core.Models.Vms.PveTask +## NOTES + +## RELATED LINKS diff --git a/generate-help.ps1 b/generate-help.ps1 new file mode 100644 index 0000000..2d1af83 --- /dev/null +++ b/generate-help.ps1 @@ -0,0 +1,79 @@ +#!/usr/bin/env pwsh +<# +.SYNOPSIS + Generates platyPS markdown help stubs and MAML XML help for PSProxmoxVE. + +.DESCRIPTION + This script: + 1. Builds the module to publish/netstandard2.0/ + 2. Installs platyPS if needed + 3. Generates markdown help stubs in docs/cmdlets/ + 4. Generates MAML XML help in publish/netstandard2.0/ + 5. Copies the MAML XML to src/PSProxmoxVE/ for inclusion in builds + +.NOTES + Run from the repository root: + pwsh -NoProfile -File ./generate-help.ps1 +#> + +$ErrorActionPreference = 'Stop' +Set-StrictMode -Version Latest + +$repoRoot = $PSScriptRoot +Push-Location $repoRoot + +try { + # Step 1: Build the module + Write-Host "Building module..." -ForegroundColor Cyan + dotnet publish src/PSProxmoxVE/PSProxmoxVE.csproj --configuration Release --framework netstandard2.0 --output ./publish/netstandard2.0 | Out-Null + Remove-Item ./publish/netstandard2.0/*.deps.json, ./publish/netstandard2.0/*.runtimeconfig.json -ErrorAction SilentlyContinue + + # Step 2: Install platyPS if needed + if (-not (Get-Module -ListAvailable -Name platyPS)) { + Write-Host "Installing platyPS..." -ForegroundColor Cyan + Install-Module platyPS -Force -Scope CurrentUser + } + + # Step 3: Import modules + Write-Host "Importing modules..." -ForegroundColor Cyan + Import-Module platyPS -Force + Import-Module ./publish/netstandard2.0/PSProxmoxVE.psd1 -Force + + # Step 4: Create output directory + $docsDir = Join-Path $repoRoot 'docs/cmdlets' + if (-not (Test-Path $docsDir)) { + New-Item -ItemType Directory -Path $docsDir -Force | Out-Null + } + + # Step 5: Generate markdown help stubs + Write-Host "Generating markdown help stubs..." -ForegroundColor Cyan + New-MarkdownHelp -Module PSProxmoxVE -OutputFolder $docsDir -Force | Out-Null + + $mdCount = (Get-ChildItem "$docsDir/*.md" | Measure-Object).Count + Write-Host " Generated $mdCount markdown files" -ForegroundColor Green + + # Step 6: Generate MAML XML help + Write-Host "Generating MAML XML help..." -ForegroundColor Cyan + New-ExternalHelp -Path $docsDir -OutputPath ./publish/netstandard2.0/ -Force | Out-Null + + # Step 7: Copy MAML XML to src directory for build inclusion + $mamlFiles = Get-ChildItem ./publish/netstandard2.0/*-Help.xml + foreach ($f in $mamlFiles) { + $dest = Join-Path 'src/PSProxmoxVE' $f.Name + Copy-Item $f.FullName $dest -Force + Write-Host " Copied $($f.Name) to src/PSProxmoxVE/" -ForegroundColor Green + } + + # Step 8: Verify + Write-Host "`nVerification:" -ForegroundColor Cyan + Write-Host " Markdown files: $mdCount" -ForegroundColor Green + foreach ($f in $mamlFiles) { + $size = [math]::Round($f.Length / 1024, 1) + Write-Host " MAML XML: $($f.Name) (${size} KB)" -ForegroundColor Green + } + + Write-Host "`nDone! Help generation complete." -ForegroundColor Green +} +finally { + Pop-Location +} diff --git a/src/PSProxmoxVE/PSProxmoxVE.csproj b/src/PSProxmoxVE/PSProxmoxVE.csproj index f1ce353..84247a7 100644 --- a/src/PSProxmoxVE/PSProxmoxVE.csproj +++ b/src/PSProxmoxVE/PSProxmoxVE.csproj @@ -25,6 +25,7 @@ + diff --git a/src/PSProxmoxVE/PSProxmoxVE.dll-Help.xml b/src/PSProxmoxVE/PSProxmoxVE.dll-Help.xml new file mode 100644 index 0000000..2d5c9d6 --- /dev/null +++ b/src/PSProxmoxVE/PSProxmoxVE.dll-Help.xml @@ -0,0 +1,19811 @@ + + + + + Connect-PveServer + Connect + PveServer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Connect-PveServer + + Server + + Hostname or IP of the Proxmox VE server. + + String + + String + + + None + + + ApiToken + + API token in USER@REALM!TOKENID=UUID format. + + String + + String + + + None + + + PassThru + + Output the session object to the pipeline. + + + SwitchParameter + + + False + + + Port + + API port. Defaults to 8006. + + Int32 + + Int32 + + + None + + + SkipCertificateCheck + + Skip TLS certificate validation. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + Connect-PveServer + + Server + + Hostname or IP of the Proxmox VE server. + + String + + String + + + None + + + Credential + + Username and password. Username must include realm (e.g. root@pam). + + PSCredential + + PSCredential + + + None + + + PassThru + + Output the session object to the pipeline. + + + SwitchParameter + + + False + + + Port + + API port. Defaults to 8006. + + Int32 + + Int32 + + + None + + + SkipCertificateCheck + + Skip TLS certificate validation. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + ApiToken + + API token in USER@REALM!TOKENID=UUID format. + + String + + String + + + None + + + Credential + + Username and password. Username must include realm (e.g. root@pam). + + PSCredential + + PSCredential + + + None + + + PassThru + + Output the session object to the pipeline. + + SwitchParameter + + SwitchParameter + + + False + + + Port + + API port. Defaults to 8006. + + Int32 + + Int32 + + + None + + + Server + + Hostname or IP of the Proxmox VE server. + + String + + String + + + None + + + SkipCertificateCheck + + Skip TLS certificate validation. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Authentication.PveSession + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Copy-PveContainer + Copy + PveContainer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Copy-PveContainer + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Full + + Perform a full (non-linked) clone. + + + SwitchParameter + + + False + + + NewName + + Hostname for the new clone. + + String + + String + + + None + + + NewVmId + + Container ID for the new clone. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + SourceNode + + The node where the source container resides. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + TargetNode + + Target node for the clone. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Full + + Perform a full (non-linked) clone. + + SwitchParameter + + SwitchParameter + + + False + + + NewName + + Hostname for the new clone. + + String + + String + + + None + + + NewVmId + + Container ID for the new clone. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + SourceNode + + The node where the source container resides. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + TargetNode + + Target node for the clone. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Copy-PveVm + Copy + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Copy-PveVm + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Full + + Perform a full (non-linked) clone. + + + SwitchParameter + + + False + + + NewName + + Display name for the new clone. + + String + + String + + + None + + + NewVmId + + VM ID for the new clone. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + SourceNode + + The node where the source VM resides. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + TargetNode + + Target node for the clone. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Full + + Perform a full (non-linked) clone. + + SwitchParameter + + SwitchParameter + + + False + + + NewName + + Display name for the new clone. + + String + + String + + + None + + + NewVmId + + VM ID for the new clone. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + SourceNode + + The node where the source VM resides. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + TargetNode + + Target node for the clone. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Disconnect-PveServer + Disconnect + PveServer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Disconnect-PveServer + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveApiToken + Get + PveApiToken + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveApiToken + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + TokenId + + The API token identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TokenId + + The API token identifier. + + String + + String + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveApiToken + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveCloudInitConfig + Get + PveCloudInitConfig + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveCloudInitConfig + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveVmConfig + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveContainer + Get + PveContainer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveContainer + + Name + + Filter by name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Status + + Filter by status (e.g. running, stopped). + + String + + String + + + None + + + Tag + + Filter by tag. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Filter by name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Status + + Filter by status (e.g. running, stopped). + + String + + String + + + None + + + Tag + + Filter by tag. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Containers.PveContainer + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveContainerConfig + Get + PveContainerConfig + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveContainerConfig + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Containers.PveContainerConfig + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveContainerSnapshot + Get + PveContainerSnapshot + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveContainerSnapshot + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Name + + Filter by snapshot name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Filter by snapshot name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveSnapshot + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveNetwork + Get + PveNetwork + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveNetwork + + Node + + The PVE node name. + + String + + String + + + None + + + Iface + + The network interface name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + Filter by interface type (e.g. bridge, bond). + + + bridge + bond + eth + alias + vlan + OVSBridge + OVSBond + OVSPort + OVSIntPort + any_bridge + any_local_bridge + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Iface + + The network interface name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + Filter by interface type (e.g. bridge, bond). + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Network.PveNetwork + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveNode + Get + PveNode + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveNode + + Name + + Filter by node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Filter by node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Nodes.PveNode + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveNodeStatus + Get + PveNodeStatus + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveNodeStatus + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Nodes.PveNodeStatus + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PvePermission + Get + PvePermission + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PvePermission + + Path + + Filter by resource path (e.g. /, /vms/100). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Path + + Filter by resource path (e.g. /, /vms/100). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PvePermission + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveRole + Get + PveRole + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveRole + + RoleId + + The role identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + RoleId + + The role identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveRole + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveSdnSubnet + Get + PveSdnSubnet + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveSdnSubnet + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Subnet + + Filter by subnet CIDR (e.g. 10.0.0.0/24). + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Subnet + + Filter by subnet CIDR (e.g. 10.0.0.0/24). + + String + + String + + + None + + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Network.PveSdnSubnet + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveSdnVnet + Get + PveSdnVnet + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveSdnVnet + + Zone + + The SDN zone name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + Zone + + The SDN zone name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Network.PveSdnVnet + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveSdnZone + Get + PveSdnZone + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveSdnZone + + Zone + + The SDN zone name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Zone + + The SDN zone name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Network.PveSdnZone + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveSnapshot + Get + PveSnapshot + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveSnapshot + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Name + + Filter by snapshot name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Filter by snapshot name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveSnapshot + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveStorage + Get + PveStorage + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveStorage + + ContentType + + Filter by content type (e.g. iso, backup). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Type + + Filter by storage type (e.g. dir, nfs, zfspool). + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + ContentType + + Filter by content type (e.g. iso, backup). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Type + + Filter by storage type (e.g. dir, nfs, zfspool). + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Storage.PveStorage + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveStorageContent + Get + PveStorageContent + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveStorageContent + + Node + + The PVE node name. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + ContentType + + Filter by content type (e.g. iso, vztmpl, backup). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + ContentType + + Filter by content type (e.g. iso, vztmpl, backup). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Storage.PveStorageContent + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveTask + Get + PveTask + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveTask + + Node + + The PVE node name. + + String + + String + + + None + + + Upid + + The task UPID. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Upid + + The task UPID. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveTemplate + Get + PveTemplate + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveTemplate + + Node + + The PVE node name. + + String + + String + + + None + + + Name + + Filter by template name (supports wildcards). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Filter by template name (supports wildcards). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveVm + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveUser + Get + PveUser + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveUser + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + Enabled + + Return only enabled users. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Enabled + + Return only enabled users. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveUser + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveVm + Get + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveVm + + Name + + Filter by name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Status + + Filter by status (e.g. running, stopped). + + String + + String + + + None + + + Tag + + Filter by tag. + + String + + String + + + None + + + TemplatesOnly + + Return only VMs marked as templates. + + + SwitchParameter + + + False + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Name + + Filter by name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Status + + Filter by status (e.g. running, stopped). + + String + + String + + + None + + + Tag + + Filter by tag. + + String + + String + + + None + + + TemplatesOnly + + Return only VMs marked as templates. + + SwitchParameter + + SwitchParameter + + + False + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveVm + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveVmConfig + Get + PveVmConfig + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveVmConfig + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveVmConfig + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Get-PveVmGuestNetwork + Get + PveVmGuestNetwork + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Get-PveVmGuestNetwork + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveGuestNetworkInterface + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Invoke-PveCloudInitRegenerate + Invoke + PveCloudInitRegenerate + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Invoke-PveCloudInitRegenerate + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Invoke-PveNetworkApply + Invoke + PveNetworkApply + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Invoke-PveNetworkApply + + Node + + The PVE node name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Invoke-PveStorageDownload + Invoke + PveStorageDownload + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Invoke-PveStorageDownload + + Node + + The PVE node name. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Url + + The URL to download the file from. + + String + + String + + + None + + + Filename + + Filename to save the download as. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + ContentType + + Content type category. Defaults to iso. + + + iso + vztmpl + backup + import + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + ContentType + + Content type category. Defaults to iso. + + String + + String + + + None + + + Filename + + Filename to save the download as. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Url + + The URL to download the file from. + + String + + String + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Invoke-PveVmGuestExec + Invoke + PveVmGuestExec + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Invoke-PveVmGuestExec + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Command + + The command to execute inside the guest. + + String + + String + + + None + + + Args + + Arguments to pass to the command. + + String[] + + String[] + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Args + + Arguments to pass to the command. + + String[] + + String[] + + + None + + + Command + + The command to execute inside the guest. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + System.Management.Automation.PSObject + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Move-PveContainer + Move + PveContainer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Move-PveContainer + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Online + + Perform live migration (container stays running). + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TargetNode + + The destination node for migration. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Online + + Perform live migration (container stays running). + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TargetNode + + The destination node for migration. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Move-PveVm + Move + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Move-PveVm + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Online + + Perform live migration (VM stays running). + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TargetNode + + The destination node for migration. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Online + + Perform live migration (VM stays running). + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TargetNode + + The destination node for migration. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveApiToken + New + PveApiToken + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveApiToken + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + TokenId + + The API token identifier. + + String + + String + + + None + + + Comment + + Description for this token. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Expire + + Token expiry as a Unix timestamp. + + Int64 + + Int64 + + + None + + + PrivilegeSeparation + + Enable token privilege separation. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Description for this token. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Expire + + Token expiry as a Unix timestamp. + + Int64 + + Int64 + + + None + + + PrivilegeSeparation + + Enable token privilege separation. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TokenId + + The API token identifier. + + String + + String + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveApiToken + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveContainer + New + PveContainer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveContainer + + Node + + The PVE node name. + + String + + String + + + None + + + Bridge + + Network bridge to attach to (e.g. vmbr0). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Cores + + Number of CPU cores to allocate. + + Int32 + + Int32 + + + None + + + Hostname + + The hostname for the container. + + String + + String + + + None + + + Memory + + Memory limit in MiB. + + Int32 + + Int32 + + + None + + + Network + + Network interface name (e.g. eth0). + + String + + String + + + None + + + OsTemplate + + OS template to use for the container. + + String + + String + + + None + + + Password + + Root password for the container. + + SecureString + + SecureString + + + None + + + RootFsSize + + Size of the root filesystem (e.g. 8G). + + String + + String + + + None + + + RootFsStorage + + Storage pool for the root filesystem. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + SshPublicKeys + + SSH public keys for the root user. + + String + + String + + + None + + + Start + + Start the container after creation. + + + SwitchParameter + + + False + + + Swap + + Swap size in MiB. + + Int32 + + Int32 + + + None + + + Unprivileged + + Run in unprivileged mode (default true). + + + SwitchParameter + + + False + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Bridge + + Network bridge to attach to (e.g. vmbr0). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Cores + + Number of CPU cores to allocate. + + Int32 + + Int32 + + + None + + + Hostname + + The hostname for the container. + + String + + String + + + None + + + Memory + + Memory limit in MiB. + + Int32 + + Int32 + + + None + + + Network + + Network interface name (e.g. eth0). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + OsTemplate + + OS template to use for the container. + + String + + String + + + None + + + Password + + Root password for the container. + + SecureString + + SecureString + + + None + + + RootFsSize + + Size of the root filesystem (e.g. 8G). + + String + + String + + + None + + + RootFsStorage + + Storage pool for the root filesystem. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + SshPublicKeys + + SSH public keys for the root user. + + String + + String + + + None + + + Start + + Start the container after creation. + + SwitchParameter + + SwitchParameter + + + False + + + Swap + + Swap size in MiB. + + Int32 + + Int32 + + + None + + + Unprivileged + + Run in unprivileged mode (default true). + + SwitchParameter + + SwitchParameter + + + False + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveContainerSnapshot + New + PveContainerSnapshot + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveContainerSnapshot + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Name + + The snapshot name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Description + + Description for the snapshot. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Description + + Description for the snapshot. + + String + + String + + + None + + + Name + + The snapshot name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveNetwork + New + PveNetwork + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveNetwork + + Node + + The PVE node name. + + String + + String + + + None + + + Iface + + The network interface name. + + String + + String + + + None + + + Type + + The interface type (e.g. bridge, bond, vlan). + + + bridge + bond + eth + alias + vlan + OVSBridge + OVSBond + OVSPort + OVSIntPort + + String + + String + + + None + + + Address + + IPv4 address for the interface. + + String + + String + + + None + + + Autostart + + Start interface automatically at boot. + + + SwitchParameter + + + False + + + BondSlaves + + Bond slave interfaces (space-separated names). + + String + + String + + + None + + + BridgePorts + + Bridge ports (space-separated interface names). + + String + + String + + + None + + + Comments + + Comments or notes for this interface. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Gateway + + IPv4 gateway address. + + String + + String + + + None + + + Mtu + + MTU override. + + Int32 + + Int32 + + + None + + + Netmask + + IPv4 subnet mask. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VlanId + + VLAN tag ID. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Address + + IPv4 address for the interface. + + String + + String + + + None + + + Autostart + + Start interface automatically at boot. + + SwitchParameter + + SwitchParameter + + + False + + + BondSlaves + + Bond slave interfaces (space-separated names). + + String + + String + + + None + + + BridgePorts + + Bridge ports (space-separated interface names). + + String + + String + + + None + + + Comments + + Comments or notes for this interface. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Gateway + + IPv4 gateway address. + + String + + String + + + None + + + Iface + + The network interface name. + + String + + String + + + None + + + Mtu + + MTU override. + + Int32 + + Int32 + + + None + + + Netmask + + IPv4 subnet mask. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + The interface type (e.g. bridge, bond, vlan). + + String + + String + + + None + + + VlanId + + VLAN tag ID. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveRole + New + PveRole + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveRole + + RoleId + + The role identifier. + + String + + String + + + None + + + Privileges + + Comma-separated list of privileges. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Privileges + + Comma-separated list of privileges. + + String + + String + + + None + + + RoleId + + The role identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveRole + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveSdnSubnet + New + PveSdnSubnet + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveSdnSubnet + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + Subnet + + The subnet in CIDR notation (e.g. 10.0.0.0/24). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + DhcpRange + + DHCP range for automatic IP assignment. + + String + + String + + + None + + + DnsZonePrefix + + DNS zone prefix for this subnet. + + String + + String + + + None + + + Gateway + + Gateway IP address for the subnet. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Snat + + Enable source NAT for this subnet. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + DhcpRange + + DHCP range for automatic IP assignment. + + String + + String + + + None + + + DnsZonePrefix + + DNS zone prefix for this subnet. + + String + + String + + + None + + + Gateway + + Gateway IP address for the subnet. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Snat + + Enable source NAT for this subnet. + + SwitchParameter + + SwitchParameter + + + False + + + Subnet + + The subnet in CIDR notation (e.g. 10.0.0.0/24). + + String + + String + + + None + + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveSdnVnet + New + PveSdnVnet + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveSdnVnet + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + Zone + + The SDN zone name. + + String + + String + + + None + + + Alias + + Alias or description for the VNet. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Tag + + VLAN tag for VLAN-type zones. + + Int32 + + Int32 + + + None + + + VlanAware + + Enable VLAN awareness on this VNet. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Alias + + Alias or description for the VNet. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Tag + + VLAN tag for VLAN-type zones. + + Int32 + + Int32 + + + None + + + VlanAware + + Enable VLAN awareness on this VNet. + + SwitchParameter + + SwitchParameter + + + False + + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Zone + + The SDN zone name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveSdnZone + New + PveSdnZone + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveSdnZone + + Zone + + The SDN zone name. + + String + + String + + + None + + + Type + + The zone type (e.g. vlan, vxlan, evpn, simple). + + + vlan + vxlan + evpn + simple + qinq + + String + + String + + + None + + + Bridge + + Bridge interface for this zone. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Dns + + DNS server for automatic registration. + + String + + String + + + None + + + DnsZone + + DNS zone name for registration. + + String + + String + + + None + + + Ipam + + IPAM plugin to use. + + String + + String + + + None + + + Mtu + + MTU override for this zone. + + Int32 + + Int32 + + + None + + + Peers + + VXLAN peer list or multicast address. + + String + + String + + + None + + + ReverseDns + + Reverse DNS server. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Bridge + + Bridge interface for this zone. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Dns + + DNS server for automatic registration. + + String + + String + + + None + + + DnsZone + + DNS zone name for registration. + + String + + String + + + None + + + Ipam + + IPAM plugin to use. + + String + + String + + + None + + + Mtu + + MTU override for this zone. + + Int32 + + Int32 + + + None + + + Peers + + VXLAN peer list or multicast address. + + String + + String + + + None + + + ReverseDns + + Reverse DNS server. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + The zone type (e.g. vlan, vxlan, evpn, simple). + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Zone + + The SDN zone name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveSnapshot + New + PveSnapshot + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveSnapshot + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Name + + The snapshot name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Description + + Description for the snapshot. + + String + + String + + + None + + + IncludeVmState + + Include VM memory state in the snapshot. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Description + + Description for the snapshot. + + String + + String + + + None + + + IncludeVmState + + Include VM memory state in the snapshot. + + SwitchParameter + + SwitchParameter + + + False + + + Name + + The snapshot name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveStorage + New + PveStorage + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveStorage + + Storage + + The storage pool name. + + String + + String + + + None + + + Type + + The storage type (e.g. dir, nfs, lvm, zfspool). + + + dir + nfs + lvm + lvmthin + zfspool + zfs + cephfs + rbd + iscsi + iscsidirect + glusterfs + cifs + pbs + + String + + String + + + None + + + CephPool + + Ceph pool name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Content + + Comma-separated content types to support. + + String + + String + + + None + + + Disable + + Create the storage in disabled state. + + + SwitchParameter + + + False + + + Export + + NFS export path or CIFS share name. + + String + + String + + + None + + + MonHost + + Ceph monitor host list. + + String + + String + + + None + + + Nodes + + Limit access to these nodes (comma-separated). + + String + + String + + + None + + + Path + + Base directory path (for dir type). + + String + + String + + + None + + + Pool + + ZFS pool name. + + String + + String + + + None + + + Server + + NFS/CIFS server hostname or IP. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Shared + + Storage is shared across cluster nodes. + + + SwitchParameter + + + False + + + ThinPool + + LVM thin pool name. + + String + + String + + + None + + + VgName + + LVM volume group name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + CephPool + + Ceph pool name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Content + + Comma-separated content types to support. + + String + + String + + + None + + + Disable + + Create the storage in disabled state. + + SwitchParameter + + SwitchParameter + + + False + + + Export + + NFS export path or CIFS share name. + + String + + String + + + None + + + MonHost + + Ceph monitor host list. + + String + + String + + + None + + + Nodes + + Limit access to these nodes (comma-separated). + + String + + String + + + None + + + Path + + Base directory path (for dir type). + + String + + String + + + None + + + Pool + + ZFS pool name. + + String + + String + + + None + + + Server + + NFS/CIFS server hostname or IP. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Shared + + Storage is shared across cluster nodes. + + SwitchParameter + + SwitchParameter + + + False + + + Storage + + The storage pool name. + + String + + String + + + None + + + ThinPool + + LVM thin pool name. + + String + + String + + + None + + + Type + + The storage type (e.g. dir, nfs, lvm, zfspool). + + String + + String + + + None + + + VgName + + LVM volume group name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Storage.PveStorage + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveTemplate + New + PveTemplate + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveTemplate + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveUser + New + PveUser + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveUser + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + Comment + + Comment or notes for this user. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Email + + The user's email address. + + String + + String + + + None + + + Expire + + Account expiry as a Unix timestamp. + + Int64 + + Int64 + + + None + + + FirstName + + The user's first name. + + String + + String + + + None + + + Groups + + Comma-separated list of groups. + + String + + String + + + None + + + LastName + + The user's last name. + + String + + String + + + None + + + Password + + Password for the user. + + SecureString + + SecureString + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Comment or notes for this user. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Email + + The user's email address. + + String + + String + + + None + + + Expire + + Account expiry as a Unix timestamp. + + Int64 + + Int64 + + + None + + + FirstName + + The user's first name. + + String + + String + + + None + + + Groups + + Comma-separated list of groups. + + String + + String + + + None + + + LastName + + The user's last name. + + String + + String + + + None + + + Password + + Password for the user. + + SecureString + + SecureString + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Users.PveUser + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveVm + New + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveVm + + Node + + The PVE node name. + + String + + String + + + None + + + Bios + + BIOS type: seabios (default) or ovmf (UEFI). + + String + + String + + + None + + + Bridge + + Network bridge to attach to (e.g. vmbr0). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Cores + + Number of CPU cores per socket. + + Int32 + + Int32 + + + None + + + CpuType + + Emulated CPU type (e.g. host, x86-64-v2-AES). + + String + + String + + + None + + + DiskFormat + + Disk format (e.g. raw, qcow2). + + String + + String + + + None + + + DiskSize + + Size of the primary disk (e.g. 32G). + + String + + String + + + None + + + DiskStorage + + Storage pool for the primary disk. + + String + + String + + + None + + + Machine + + Emulated machine type (e.g. q35, i440fx). + + String + + String + + + None + + + Memory + + Memory size in MiB. + + Int32 + + Int32 + + + None + + + Name + + The display name of the VM. + + String + + String + + + None + + + Network + + Network interface model (e.g. virtio, e1000). + + String + + String + + + None + + + OsType + + Guest OS type hint (e.g. l26, win10). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Sockets + + Number of CPU sockets. + + Int32 + + Int32 + + + None + + + Start + + Start the VM after creation. + + + SwitchParameter + + + False + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Bios + + BIOS type: seabios (default) or ovmf (UEFI). + + String + + String + + + None + + + Bridge + + Network bridge to attach to (e.g. vmbr0). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Cores + + Number of CPU cores per socket. + + Int32 + + Int32 + + + None + + + CpuType + + Emulated CPU type (e.g. host, x86-64-v2-AES). + + String + + String + + + None + + + DiskFormat + + Disk format (e.g. raw, qcow2). + + String + + String + + + None + + + DiskSize + + Size of the primary disk (e.g. 32G). + + String + + String + + + None + + + DiskStorage + + Storage pool for the primary disk. + + String + + String + + + None + + + Machine + + Emulated machine type (e.g. q35, i440fx). + + String + + String + + + None + + + Memory + + Memory size in MiB. + + Int32 + + Int32 + + + None + + + Name + + The display name of the VM. + + String + + String + + + None + + + Network + + Network interface model (e.g. virtio, e1000). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + OsType + + Guest OS type hint (e.g. l26, win10). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Sockets + + Number of CPU sockets. + + Int32 + + Int32 + + + None + + + Start + + Start the VM after creation. + + SwitchParameter + + SwitchParameter + + + False + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + New-PveVmFromTemplate + New + PveVmFromTemplate + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + New-PveVmFromTemplate + + TemplateNode + + The node where the template resides. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + NewVmId + + VM ID for the new cloned VM. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Full + + Perform a full (non-linked) clone. + + + SwitchParameter + + + False + + + NewName + + Name for the new VM. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TargetNode + + Target node for the new VM. + + String + + String + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Full + + Perform a full (non-linked) clone. + + SwitchParameter + + SwitchParameter + + + False + + + NewName + + Name for the new VM. + + String + + String + + + None + + + NewVmId + + VM ID for the new cloned VM. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TargetNode + + Target node for the new VM. + + String + + String + + + None + + + TemplateNode + + The node where the template resides. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveApiToken + Remove + PveApiToken + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveApiToken + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + TokenId + + The API token identifier. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + TokenId + + The API token identifier. + + String + + String + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveContainer + Remove + PveContainer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveContainer + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Force + + Force the operation without additional checks. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Purge + + Remove all associated resources. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Force + + Force the operation without additional checks. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Purge + + Remove all associated resources. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveContainerSnapshot + Remove + PveContainerSnapshot + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveContainerSnapshot + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Name + + The snapshot name to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Name + + The snapshot name to remove. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveNetwork + Remove + PveNetwork + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveNetwork + + Node + + The PVE node name. + + String + + String + + + None + + + Iface + + The network interface name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Iface + + The network interface name. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveRole + Remove + PveRole + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveRole + + RoleId + + The role identifier. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + RoleId + + The role identifier. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveSdnSubnet + Remove + PveSdnSubnet + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveSdnSubnet + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + Subnet + + The subnet CIDR to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Subnet + + The subnet CIDR to remove. + + String + + String + + + None + + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveSdnVnet + Remove + PveSdnVnet + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveSdnVnet + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Vnet + + The SDN VNet name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveSdnZone + Remove + PveSdnZone + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveSdnZone + + Zone + + The SDN zone name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + Zone + + The SDN zone name. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveSnapshot + Remove + PveSnapshot + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveSnapshot + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Name + + The snapshot name to remove. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Name + + The snapshot name to remove. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveStorage + Remove + PveStorage + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveStorage + + Storage + + The storage pool name. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveTemplate + Remove + PveTemplate + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveTemplate + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Purge + + Remove all associated resources. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Purge + + Remove all associated resources. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveUser + Remove + PveUser + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveUser + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Remove-PveVm + Remove + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Remove-PveVm + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Force + + Force the operation without additional checks. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Purge + + Remove all associated resources. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Force + + Force the operation without additional checks. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Purge + + Remove all associated resources. + + SwitchParameter + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Reset-PveVm + Reset + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Reset-PveVm + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Resize-PveVmDisk + Resize + PveVmDisk + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Resize-PveVmDisk + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Disk + + The disk slot to resize (e.g. virtio0, scsi0). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Size + + New disk size (e.g. 50G or +10G to grow). + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Disk + + The disk slot to resize (e.g. virtio0, scsi0). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Size + + New disk size (e.g. 50G or +10G to grow). + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Restart-PveContainer + Restart + PveContainer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Restart-PveContainer + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Maximum time to wait for the task. + + Int32 + + Int32 + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Maximum time to wait for the task. + + Int32 + + Int32 + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Restart-PveVm + Restart + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Restart-PveVm + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Maximum time to wait for the task. + + Int32 + + Int32 + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Maximum time to wait for the task. + + Int32 + + Int32 + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Restore-PveContainerSnapshot + Restore + PveContainerSnapshot + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Restore-PveContainerSnapshot + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Name + + The snapshot name to roll back to. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Name + + The snapshot name to roll back to. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Restore-PveSnapshot + Restore + PveSnapshot + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Restore-PveSnapshot + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Name + + The snapshot name to roll back to. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Name + + The snapshot name to roll back to. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Resume-PveVm + Resume + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Resume-PveVm + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Send-PveIso + Send + PveIso + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Send-PveIso + + Node + + The PVE node name. + + String + + String + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Path + + Local path to the ISO file to upload. + + String + + String + + + None + + + Checksum + + Checksum value to verify the upload. + + String + + String + + + None + + + ChecksumAlgorithm + + Checksum algorithm (md5, sha1, sha256, sha512). + + + md5 + sha1 + sha256 + sha512 + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Checksum + + Checksum value to verify the upload. + + String + + String + + + None + + + ChecksumAlgorithm + + Checksum algorithm (md5, sha1, sha256, sha512). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Path + + Local path to the ISO file to upload. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Storage + + The storage pool name. + + String + + String + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Set-PveCloudInitConfig + Set + PveCloudInitConfig + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Set-PveCloudInitConfig + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + CiUser + + Cloud-init default username. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Hostname + + Cloud-init hostname override. + + String + + String + + + None + + + IpConfig0 + + IP config string (e.g. ip=192.168.1.50/24,gw=...). + + String + + String + + + None + + + Nameserver + + DNS nameserver(s) to inject. + + String + + String + + + None + + + Password + + Cloud-init default user password. + + SecureString + + SecureString + + + None + + + Searchdomain + + DNS search domain to inject. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + SshKeys + + SSH public keys to inject. + + String[] + + String[] + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + CiUser + + Cloud-init default username. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Hostname + + Cloud-init hostname override. + + String + + String + + + None + + + IpConfig0 + + IP config string (e.g. ip=192.168.1.50/24,gw=...). + + String + + String + + + None + + + Nameserver + + DNS nameserver(s) to inject. + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Password + + Cloud-init default user password. + + SecureString + + SecureString + + + None + + + Searchdomain + + DNS search domain to inject. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + SshKeys + + SSH public keys to inject. + + String[] + + String[] + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Set-PveContainerConfig + Set + PveContainerConfig + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Set-PveContainerConfig + + AdditionalConfig + + Extra config keys as a hashtable. + + Hashtable + + Hashtable + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Cores + + Number of CPU cores to allocate. + + Int32 + + Int32 + + + None + + + Delete + + Comma-separated config keys to delete. + + String + + String + + + None + + + Description + + Description or notes for the container. + + String + + String + + + None + + + Hostname + + The hostname for the container. + + String + + String + + + None + + + Memory + + Memory limit in MiB. + + Int32 + + Int32 + + + None + + + Nameserver + + DNS nameservers (space-separated). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + SearchDomain + + DNS search domain. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Swap + + Swap size in MiB. + + Int32 + + Int32 + + + None + + + Tags + + Semicolon-separated list of tags. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + AdditionalConfig + + Extra config keys as a hashtable. + + Hashtable + + Hashtable + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Cores + + Number of CPU cores to allocate. + + Int32 + + Int32 + + + None + + + Delete + + Comma-separated config keys to delete. + + String + + String + + + None + + + Description + + Description or notes for the container. + + String + + String + + + None + + + Hostname + + The hostname for the container. + + String + + String + + + None + + + Memory + + Memory limit in MiB. + + Int32 + + Int32 + + + None + + + Nameserver + + DNS nameservers (space-separated). + + String + + String + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + SearchDomain + + DNS search domain. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Swap + + Swap size in MiB. + + Int32 + + Int32 + + + None + + + Tags + + Semicolon-separated list of tags. + + String + + String + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Set-PveNetwork + Set + PveNetwork + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Set-PveNetwork + + Node + + The PVE node name. + + String + + String + + + None + + + Iface + + The network interface name. + + String + + String + + + None + + + Address + + IPv4 address for the interface. + + String + + String + + + None + + + Address6 + + IPv6 address for the interface. + + String + + String + + + None + + + Autostart + + Start interface automatically at boot. + + + SwitchParameter + + + False + + + BondSlaves + + Bond slave interfaces (space-separated names). + + String + + String + + + None + + + BridgePorts + + Bridge ports (space-separated interface names). + + String + + String + + + None + + + Comments + + Comments or notes for this interface. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Gateway + + IPv4 gateway address. + + String + + String + + + None + + + Gateway6 + + IPv6 gateway address. + + String + + String + + + None + + + Mtu + + MTU override. + + Int32 + + Int32 + + + None + + + Netmask + + IPv4 subnet mask. + + String + + String + + + None + + + Netmask6 + + IPv6 prefix length. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Address + + IPv4 address for the interface. + + String + + String + + + None + + + Address6 + + IPv6 address for the interface. + + String + + String + + + None + + + Autostart + + Start interface automatically at boot. + + SwitchParameter + + SwitchParameter + + + False + + + BondSlaves + + Bond slave interfaces (space-separated names). + + String + + String + + + None + + + BridgePorts + + Bridge ports (space-separated interface names). + + String + + String + + + None + + + Comments + + Comments or notes for this interface. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Gateway + + IPv4 gateway address. + + String + + String + + + None + + + Gateway6 + + IPv6 gateway address. + + String + + String + + + None + + + Iface + + The network interface name. + + String + + String + + + None + + + Mtu + + MTU override. + + Int32 + + Int32 + + + None + + + Netmask + + IPv4 subnet mask. + + String + + String + + + None + + + Netmask6 + + IPv6 prefix length. + + Int32 + + Int32 + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Set-PvePermission + Set + PvePermission + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Set-PvePermission + + Path + + The resource path (e.g. /, /vms/100). + + String + + String + + + None + + + UgId + + The user or group identifier. + + String + + String + + + None + + + Role + + The role to assign (e.g. Administrator). + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Delete + + Remove the ACL entry instead of adding it. + + + SwitchParameter + + + False + + + Propagate + + Propagate this ACL to child paths. + + + SwitchParameter + + + False + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + ACL entry type: user or group. + + + user + group + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Delete + + Remove the ACL entry instead of adding it. + + SwitchParameter + + SwitchParameter + + + False + + + Path + + The resource path (e.g. /, /vms/100). + + String + + String + + + None + + + Propagate + + Propagate this ACL to child paths. + + SwitchParameter + + SwitchParameter + + + False + + + Role + + The role to assign (e.g. Administrator). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Type + + ACL entry type: user or group. + + String + + String + + + None + + + UgId + + The user or group identifier. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Set-PveUser + Set + PveUser + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Set-PveUser + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + Comment + + Updated comment or notes. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Email + + Updated email address. + + String + + String + + + None + + + Enable + + Enable or disable the user account. + + Boolean + + Boolean + + + None + + + Expire + + Account expiry as a Unix timestamp. + + Int64 + + Int64 + + + None + + + FirstName + + Updated first name. + + String + + String + + + None + + + Groups + + Updated group membership (comma-separated). + + String + + String + + + None + + + LastName + + Updated last name. + + String + + String + + + None + + + Password + + New password for the user. + + SecureString + + SecureString + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Comment + + Updated comment or notes. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Email + + Updated email address. + + String + + String + + + None + + + Enable + + Enable or disable the user account. + + Boolean + + Boolean + + + None + + + Expire + + Account expiry as a Unix timestamp. + + Int64 + + Int64 + + + None + + + FirstName + + Updated first name. + + String + + String + + + None + + + Groups + + Updated group membership (comma-separated). + + String + + String + + + None + + + LastName + + Updated last name. + + String + + String + + + None + + + Password + + New password for the user. + + SecureString + + SecureString + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + UserId + + The user ID in user@realm format. + + String + + String + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Set-PveVmConfig + Set + PveVmConfig + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Set-PveVmConfig + + AdditionalConfig + + Extra config keys as a hashtable. + + Hashtable + + Hashtable + + + None + + + Bios + + BIOS type: seabios or ovmf. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Cores + + Number of CPU cores per socket. + + Int32 + + Int32 + + + None + + + CpuType + + Emulated CPU type (e.g. host, x86-64-v2-AES). + + String + + String + + + None + + + Delete + + Comma-separated config keys to delete. + + String + + String + + + None + + + Description + + Description or notes for the VM. + + String + + String + + + None + + + Machine + + Emulated machine type (e.g. q35, i440fx). + + String + + String + + + None + + + Memory + + Memory size in MiB. + + Int32 + + Int32 + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + OsType + + Guest OS type hint (e.g. l26, win10). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Sockets + + Number of CPU sockets. + + Int32 + + Int32 + + + None + + + Tags + + Semicolon-separated list of tags. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + AdditionalConfig + + Extra config keys as a hashtable. + + Hashtable + + Hashtable + + + None + + + Bios + + BIOS type: seabios or ovmf. + + String + + String + + + None + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Cores + + Number of CPU cores per socket. + + Int32 + + Int32 + + + None + + + CpuType + + Emulated CPU type (e.g. host, x86-64-v2-AES). + + String + + String + + + None + + + Delete + + Comma-separated config keys to delete. + + String + + String + + + None + + + Description + + Description or notes for the VM. + + String + + String + + + None + + + Machine + + Emulated machine type (e.g. q35, i440fx). + + String + + String + + + None + + + Memory + + Memory size in MiB. + + Int32 + + Int32 + + + None + + + Node + + The PVE node name. + + String + + String + + + None + + + OsType + + Guest OS type hint (e.g. l26, win10). + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Sockets + + Number of CPU sockets. + + Int32 + + Int32 + + + None + + + Tags + + Semicolon-separated list of tags. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + System.Object + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Start-PveContainer + Start + PveContainer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Start-PveContainer + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Start-PveVm + Start + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Start-PveVm + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Stop-PveContainer + Stop + PveContainer + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Stop-PveContainer + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The container identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Stop-PveVm + Stop + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Stop-PveVm + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Suspend-PveVm + Suspend + PveVm + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Suspend-PveVm + + Confirm + + Prompts you for confirmation before running the cmdlet. + + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Confirm + + Prompts you for confirmation before running the cmdlet. + + SwitchParameter + + SwitchParameter + + + False + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Wait + + Wait for the task to complete before returning. + + SwitchParameter + + SwitchParameter + + + False + + + WhatIf + + Shows what would happen if the cmdlet runs. The cmdlet is not run. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + System.Int32 + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Test-PveConnection + Test + PveConnection + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Test-PveConnection + + Detailed + + Return the session object instead of a boolean. + + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Detailed + + Return the session object instead of a boolean. + + SwitchParameter + + SwitchParameter + + + False + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + None + + + + + + + + + + System.Boolean + + + + + + + + PSProxmoxVE.Core.Authentication.PveSession + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Test-PveVmGuestAgent + Test + PveVmGuestAgent + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Test-PveVmGuestAgent + + Node + + The PVE node name. + + String + + String + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + VmId + + The VM identifier. + + Int32 + + Int32 + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.Int32 + + + + + + + + + + System.Boolean + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + + + Wait-PveTask + Wait + PveTask + + {{ Fill in the Synopsis }} + + + + {{ Fill in the Description }} + + + + Wait-PveTask + + Node + + The PVE node name. + + String + + String + + + None + + + Upid + + The task UPID. + + String + + String + + + None + + + PollInterval + + How often to poll task status. + + TimeSpan + + TimeSpan + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Maximum time to wait for the task. + + TimeSpan + + TimeSpan + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + Node + + The PVE node name. + + String + + String + + + None + + + PollInterval + + How often to poll task status. + + TimeSpan + + TimeSpan + + + None + + + Session + + {{ Fill Session Description }} + + PveSession + + PveSession + + + None + + + Timeout + + Maximum time to wait for the task. + + TimeSpan + + TimeSpan + + + None + + + Upid + + The task UPID. + + String + + String + + + None + + + ProgressAction + + {{ Fill ProgressAction Description }} + + ActionPreference + + ActionPreference + + + None + + + + + + System.String + + + + + + + + + + PSProxmoxVE.Core.Models.Vms.PveTask + + + + + + + + + + + + + + -------------------------- Example 1 -------------------------- + PS C:\> {{ Add example code here }} + + {{ Add example description here }} + + + + + + \ No newline at end of file