Skip to content
/ pve-powershell-module Public

A generated Powershell module to access a local proxmox pve api.

License

GPL-3.0 license
7 stars 2 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

EldoBam/pve-powershell-module

BranchesTags

Repository files navigation

ProxmoxPVE - the PowerShell module for the Proxmox PowerShell VE

Generated module to access all Proxmox VE Api Endpoints. This module has been generated from the proxmox api description v. 9.1.2

This PowerShell module is automatically generated by the Proxmox PVE Module Builder Project

  • Build package: org.openapitools.codegen.languages.PowerShellClientCodegen

Frameworks supported

  • PowerShell 6.2 or later

Beta version

This module is currently under beta release.

  • first release has been created
  • basic tests past
  • module looks stable
  • waiting for issues

Contact

Dependencies

Installation

To install from PSGallery, run the following command to install and import the PowerShell module locally:

Install-Module -Name ProxmoxPVE
Import-Module ProxmoxPVE

To install from the source, run the following command to build and install the PowerShell module locally:

Build.ps1
Import-Module -Name '.\src\ProxmoxPVE\ProxmoxPVE.psm1' -Verbose

To avoid function name collision, one can use -Prefix, e.g. Import-Module -Name '.\src\ProxmoxPVE' -Prefix prefix

To uninstall the module, simply run:

Remove-Module ProxmoxPVE

Authentication

This module supports both, the token based and ticket based authentication. PVE API Doku #Authentication The login method is neccessary initialize the module. While the token based authentication is statless does'nt really need a login on the REST Api, so the login method just calls the API to see if the credentials are valid. The ticket based authentication needs a login. The module performs a login request with your credentials and recieves a ticket and a CSRFPreventionToken needed for the subsequent calls.

Token (recommended)

For automation purposes it's recommended to use the token based authentication. Token based authentication allows a stateless access to the REST API and can be given separate permissions and expiration dates to limit the scope and duration of the access.

# choosing LoginMethod token
$LoginMethod = "token"
# insert your Proxmox TokenId <USER@REALM>!<GROUP> as Username and your Proxmox VE ApiToken as Password.
$Credentials = Get-Credential
Set-PVEConfiguration -BaseUrl "https://pve.local:8006/api2/json" `
                     -LoginMethod $LoginMethod `
                     -Credential $Credentials
# Invoke the login with silent switch. --> no interaction no output. returns $true on success
if((Invoke-PVELogin -Silent)){
    Write-Host "login successfull"
}else{
    Write-Error "login not successfull"
}

Ticket

This Authentication method allows you to connect with your proxmox user credentials. NOTE: Tickets have a limited lifetime of 2 hours. After that you have to call Invoke-PVELogin again.

# choosing LoginMethod ticket
$LoginMethod = "ticket"
# insert your Proxmox Username <USER@REALM> and Password
$Credentials = Get-Credential
Set-PVEConfiguration -BaseUrl "https://pve.local:8006/api2/json" `
                     -LoginMethod $LoginMethod `
                     -Credential $Credentials
# Invoke the login with silent switch. --> no interaction no output. returns $true on success
if((Invoke-PVELogin -Silent)){
    Write-Host "login successfull"
}else{
    Write-Error "login not successfull"
}

Basic Example to get started

Import-Module -Name '.\src\ProxmoxPVE\ProxmoxPVE.psm1' -Verbose
Initialize-PVE
$nodes = Get-PVENodes
$nodes

Using persistent configuration

This module can store the configuration in a secured file under the current users profile. The configuration is converted to json and is saved as SecureString. Therefore the Set-PVEConfiguration has a -Persistent switch, which can be used while passing the configuration initial or after performing the Invoke-PVE CMDline.

Example

Run the following code once with the user on the system, where you want to to store the configuration for. If you want to use this for your automation user, you have to open a shell in the context of this user and perform the following commands. This is very important, because the encrypted data won't work on another computer or in another user context.

Import-Module ProxmoxPVE
# You first have to set the configuration. This only has to be done once.
# option 1 - call the Initialize-PVE
Initialize-PVE
# option 2
# choosing LoginMethod --> they work both but please consider using token auth for automation purposes
$LoginMethod = "token"
# insert your Proxmox Credentials according your login method
$Credentials = Get-Credential
# Set the configuration persistent
Set-PVEConfiguration -BaseUrl "https://pve.local:8006/api2/json" `
                     -LoginMethod $LoginMethod `
                     -Credential $Credentials `
                     -Persistent

After you have stored the configuration once, you're now able to connect to the api by using following code at the beginning of your automation scripts.

Import-Module ProxmoxPVE
Initialize-PVE

done.

SkipCertificateCheck

To skip the check, you can enable the SkipCertificateCheck in the configuration, as seen in the example below:

# insert your Proxmox Credentials according your login method
$Credentials = Get-Credential
$LoginMethod = "token"
Set-PVEConfiguration -BaseUrl "https://pve.local:8006/api2/json" `
                     -LoginMethod $LoginMethod `
                     -Credential $Credentials `
                     -SkipCertificateCheck `
                     -Persistent
Initialize-PVE

Tests

Tests are currently not implemented properly. I'm sad to tell, that they're currently useless. To install and run Pester, please execute the following commands in the terminal:

Install-module -name Pester -force

Invoke-Pester

For troubleshooting, please run $DebugPreference = 'Continue' to turn on debugging and disable it with $DebugPreference = 'SilentlyContinue' when done with the troubleshooting.

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
PVEAccessApi Get-PVEAccess GET /access Directory index.
PVEAccessApi Get-PVEAccessAcl GET /access/acl Get Access Control List (ACLs).
PVEAccessApi Get-PVEAccessDomains GET /access/domains Authentication domain index.
PVEAccessApi Get-PVEAccessDomainsByRealm GET /access/domains/{realm} Get auth server configuration.
PVEAccessApi Get-PVEAccessGroups GET /access/groups Group index.
PVEAccessApi Get-PVEAccessGroupsByGroupid GET /access/groups/{groupid} Get group configuration.
PVEAccessApi Get-PVEAccessOpenid GET /access/openid Directory index.
PVEAccessApi Get-PVEAccessPermissions GET /access/permissions Retrieve effective permissions of given user/token.
PVEAccessApi Get-PVEAccessRoles GET /access/roles Role index.
PVEAccessApi Get-PVEAccessRolesByRoleid GET /access/roles/{roleid} Get role configuration.
PVEAccessApi Get-PVEAccessTfa GET /access/tfa List TFA configurations of users.
PVEAccessApi Get-PVEAccessTfaByUserid GET /access/tfa/{userid} List TFA configurations of users.
PVEAccessApi Get-PVEAccessTfaByUseridAndId GET /access/tfa/{userid}/{id} Fetch a requested TFA entry if present.
PVEAccessApi Get-PVEAccessTicket GET /access/ticket Dummy. Useful for formatters which want to provide a login page.
PVEAccessApi Get-PVEAccessUsers GET /access/users User index.
PVEAccessApi Get-PVEAccessUsersByUserid GET /access/users/{userid} Get user configuration.
PVEAccessApi Get-PVEAccessUsersTfaByUserid GET /access/users/{userid}/tfa Get user TFA types (Personal and Realm).
PVEAccessApi Get-PVEAccessUsersTokenByUserid GET /access/users/{userid}/token Get user API tokens.
PVEAccessApi Get-PVEAccessUsersTokenByUseridAndTokenid GET /access/users/{userid}/token/{tokenid} Get specific API token information.
PVEAccessApi New-PVEAccessDomains POST /access/domains Add an authentication server.
PVEAccessApi New-PVEAccessDomainsSyncByRealm POST /access/domains/{realm}/sync Syncs users and/or groups from the configured LDAP to user.cfg. NOTE: Synced groups will have the name 'name-$realm', so make sure those groups do not exist to prevent overwriting.
PVEAccessApi New-PVEAccessGroups POST /access/groups Create new group.
PVEAccessApi New-PVEAccessOpenidAuthurl POST /access/openid/auth-url Get the OpenId Authorization Url for the specified realm.
PVEAccessApi New-PVEAccessOpenidLogin POST /access/openid/login Verify OpenID authorization code and create a ticket.
PVEAccessApi New-PVEAccessRoles POST /access/roles Create new role.
PVEAccessApi New-PVEAccessTfaByUserid POST /access/tfa/{userid} Add a TFA entry for a user.
PVEAccessApi New-PVEAccessTicket POST /access/ticket Create or verify authentication ticket.
PVEAccessApi New-PVEAccessUsers POST /access/users Create new user.
PVEAccessApi New-PVEAccessUsersTokenByUseridAndTokenid POST /access/users/{userid}/token/{tokenid} Generate a new API token for a specific user. NOTE: returns API token value, which needs to be stored as it cannot be retrieved afterwards!
PVEAccessApi New-PVEAccessVncticket POST /access/vncticket verify VNC authentication ticket.
PVEAccessApi Remove-PVEAccessDomainsByRealm DELETE /access/domains/{realm} Delete an authentication server.
PVEAccessApi Remove-PVEAccessGroupsByGroupid DELETE /access/groups/{groupid} Delete group.
PVEAccessApi Remove-PVEAccessRolesByRoleid DELETE /access/roles/{roleid} Delete role.
PVEAccessApi Remove-PVEAccessTfaByUseridAndId DELETE /access/tfa/{userid}/{id} Delete a TFA entry by ID.
PVEAccessApi Remove-PVEAccessUsersByUserid DELETE /access/users/{userid} Delete user.
PVEAccessApi Remove-PVEAccessUsersTokenByUseridAndTokenid DELETE /access/users/{userid}/token/{tokenid} Remove API token for a specific user.
PVEAccessApi Set-PVEAccessAcl PUT /access/acl Update Access Control List (add or remove permissions).
PVEAccessApi Set-PVEAccessDomainsByRealm PUT /access/domains/{realm} Update authentication server settings.
PVEAccessApi Set-PVEAccessGroupsByGroupid PUT /access/groups/{groupid} Update group data.
PVEAccessApi Set-PVEAccessPassword PUT /access/password Change user password.
PVEAccessApi Set-PVEAccessRolesByRoleid PUT /access/roles/{roleid} Update an existing role.
PVEAccessApi Set-PVEAccessTfaByUseridAndId PUT /access/tfa/{userid}/{id} Add a TFA entry for a user.
PVEAccessApi Set-PVEAccessUsersByUserid PUT /access/users/{userid} Update user configuration.
PVEAccessApi Set-PVEAccessUsersTokenByUseridAndTokenid PUT /access/users/{userid}/token/{tokenid} Update API token for a specific user.
PVEAccessApi Set-PVEAccessUsersUnlocktfaByUserid PUT /access/users/{userid}/unlock-tfa Unlock a user's TFA authentication.
PVEClusterApi Get-PVECluster GET /cluster Cluster index.
PVEClusterApi Get-PVEClusterAcme GET /cluster/acme ACMEAccount index.
PVEClusterApi Get-PVEClusterAcmeAccount GET /cluster/acme/account ACMEAccount index.
PVEClusterApi Get-PVEClusterAcmeAccountByName GET /cluster/acme/account/{name} Return existing ACME account information.
PVEClusterApi Get-PVEClusterAcmeChallengeschema GET /cluster/acme/challenge-schema Get schema of ACME challenge types.
PVEClusterApi Get-PVEClusterAcmeDirectories GET /cluster/acme/directories Get named known ACME directory endpoints.
PVEClusterApi Get-PVEClusterAcmeMeta GET /cluster/acme/meta Retrieve ACME Directory Meta Information
PVEClusterApi Get-PVEClusterAcmePlugins GET /cluster/acme/plugins ACME plugin index.
PVEClusterApi Get-PVEClusterAcmePluginsById GET /cluster/acme/plugins/{id} Get ACME plugin configuration.
PVEClusterApi Get-PVEClusterAcmeTos GET /cluster/acme/tos Retrieve ACME TermsOfService URL from CA. Deprecated, please use /cluster/acme/meta.
PVEClusterApi Get-PVEClusterBackup GET /cluster/backup List vzdump backup schedule.
PVEClusterApi Get-PVEClusterBackupById GET /cluster/backup/{id} Read vzdump backup job definition.
PVEClusterApi Get-PVEClusterBackupIncludedvolumesById GET /cluster/backup/{id}/included_volumes Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views.
PVEClusterApi Get-PVEClusterBackupinfo GET /cluster/backup-info Index for backup info related endpoints
PVEClusterApi Get-PVEClusterBackupinfoNotbackedup GET /cluster/backup-info/not-backed-up Shows all guests which are not covered by any backup job.
PVEClusterApi Get-PVEClusterBulkaction GET /cluster/bulk-action List resource types.
PVEClusterApi Get-PVEClusterBulkactionGuest GET /cluster/bulk-action/guest Bulk action index.
PVEClusterApi Get-PVEClusterCeph GET /cluster/ceph Cluster ceph index.
PVEClusterApi Get-PVEClusterCephFlags GET /cluster/ceph/flags get the status of all ceph flags
PVEClusterApi Get-PVEClusterCephFlagsByFlag GET /cluster/ceph/flags/{flag} Get the status of a specific ceph flag.
PVEClusterApi Get-PVEClusterCephMetadata GET /cluster/ceph/metadata Get ceph metadata.
PVEClusterApi Get-PVEClusterCephStatus GET /cluster/ceph/status Get ceph status.
PVEClusterApi Get-PVEClusterConfig GET /cluster/config Directory index.
PVEClusterApi Get-PVEClusterConfigApiversion GET /cluster/config/apiversion Return the version of the cluster join API available on this node.
PVEClusterApi Get-PVEClusterConfigJoin GET /cluster/config/join Get information needed to join this cluster over the connected node.
PVEClusterApi Get-PVEClusterConfigNodes GET /cluster/config/nodes Corosync node list.
PVEClusterApi Get-PVEClusterConfigQdevice GET /cluster/config/qdevice Get QDevice status
PVEClusterApi Get-PVEClusterConfigTotem GET /cluster/config/totem Get corosync totem protocol settings.
PVEClusterApi Get-PVEClusterFirewall GET /cluster/firewall Directory index.
PVEClusterApi Get-PVEClusterFirewallAliases GET /cluster/firewall/aliases List aliases
PVEClusterApi Get-PVEClusterFirewallAliasesByName GET /cluster/firewall/aliases/{name} Read alias.
PVEClusterApi Get-PVEClusterFirewallGroups GET /cluster/firewall/groups List security groups.
PVEClusterApi Get-PVEClusterFirewallGroupsByGroup GET /cluster/firewall/groups/{group} List rules.
PVEClusterApi Get-PVEClusterFirewallGroupsByGroupAndPos GET /cluster/firewall/groups/{group}/{pos} Get single rule data.
PVEClusterApi Get-PVEClusterFirewallIpset GET /cluster/firewall/ipset List IPSets
PVEClusterApi Get-PVEClusterFirewallIpsetByName GET /cluster/firewall/ipset/{name} List IPSet content
PVEClusterApi Get-PVEClusterFirewallIpsetByNameAndCidr GET /cluster/firewall/ipset/{name}/{cidr} Read IP or Network settings from IPSet.
PVEClusterApi Get-PVEClusterFirewallMacros GET /cluster/firewall/macros List available macros
PVEClusterApi Get-PVEClusterFirewallOptions GET /cluster/firewall/options Get Firewall options.
PVEClusterApi Get-PVEClusterFirewallRefs GET /cluster/firewall/refs Lists possible IPSet/Alias reference which are allowed in source/dest properties.
PVEClusterApi Get-PVEClusterFirewallRules GET /cluster/firewall/rules List rules.
PVEClusterApi Get-PVEClusterFirewallRulesByPos GET /cluster/firewall/rules/{pos} Get single rule data.
PVEClusterApi Get-PVEClusterHa GET /cluster/ha Directory index.
PVEClusterApi Get-PVEClusterHaGroups GET /cluster/ha/groups Get HA groups. (deprecated in favor of HA rules)
PVEClusterApi Get-PVEClusterHaGroupsByGroup GET /cluster/ha/groups/{group} Read ha group configuration. (deprecated in favor of HA rules)
PVEClusterApi Get-PVEClusterHaResources GET /cluster/ha/resources List HA resources.
PVEClusterApi Get-PVEClusterHaResourcesBySid GET /cluster/ha/resources/{sid} Read resource configuration.
PVEClusterApi Get-PVEClusterHaRules GET /cluster/ha/rules Get HA rules.
PVEClusterApi Get-PVEClusterHaRulesByRule GET /cluster/ha/rules/{rule} Read HA rule.
PVEClusterApi Get-PVEClusterHaStatus GET /cluster/ha/status Directory index.
PVEClusterApi Get-PVEClusterHaStatusCurrent GET /cluster/ha/status/current Get HA manger status.
PVEClusterApi Get-PVEClusterHaStatusManagerstatus GET /cluster/ha/status/manager_status Get full HA manger status, including LRM status.
PVEClusterApi Get-PVEClusterJobs GET /cluster/jobs Index for jobs related endpoints.
PVEClusterApi Get-PVEClusterJobsRealmsync GET /cluster/jobs/realm-sync List configured realm-sync-jobs.
PVEClusterApi Get-PVEClusterJobsRealmsyncById GET /cluster/jobs/realm-sync/{id} Read realm-sync job definition.
PVEClusterApi Get-PVEClusterJobsScheduleanalyze GET /cluster/jobs/schedule-analyze Returns a list of future schedule runtimes.
PVEClusterApi Get-PVEClusterLog GET /cluster/log Read cluster log
PVEClusterApi Get-PVEClusterMapping GET /cluster/mapping List resource types.
PVEClusterApi Get-PVEClusterMappingDir GET /cluster/mapping/dir List directory mapping
PVEClusterApi Get-PVEClusterMappingDirById GET /cluster/mapping/dir/{id} Get directory mapping.
PVEClusterApi Get-PVEClusterMappingPci GET /cluster/mapping/pci List PCI Hardware Mapping
PVEClusterApi Get-PVEClusterMappingPciById GET /cluster/mapping/pci/{id} Get PCI Mapping.
PVEClusterApi Get-PVEClusterMappingUsb GET /cluster/mapping/usb List USB Hardware Mappings
PVEClusterApi Get-PVEClusterMappingUsbById GET /cluster/mapping/usb/{id} Get USB Mapping.
PVEClusterApi Get-PVEClusterMetrics GET /cluster/metrics Metrics index.
PVEClusterApi Get-PVEClusterMetricsExport GET /cluster/metrics/export Retrieve metrics of the cluster.
PVEClusterApi Get-PVEClusterMetricsServer GET /cluster/metrics/server List configured metric servers.
PVEClusterApi Get-PVEClusterMetricsServerById GET /cluster/metrics/server/{id} Read metric server configuration.
PVEClusterApi Get-PVEClusterNextid GET /cluster/nextid Get next free VMID. Pass a VMID to assert that its free (at time of check).
PVEClusterApi Get-PVEClusterNotifications GET /cluster/notifications Index for notification-related API endpoints.
PVEClusterApi Get-PVEClusterNotificationsEndpoints GET /cluster/notifications/endpoints Index for all available endpoint types.
PVEClusterApi Get-PVEClusterNotificationsEndpointsGotify GET /cluster/notifications/endpoints/gotify Returns a list of all gotify endpoints
PVEClusterApi Get-PVEClusterNotificationsEndpointsGotifyByName GET /cluster/notifications/endpoints/gotify/{name} Return a specific gotify endpoint
PVEClusterApi Get-PVEClusterNotificationsEndpointsSendmail GET /cluster/notifications/endpoints/sendmail Returns a list of all sendmail endpoints
PVEClusterApi Get-PVEClusterNotificationsEndpointsSendmailByName GET /cluster/notifications/endpoints/sendmail/{name} Return a specific sendmail endpoint
PVEClusterApi Get-PVEClusterNotificationsEndpointsSmtp GET /cluster/notifications/endpoints/smtp Returns a list of all smtp endpoints
PVEClusterApi Get-PVEClusterNotificationsEndpointsSmtpByName GET /cluster/notifications/endpoints/smtp/{name} Return a specific smtp endpoint
PVEClusterApi Get-PVEClusterNotificationsEndpointsWebhook GET /cluster/notifications/endpoints/webhook Returns a list of all webhook endpoints
PVEClusterApi Get-PVEClusterNotificationsEndpointsWebhookByName GET /cluster/notifications/endpoints/webhook/{name} Return a specific webhook endpoint
PVEClusterApi Get-PVEClusterNotificationsMatcherfields GET /cluster/notifications/matcher-fields Returns known notification metadata fields
PVEClusterApi Get-PVEClusterNotificationsMatcherfieldvalues GET /cluster/notifications/matcher-field-values Returns known notification metadata fields and their known values
PVEClusterApi Get-PVEClusterNotificationsMatchers GET /cluster/notifications/matchers Returns a list of all matchers
PVEClusterApi Get-PVEClusterNotificationsMatchersByName GET /cluster/notifications/matchers/{name} Return a specific matcher
PVEClusterApi Get-PVEClusterNotificationsTargets GET /cluster/notifications/targets Returns a list of all entities that can be used as notification targets.
PVEClusterApi Get-PVEClusterOptions GET /cluster/options Get datacenter options. Without 'Sys.Audit' on '/' not all options are returned.
PVEClusterApi Get-PVEClusterReplication GET /cluster/replication List replication jobs.
PVEClusterApi Get-PVEClusterReplicationById GET /cluster/replication/{id} Read replication job configuration.
PVEClusterApi Get-PVEClusterResources GET /cluster/resources Resources index (cluster wide).
PVEClusterApi Get-PVEClusterSdn GET /cluster/sdn Directory index.
PVEClusterApi Get-PVEClusterSdnControllers GET /cluster/sdn/controllers SDN controllers index.
PVEClusterApi Get-PVEClusterSdnControllersByController GET /cluster/sdn/controllers/{controller} Read sdn controller configuration.
PVEClusterApi Get-PVEClusterSdnDns GET /cluster/sdn/dns SDN dns index.
PVEClusterApi Get-PVEClusterSdnDnsByDns GET /cluster/sdn/dns/{dns} Read sdn dns configuration.
PVEClusterApi Get-PVEClusterSdnFabrics GET /cluster/sdn/fabrics SDN Fabrics Index
PVEClusterApi Get-PVEClusterSdnFabricsAll GET /cluster/sdn/fabrics/all SDN Fabrics Index
PVEClusterApi Get-PVEClusterSdnFabricsFabric GET /cluster/sdn/fabrics/fabric SDN Fabrics Index
PVEClusterApi Get-PVEClusterSdnFabricsFabricById GET /cluster/sdn/fabrics/fabric/{id} Update a fabric
PVEClusterApi Get-PVEClusterSdnFabricsNode GET /cluster/sdn/fabrics/node SDN Fabrics Index
PVEClusterApi Get-PVEClusterSdnFabricsNodeByFabricid GET /cluster/sdn/fabrics/node/{fabric_id} SDN Fabrics Index
PVEClusterApi Get-PVEClusterSdnFabricsNodeByFabricidAndNodeid GET /cluster/sdn/fabrics/node/{fabric_id}/{node_id} Get a node
PVEClusterApi Get-PVEClusterSdnIpams GET /cluster/sdn/ipams SDN ipams index.
PVEClusterApi Get-PVEClusterSdnIpamsByIpam GET /cluster/sdn/ipams/{ipam} Read sdn ipam configuration.
PVEClusterApi Get-PVEClusterSdnIpamsStatusByIpam GET /cluster/sdn/ipams/{ipam}/status List PVE IPAM Entries
PVEClusterApi Get-PVEClusterSdnVnets GET /cluster/sdn/vnets SDN vnets index.
PVEClusterApi Get-PVEClusterSdnVnetsByVnet GET /cluster/sdn/vnets/{vnet} Read sdn vnet configuration.
PVEClusterApi Get-PVEClusterSdnVnetsFirewallByVnet GET /cluster/sdn/vnets/{vnet}/firewall Directory index.
PVEClusterApi Get-PVEClusterSdnVnetsFirewallOptionsByVnet GET /cluster/sdn/vnets/{vnet}/firewall/options Get vnet firewall options.
PVEClusterApi Get-PVEClusterSdnVnetsFirewallRulesByVnet GET /cluster/sdn/vnets/{vnet}/firewall/rules List rules.
PVEClusterApi Get-PVEClusterSdnVnetsFirewallRulesByVnetAndPos GET /cluster/sdn/vnets/{vnet}/firewall/rules/{pos} Get single rule data.
PVEClusterApi Get-PVEClusterSdnVnetsSubnetsByVnet GET /cluster/sdn/vnets/{vnet}/subnets SDN subnets index.
PVEClusterApi Get-PVEClusterSdnVnetsSubnetsByVnetAndSubnet GET /cluster/sdn/vnets/{vnet}/subnets/{subnet} Read sdn subnet configuration.
PVEClusterApi Get-PVEClusterSdnZones GET /cluster/sdn/zones SDN zones index.
PVEClusterApi Get-PVEClusterSdnZonesByZone GET /cluster/sdn/zones/{zone} Read sdn zone configuration.
PVEClusterApi Get-PVEClusterStatus GET /cluster/status Get cluster status information.
PVEClusterApi Get-PVEClusterTasks GET /cluster/tasks List recent tasks (cluster wide).
PVEClusterApi New-PVEClusterAcmeAccount POST /cluster/acme/account Register a new ACME account with CA.
PVEClusterApi New-PVEClusterAcmePlugins POST /cluster/acme/plugins Add ACME plugin configuration.
PVEClusterApi New-PVEClusterBackup POST /cluster/backup Create new vzdump backup job.
PVEClusterApi New-PVEClusterBulkactionGuestMigrate POST /cluster/bulk-action/guest/migrate Bulk migrate all guests on the cluster.
PVEClusterApi New-PVEClusterBulkactionGuestShutdown POST /cluster/bulk-action/guest/shutdown Bulk shutdown all guests on the cluster.
PVEClusterApi New-PVEClusterBulkactionGuestStart POST /cluster/bulk-action/guest/start Bulk start or resume all guests on the cluster.
PVEClusterApi New-PVEClusterBulkactionGuestSuspend POST /cluster/bulk-action/guest/suspend Bulk suspend all guests on the cluster.
PVEClusterApi New-PVEClusterConfig POST /cluster/config Generate new cluster configuration. If no links given, default to local IP address as link0.
PVEClusterApi New-PVEClusterConfigJoin POST /cluster/config/join Joins this node into an existing cluster. If no links are given, default to IP resolved by node's hostname on single link (fallback fails for clusters with multiple links).
PVEClusterApi New-PVEClusterConfigNodesByNode POST /cluster/config/nodes/{node} Adds a node to the cluster configuration. This call is for internal use.
PVEClusterApi New-PVEClusterFirewallAliases POST /cluster/firewall/aliases Create IP or Network Alias.
PVEClusterApi New-PVEClusterFirewallGroups POST /cluster/firewall/groups Create new security group.
PVEClusterApi New-PVEClusterFirewallGroupsByGroup POST /cluster/firewall/groups/{group} Create new rule.
PVEClusterApi New-PVEClusterFirewallIpset POST /cluster/firewall/ipset Create new IPSet
PVEClusterApi New-PVEClusterFirewallIpsetByName POST /cluster/firewall/ipset/{name} Add IP or Network to IPSet.
PVEClusterApi New-PVEClusterFirewallRules POST /cluster/firewall/rules Create new rule.
PVEClusterApi New-PVEClusterHaGroups POST /cluster/ha/groups Create a new HA group. (deprecated in favor of HA rules)
PVEClusterApi New-PVEClusterHaResources POST /cluster/ha/resources Create a new HA resource.
PVEClusterApi New-PVEClusterHaResourcesMigrateBySid POST /cluster/ha/resources/{sid}/migrate Request resource migration (online) to another node.
PVEClusterApi New-PVEClusterHaResourcesRelocateBySid POST /cluster/ha/resources/{sid}/relocate Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node.
PVEClusterApi New-PVEClusterHaRules POST /cluster/ha/rules Create HA rule.
PVEClusterApi New-PVEClusterJobsRealmsyncById POST /cluster/jobs/realm-sync/{id} Create new realm-sync job.
PVEClusterApi New-PVEClusterMappingDir POST /cluster/mapping/dir Create a new directory mapping.
PVEClusterApi New-PVEClusterMappingPci POST /cluster/mapping/pci Create a new hardware mapping.
PVEClusterApi New-PVEClusterMappingUsb POST /cluster/mapping/usb Create a new hardware mapping.
PVEClusterApi New-PVEClusterMetricsServerById POST /cluster/metrics/server/{id} Create a new external metric server config
PVEClusterApi New-PVEClusterNotificationsEndpointsGotify POST /cluster/notifications/endpoints/gotify Create a new gotify endpoint
PVEClusterApi New-PVEClusterNotificationsEndpointsSendmail POST /cluster/notifications/endpoints/sendmail Create a new sendmail endpoint
PVEClusterApi New-PVEClusterNotificationsEndpointsSmtp POST /cluster/notifications/endpoints/smtp Create a new smtp endpoint
PVEClusterApi New-PVEClusterNotificationsEndpointsWebhook POST /cluster/notifications/endpoints/webhook Create a new webhook endpoint
PVEClusterApi New-PVEClusterNotificationsMatchers POST /cluster/notifications/matchers Create a new matcher
PVEClusterApi New-PVEClusterNotificationsTargetsTestByName POST /cluster/notifications/targets/{name}/test Send a test notification to a provided target.
PVEClusterApi New-PVEClusterReplication POST /cluster/replication Create a new replication job
PVEClusterApi New-PVEClusterSdnControllers POST /cluster/sdn/controllers Create a new sdn controller object.
PVEClusterApi New-PVEClusterSdnDns POST /cluster/sdn/dns Create a new sdn dns object.
PVEClusterApi New-PVEClusterSdnFabricsFabric POST /cluster/sdn/fabrics/fabric Add a fabric
PVEClusterApi New-PVEClusterSdnFabricsNodeByFabricid POST /cluster/sdn/fabrics/node/{fabric_id} Add a node
PVEClusterApi New-PVEClusterSdnIpams POST /cluster/sdn/ipams Create a new sdn ipam object.
PVEClusterApi New-PVEClusterSdnLock POST /cluster/sdn/lock Acquire global lock for SDN configuration
PVEClusterApi New-PVEClusterSdnRollback POST /cluster/sdn/rollback Rollback pending changes to SDN configuration
PVEClusterApi New-PVEClusterSdnVnets POST /cluster/sdn/vnets Create a new sdn vnet object.
PVEClusterApi New-PVEClusterSdnVnetsFirewallRulesByVnet POST /cluster/sdn/vnets/{vnet}/firewall/rules Create new rule.
PVEClusterApi New-PVEClusterSdnVnetsIpsByVnet POST /cluster/sdn/vnets/{vnet}/ips Create IP Mapping in a VNet
PVEClusterApi New-PVEClusterSdnVnetsSubnetsByVnet POST /cluster/sdn/vnets/{vnet}/subnets Create a new sdn subnet object.
PVEClusterApi New-PVEClusterSdnZones POST /cluster/sdn/zones Create a new sdn zone object.
PVEClusterApi Remove-PVEClusterAcmeAccountByName DELETE /cluster/acme/account/{name} Deactivate existing ACME account at CA.
PVEClusterApi Remove-PVEClusterAcmePluginsById DELETE /cluster/acme/plugins/{id} Delete ACME plugin configuration.
PVEClusterApi Remove-PVEClusterBackupById DELETE /cluster/backup/{id} Delete vzdump backup job definition.
PVEClusterApi Remove-PVEClusterConfigNodesByNode DELETE /cluster/config/nodes/{node} Removes a node from the cluster configuration.
PVEClusterApi Remove-PVEClusterFirewallAliasesByName DELETE /cluster/firewall/aliases/{name} Remove IP or Network alias.
PVEClusterApi Remove-PVEClusterFirewallGroupsByGroup DELETE /cluster/firewall/groups/{group} Delete security group.
PVEClusterApi Remove-PVEClusterFirewallGroupsByGroupAndPos DELETE /cluster/firewall/groups/{group}/{pos} Delete rule.
PVEClusterApi Remove-PVEClusterFirewallIpsetByName DELETE /cluster/firewall/ipset/{name} Delete IPSet
PVEClusterApi Remove-PVEClusterFirewallIpsetByNameAndCidr DELETE /cluster/firewall/ipset/{name}/{cidr} Remove IP or Network from IPSet.
PVEClusterApi Remove-PVEClusterFirewallRulesByPos DELETE /cluster/firewall/rules/{pos} Delete rule.
PVEClusterApi Remove-PVEClusterHaGroupsByGroup DELETE /cluster/ha/groups/{group} Delete ha group configuration. (deprecated in favor of HA rules)
PVEClusterApi Remove-PVEClusterHaResourcesBySid DELETE /cluster/ha/resources/{sid} Delete resource configuration.
PVEClusterApi Remove-PVEClusterHaRulesByRule DELETE /cluster/ha/rules/{rule} Delete HA rule.
PVEClusterApi Remove-PVEClusterJobsRealmsyncById DELETE /cluster/jobs/realm-sync/{id} Delete realm-sync job definition.
PVEClusterApi Remove-PVEClusterMappingDirById DELETE /cluster/mapping/dir/{id} Remove directory mapping.
PVEClusterApi Remove-PVEClusterMappingPciById DELETE /cluster/mapping/pci/{id} Remove Hardware Mapping.
PVEClusterApi Remove-PVEClusterMappingUsbById DELETE /cluster/mapping/usb/{id} Remove Hardware Mapping.
PVEClusterApi Remove-PVEClusterMetricsServerById DELETE /cluster/metrics/server/{id} Remove Metric server.
PVEClusterApi Remove-PVEClusterNotificationsEndpointsGotifyByName DELETE /cluster/notifications/endpoints/gotify/{name} Remove gotify endpoint
PVEClusterApi Remove-PVEClusterNotificationsEndpointsSendmailByName DELETE /cluster/notifications/endpoints/sendmail/{name} Remove sendmail endpoint
PVEClusterApi Remove-PVEClusterNotificationsEndpointsSmtpByName DELETE /cluster/notifications/endpoints/smtp/{name} Remove smtp endpoint
PVEClusterApi Remove-PVEClusterNotificationsEndpointsWebhookByName DELETE /cluster/notifications/endpoints/webhook/{name} Remove webhook endpoint
PVEClusterApi Remove-PVEClusterNotificationsMatchersByName DELETE /cluster/notifications/matchers/{name} Remove matcher
PVEClusterApi Remove-PVEClusterReplicationById DELETE /cluster/replication/{id} Mark replication job for removal.
PVEClusterApi Remove-PVEClusterSdnControllersByController DELETE /cluster/sdn/controllers/{controller} Delete sdn controller object configuration.
PVEClusterApi Remove-PVEClusterSdnDnsByDns DELETE /cluster/sdn/dns/{dns} Delete sdn dns object configuration.
PVEClusterApi Remove-PVEClusterSdnFabricsFabricById DELETE /cluster/sdn/fabrics/fabric/{id} Add a fabric
PVEClusterApi Remove-PVEClusterSdnFabricsNodeByFabricidAndNodeid DELETE /cluster/sdn/fabrics/node/{fabric_id}/{node_id} Add a node
PVEClusterApi Remove-PVEClusterSdnIpamsByIpam DELETE /cluster/sdn/ipams/{ipam} Delete sdn ipam object configuration.
PVEClusterApi Remove-PVEClusterSdnLock DELETE /cluster/sdn/lock Release global lock for SDN configuration
PVEClusterApi Remove-PVEClusterSdnVnetsByVnet DELETE /cluster/sdn/vnets/{vnet} Delete sdn vnet object configuration.
PVEClusterApi Remove-PVEClusterSdnVnetsFirewallRulesByVnetAndPos DELETE /cluster/sdn/vnets/{vnet}/firewall/rules/{pos} Delete rule.
PVEClusterApi Remove-PVEClusterSdnVnetsIpsByVnet DELETE /cluster/sdn/vnets/{vnet}/ips Delete IP Mappings in a VNet
PVEClusterApi Remove-PVEClusterSdnVnetsSubnetsByVnetAndSubnet DELETE /cluster/sdn/vnets/{vnet}/subnets/{subnet} Delete sdn subnet object configuration.
PVEClusterApi Remove-PVEClusterSdnZonesByZone DELETE /cluster/sdn/zones/{zone} Delete sdn zone object configuration.
PVEClusterApi Set-PVEClusterAcmeAccountByName PUT /cluster/acme/account/{name} Update existing ACME account information with CA. Note: not specifying any new account information triggers a refresh.
PVEClusterApi Set-PVEClusterAcmePluginsById PUT /cluster/acme/plugins/{id} Update ACME plugin configuration.
PVEClusterApi Set-PVEClusterBackupById PUT /cluster/backup/{id} Update vzdump backup job definition.
PVEClusterApi Set-PVEClusterCephFlags PUT /cluster/ceph/flags Set/Unset multiple ceph flags at once.
PVEClusterApi Set-PVEClusterCephFlagsByFlag PUT /cluster/ceph/flags/{flag} Set or clear (unset) a specific ceph flag
PVEClusterApi Set-PVEClusterFirewallAliasesByName PUT /cluster/firewall/aliases/{name} Update IP or Network alias.
PVEClusterApi Set-PVEClusterFirewallGroupsByGroupAndPos PUT /cluster/firewall/groups/{group}/{pos} Modify rule data.
PVEClusterApi Set-PVEClusterFirewallIpsetByNameAndCidr PUT /cluster/firewall/ipset/{name}/{cidr} Update IP or Network settings
PVEClusterApi Set-PVEClusterFirewallOptions PUT /cluster/firewall/options Set Firewall options.
PVEClusterApi Set-PVEClusterFirewallRulesByPos PUT /cluster/firewall/rules/{pos} Modify rule data.
PVEClusterApi Set-PVEClusterHaGroupsByGroup PUT /cluster/ha/groups/{group} Update ha group configuration. (deprecated in favor of HA rules)
PVEClusterApi Set-PVEClusterHaResourcesBySid PUT /cluster/ha/resources/{sid} Update resource configuration.
PVEClusterApi Set-PVEClusterHaRulesByRule PUT /cluster/ha/rules/{rule} Update HA rule.
PVEClusterApi Set-PVEClusterJobsRealmsyncById PUT /cluster/jobs/realm-sync/{id} Update realm-sync job definition.
PVEClusterApi Set-PVEClusterMappingDirById PUT /cluster/mapping/dir/{id} Update a directory mapping.
PVEClusterApi Set-PVEClusterMappingPciById PUT /cluster/mapping/pci/{id} Update a hardware mapping.
PVEClusterApi Set-PVEClusterMappingUsbById PUT /cluster/mapping/usb/{id} Update a hardware mapping.
PVEClusterApi Set-PVEClusterMetricsServerById PUT /cluster/metrics/server/{id} Update metric server configuration.
PVEClusterApi Set-PVEClusterNotificationsEndpointsGotifyByName PUT /cluster/notifications/endpoints/gotify/{name} Update existing gotify endpoint
PVEClusterApi Set-PVEClusterNotificationsEndpointsSendmailByName PUT /cluster/notifications/endpoints/sendmail/{name} Update existing sendmail endpoint
PVEClusterApi Set-PVEClusterNotificationsEndpointsSmtpByName PUT /cluster/notifications/endpoints/smtp/{name} Update existing smtp endpoint
PVEClusterApi Set-PVEClusterNotificationsEndpointsWebhookByName PUT /cluster/notifications/endpoints/webhook/{name} Update existing webhook endpoint
PVEClusterApi Set-PVEClusterNotificationsMatchersByName PUT /cluster/notifications/matchers/{name} Update existing matcher
PVEClusterApi Set-PVEClusterOptions PUT /cluster/options Set datacenter options.
PVEClusterApi Set-PVEClusterReplicationById PUT /cluster/replication/{id} Update replication job configuration.
PVEClusterApi Set-PVEClusterSdn PUT /cluster/sdn Apply sdn controller changes && reload.
PVEClusterApi Set-PVEClusterSdnControllersByController PUT /cluster/sdn/controllers/{controller} Update sdn controller object configuration.
PVEClusterApi Set-PVEClusterSdnDnsByDns PUT /cluster/sdn/dns/{dns} Update sdn dns object configuration.
PVEClusterApi Set-PVEClusterSdnFabricsFabricById PUT /cluster/sdn/fabrics/fabric/{id} Update a fabric
PVEClusterApi Set-PVEClusterSdnFabricsNodeByFabricidAndNodeid PUT /cluster/sdn/fabrics/node/{fabric_id}/{node_id} Update a node
PVEClusterApi Set-PVEClusterSdnIpamsByIpam PUT /cluster/sdn/ipams/{ipam} Update sdn ipam object configuration.
PVEClusterApi Set-PVEClusterSdnVnetsByVnet PUT /cluster/sdn/vnets/{vnet} Update sdn vnet object configuration.
PVEClusterApi Set-PVEClusterSdnVnetsFirewallOptionsByVnet PUT /cluster/sdn/vnets/{vnet}/firewall/options Set Firewall options.
PVEClusterApi Set-PVEClusterSdnVnetsFirewallRulesByVnetAndPos PUT /cluster/sdn/vnets/{vnet}/firewall/rules/{pos} Modify rule data.
PVEClusterApi Set-PVEClusterSdnVnetsIpsByVnet PUT /cluster/sdn/vnets/{vnet}/ips Update IP Mapping in a VNet
PVEClusterApi Set-PVEClusterSdnVnetsSubnetsByVnetAndSubnet PUT /cluster/sdn/vnets/{vnet}/subnets/{subnet} Update sdn subnet object configuration.
PVEClusterApi Set-PVEClusterSdnZonesByZone PUT /cluster/sdn/zones/{zone} Update sdn zone object configuration.
PVENodesApi Get-PVENodes GET /nodes Cluster node index.
PVENodesApi Get-PVENodesAplinfoByNode GET /nodes/{node}/aplinfo Get list of appliances.
PVENodesApi Get-PVENodesAptByNode GET /nodes/{node}/apt Directory index for apt (Advanced Package Tool).
PVENodesApi Get-PVENodesAptChangelogByNode GET /nodes/{node}/apt/changelog Get package changelogs.
PVENodesApi Get-PVENodesAptRepositoriesByNode GET /nodes/{node}/apt/repositories Get APT repository information.
PVENodesApi Get-PVENodesAptUpdateByNode GET /nodes/{node}/apt/update List available updates.
PVENodesApi Get-PVENodesAptVersionsByNode GET /nodes/{node}/apt/versions Get package information for important Proxmox packages.
PVENodesApi Get-PVENodesByNode GET /nodes/{node} Node index.
PVENodesApi Get-PVENodesCapabilitiesByNode GET /nodes/{node}/capabilities Node capabilities index.
PVENodesApi Get-PVENodesCapabilitiesQemuByNode GET /nodes/{node}/capabilities/qemu QEMU capabilities index.
PVENodesApi Get-PVENodesCapabilitiesQemuCpuByNode GET /nodes/{node}/capabilities/qemu/cpu List all custom and default CPU models.
PVENodesApi Get-PVENodesCapabilitiesQemuCpuflagsByNode GET /nodes/{node}/capabilities/qemu/cpu-flags List of available VM-specific CPU flags.
PVENodesApi Get-PVENodesCapabilitiesQemuMachinesByNode GET /nodes/{node}/capabilities/qemu/machines Get available QEMU/KVM machine types.
PVENodesApi Get-PVENodesCapabilitiesQemuMigrationByNode GET /nodes/{node}/capabilities/qemu/migration Get node-specific QEMU migration capabilities of the node. Requires the 'Sys.Audit' permission on '/nodes/'.
PVENodesApi Get-PVENodesCephByNode GET /nodes/{node}/ceph Directory index.
PVENodesApi Get-PVENodesCephCfgByNode GET /nodes/{node}/ceph/cfg Directory index.
PVENodesApi Get-PVENodesCephCfgDbByNode GET /nodes/{node}/ceph/cfg/db Get the Ceph configuration database.
PVENodesApi Get-PVENodesCephCfgRawByNode GET /nodes/{node}/ceph/cfg/raw Get the Ceph configuration file.
PVENodesApi Get-PVENodesCephCfgValueByNode GET /nodes/{node}/ceph/cfg/value Get configured values from either the config file or config DB.
PVENodesApi Get-PVENodesCephCmdsafetyByNode GET /nodes/{node}/ceph/cmd-safety Heuristical check if it is safe to perform an action.
PVENodesApi Get-PVENodesCephCrushByNode GET /nodes/{node}/ceph/crush Get OSD crush map
PVENodesApi Get-PVENodesCephFsByNode GET /nodes/{node}/ceph/fs Directory index.
PVENodesApi Get-PVENodesCephLogByNode GET /nodes/{node}/ceph/log Read ceph log
PVENodesApi Get-PVENodesCephMdsByNode GET /nodes/{node}/ceph/mds MDS directory index.
PVENodesApi Get-PVENodesCephMgrByNode GET /nodes/{node}/ceph/mgr MGR directory index.
PVENodesApi Get-PVENodesCephMonByNode GET /nodes/{node}/ceph/mon Get Ceph monitor list.
PVENodesApi Get-PVENodesCephOsdByNode GET /nodes/{node}/ceph/osd Get Ceph osd list/tree.
PVENodesApi Get-PVENodesCephOsdByNodeAndOsdid GET /nodes/{node}/ceph/osd/{osdid} OSD index.
PVENodesApi Get-PVENodesCephOsdLvinfoByNodeAndOsdid GET /nodes/{node}/ceph/osd/{osdid}/lv-info Get OSD volume details
PVENodesApi Get-PVENodesCephOsdMetadataByNodeAndOsdid GET /nodes/{node}/ceph/osd/{osdid}/metadata Get OSD details
PVENodesApi Get-PVENodesCephPoolByNode GET /nodes/{node}/ceph/pool List all pools and their settings (which are settable by the POST/PUT endpoints).
PVENodesApi Get-PVENodesCephPoolByNodeAndName GET /nodes/{node}/ceph/pool/{name} Pool index.
PVENodesApi Get-PVENodesCephPoolStatusByNodeAndName GET /nodes/{node}/ceph/pool/{name}/status Show the current pool status.
PVENodesApi Get-PVENodesCephRulesByNode GET /nodes/{node}/ceph/rules List ceph rules.
PVENodesApi Get-PVENodesCephStatusByNode GET /nodes/{node}/ceph/status Get ceph status.
PVENodesApi Get-PVENodesCertificatesAcmeByNode GET /nodes/{node}/certificates/acme ACME index.
PVENodesApi Get-PVENodesCertificatesByNode GET /nodes/{node}/certificates Node index.
PVENodesApi Get-PVENodesCertificatesInfoByNode GET /nodes/{node}/certificates/info Get information about node's certificates.
PVENodesApi Get-PVENodesConfigByNode GET /nodes/{node}/config Get node configuration options.
PVENodesApi Get-PVENodesDisksByNode GET /nodes/{node}/disks Node index.
PVENodesApi Get-PVENodesDisksDirectoryByNode GET /nodes/{node}/disks/directory PVE Managed Directory storages.
PVENodesApi Get-PVENodesDisksListByNode GET /nodes/{node}/disks/list List local disks.
PVENodesApi Get-PVENodesDisksLvmByNode GET /nodes/{node}/disks/lvm List LVM Volume Groups
PVENodesApi Get-PVENodesDisksLvmthinByNode GET /nodes/{node}/disks/lvmthin List LVM thinpools
PVENodesApi Get-PVENodesDisksSmartByNode GET /nodes/{node}/disks/smart Get SMART Health of a disk.
PVENodesApi Get-PVENodesDisksZfsByNode GET /nodes/{node}/disks/zfs List Zpools.
PVENodesApi Get-PVENodesDisksZfsByNodeAndName GET /nodes/{node}/disks/zfs/{name} Get details about a zpool.
PVENodesApi Get-PVENodesDnsByNode GET /nodes/{node}/dns Read DNS settings.
PVENodesApi Get-PVENodesFirewallByNode GET /nodes/{node}/firewall Directory index.
PVENodesApi Get-PVENodesFirewallLogByNode GET /nodes/{node}/firewall/log Read firewall log
PVENodesApi Get-PVENodesFirewallOptionsByNode GET /nodes/{node}/firewall/options Get host firewall options.
PVENodesApi Get-PVENodesFirewallRulesByNode GET /nodes/{node}/firewall/rules List rules.
PVENodesApi Get-PVENodesFirewallRulesByNodeAndPos GET /nodes/{node}/firewall/rules/{pos} Get single rule data.
PVENodesApi Get-PVENodesHardwareByNode GET /nodes/{node}/hardware Index of hardware types
PVENodesApi Get-PVENodesHardwarePciByNode GET /nodes/{node}/hardware/pci List local PCI devices.
PVENodesApi Get-PVENodesHardwarePciByNodeAndPciidormapping GET /nodes/{node}/hardware/pci/{pci-id-or-mapping} Index of available pci methods
PVENodesApi Get-PVENodesHardwarePciMdevByNodeAndPciidormapping GET /nodes/{node}/hardware/pci/{pci-id-or-mapping}/mdev List mediated device types for given PCI device.
PVENodesApi Get-PVENodesHardwareUsbByNode GET /nodes/{node}/hardware/usb List local USB devices.
PVENodesApi Get-PVENodesHostsByNode GET /nodes/{node}/hosts Get the content of /etc/hosts.
PVENodesApi Get-PVENodesJournalByNode GET /nodes/{node}/journal Read Journal
PVENodesApi Get-PVENodesLxcByNode GET /nodes/{node}/lxc LXC container index (per node).
PVENodesApi Get-PVENodesLxcByNodeAndVmid GET /nodes/{node}/lxc/{vmid} Directory index
PVENodesApi Get-PVENodesLxcConfigByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/config Get container configuration.
PVENodesApi Get-PVENodesLxcFeatureByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/feature Check if feature for virtual machine is available.
PVENodesApi Get-PVENodesLxcFirewallAliasesByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/firewall/aliases List aliases
PVENodesApi Get-PVENodesLxcFirewallAliasesByNodeAndVmidAndName GET /nodes/{node}/lxc/{vmid}/firewall/aliases/{name} Read alias.
PVENodesApi Get-PVENodesLxcFirewallByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/firewall Directory index.
PVENodesApi Get-PVENodesLxcFirewallIpsetByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/firewall/ipset List IPSets
PVENodesApi Get-PVENodesLxcFirewallIpsetByNodeAndVmidAndName GET /nodes/{node}/lxc/{vmid}/firewall/ipset/{name} List IPSet content
PVENodesApi Get-PVENodesLxcFirewallIpsetByNodeAndVmidAndNameAndCidr GET /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr} Read IP or Network settings from IPSet.
PVENodesApi Get-PVENodesLxcFirewallLogByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/firewall/log Read firewall log
PVENodesApi Get-PVENodesLxcFirewallOptionsByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/firewall/options Get VM firewall options.
PVENodesApi Get-PVENodesLxcFirewallRefsByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/firewall/refs Lists possible IPSet/Alias reference which are allowed in source/dest properties.
PVENodesApi Get-PVENodesLxcFirewallRulesByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/firewall/rules List rules.
PVENodesApi Get-PVENodesLxcFirewallRulesByNodeAndVmidAndPos GET /nodes/{node}/lxc/{vmid}/firewall/rules/{pos} Get single rule data.
PVENodesApi Get-PVENodesLxcInterfacesByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/interfaces Get IP addresses of the specified container interface.
PVENodesApi Get-PVENodesLxcMigrateByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/migrate Get preconditions for migration.
PVENodesApi Get-PVENodesLxcMtunnelwebsocketByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/mtunnelwebsocket Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.
PVENodesApi Get-PVENodesLxcPendingByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/pending Get container configuration, including pending changes.
PVENodesApi Get-PVENodesLxcRrdByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/rrd Read VM RRD statistics (returns PNG)
PVENodesApi Get-PVENodesLxcRrddataByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/rrddata Read VM RRD statistics
PVENodesApi Get-PVENodesLxcSnapshotByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/snapshot List all snapshots.
PVENodesApi Get-PVENodesLxcSnapshotByNodeAndVmidAndSnapname GET /nodes/{node}/lxc/{vmid}/snapshot/{snapname}
PVENodesApi Get-PVENodesLxcSnapshotConfigByNodeAndVmidAndSnapname GET /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config Get snapshot configuration
PVENodesApi Get-PVENodesLxcStatusByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/status Directory index
PVENodesApi Get-PVENodesLxcStatusCurrentByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/status/current Get virtual machine status.
PVENodesApi Get-PVENodesLxcVncwebsocketByNodeAndVmid GET /nodes/{node}/lxc/{vmid}/vncwebsocket Opens a websocket for VNC traffic.
PVENodesApi Get-PVENodesNetstatByNode GET /nodes/{node}/netstat Read tap/vm network device interface counters
PVENodesApi Get-PVENodesNetworkByNode GET /nodes/{node}/network List available networks
PVENodesApi Get-PVENodesNetworkByNodeAndIface GET /nodes/{node}/network/{iface} Read network device configuration
PVENodesApi Get-PVENodesQemuAgentByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent QEMU Guest Agent command index.
PVENodesApi Get-PVENodesQemuAgentExecstatusByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/exec-status Gets the status of the given pid started by the guest-agent
PVENodesApi Get-PVENodesQemuAgentFilereadByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/file-read Reads the given file via guest agent. Is limited to 16777216 bytes.
PVENodesApi Get-PVENodesQemuAgentGetfsinfoByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/get-fsinfo Execute get-fsinfo.
PVENodesApi Get-PVENodesQemuAgentGethostnameByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/get-host-name Execute get-host-name.
PVENodesApi Get-PVENodesQemuAgentGetmemoryblockinfoByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/get-memory-block-info Execute get-memory-block-info.
PVENodesApi Get-PVENodesQemuAgentGetmemoryblocksByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/get-memory-blocks Execute get-memory-blocks.
PVENodesApi Get-PVENodesQemuAgentGetosinfoByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/get-osinfo Execute get-osinfo.
PVENodesApi Get-PVENodesQemuAgentGettimeByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/get-time Execute get-time.
PVENodesApi Get-PVENodesQemuAgentGettimezoneByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/get-timezone Execute get-timezone.
PVENodesApi Get-PVENodesQemuAgentGetusersByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/get-users Execute get-users.
PVENodesApi Get-PVENodesQemuAgentGetvcpusByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/get-vcpus Execute get-vcpus.
PVENodesApi Get-PVENodesQemuAgentInfoByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/info Execute info.
PVENodesApi Get-PVENodesQemuAgentNetworkgetinterfacesByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/agent/network-get-interfaces Execute network-get-interfaces.
PVENodesApi Get-PVENodesQemuByNode GET /nodes/{node}/qemu Virtual machine index (per node).
PVENodesApi Get-PVENodesQemuByNodeAndVmid GET /nodes/{node}/qemu/{vmid} Directory index
PVENodesApi Get-PVENodesQemuCloudinitByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/cloudinit Get the cloudinit configuration with both current and pending values.
PVENodesApi Get-PVENodesQemuCloudinitDumpByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/cloudinit/dump Get automatically generated cloudinit config.
PVENodesApi Get-PVENodesQemuConfigByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/config Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.
PVENodesApi Get-PVENodesQemuFeatureByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/feature Check if feature for virtual machine is available.
PVENodesApi Get-PVENodesQemuFirewallAliasesByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/firewall/aliases List aliases
PVENodesApi Get-PVENodesQemuFirewallAliasesByNodeAndVmidAndName GET /nodes/{node}/qemu/{vmid}/firewall/aliases/{name} Read alias.
PVENodesApi Get-PVENodesQemuFirewallByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/firewall Directory index.
PVENodesApi Get-PVENodesQemuFirewallIpsetByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/firewall/ipset List IPSets
PVENodesApi Get-PVENodesQemuFirewallIpsetByNodeAndVmidAndName GET /nodes/{node}/qemu/{vmid}/firewall/ipset/{name} List IPSet content
PVENodesApi Get-PVENodesQemuFirewallIpsetByNodeAndVmidAndNameAndCidr GET /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr} Read IP or Network settings from IPSet.
PVENodesApi Get-PVENodesQemuFirewallLogByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/firewall/log Read firewall log
PVENodesApi Get-PVENodesQemuFirewallOptionsByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/firewall/options Get VM firewall options.
PVENodesApi Get-PVENodesQemuFirewallRefsByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/firewall/refs Lists possible IPSet/Alias reference which are allowed in source/dest properties.
PVENodesApi Get-PVENodesQemuFirewallRulesByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/firewall/rules List rules.
PVENodesApi Get-PVENodesQemuFirewallRulesByNodeAndVmidAndPos GET /nodes/{node}/qemu/{vmid}/firewall/rules/{pos} Get single rule data.
PVENodesApi Get-PVENodesQemuMigrateByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/migrate Get preconditions for migration.
PVENodesApi Get-PVENodesQemuMtunnelwebsocketByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/mtunnelwebsocket Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.
PVENodesApi Get-PVENodesQemuPendingByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/pending Get the virtual machine configuration with both current and pending values.
PVENodesApi Get-PVENodesQemuRrdByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/rrd Read VM RRD statistics (returns PNG)
PVENodesApi Get-PVENodesQemuRrddataByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/rrddata Read VM RRD statistics
PVENodesApi Get-PVENodesQemuSnapshotByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/snapshot List all snapshots.
PVENodesApi Get-PVENodesQemuSnapshotByNodeAndVmidAndSnapname GET /nodes/{node}/qemu/{vmid}/snapshot/{snapname}
PVENodesApi Get-PVENodesQemuSnapshotConfigByNodeAndVmidAndSnapname GET /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config Get snapshot configuration
PVENodesApi Get-PVENodesQemuStatusByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/status Directory index
PVENodesApi Get-PVENodesQemuStatusCurrentByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/status/current Get virtual machine status.
PVENodesApi Get-PVENodesQemuVncwebsocketByNodeAndVmid GET /nodes/{node}/qemu/{vmid}/vncwebsocket Opens a websocket for VNC traffic.
PVENodesApi Get-PVENodesQueryocirepotagsByNode GET /nodes/{node}/query-oci-repo-tags List all tags for an OCI repository reference.
PVENodesApi Get-PVENodesQueryurlmetadataByNode GET /nodes/{node}/query-url-metadata Query metadata of an URL: file size, file name and mime type.
PVENodesApi Get-PVENodesReplicationByNode GET /nodes/{node}/replication List status of all replication jobs on this node.
PVENodesApi Get-PVENodesReplicationByNodeAndId GET /nodes/{node}/replication/{id} Directory index.
PVENodesApi Get-PVENodesReplicationLogByNodeAndId GET /nodes/{node}/replication/{id}/log Read replication job log.
PVENodesApi Get-PVENodesReplicationStatusByNodeAndId GET /nodes/{node}/replication/{id}/status Get replication job status.
PVENodesApi Get-PVENodesReportByNode GET /nodes/{node}/report Gather various systems information about a node
PVENodesApi Get-PVENodesRrdByNode GET /nodes/{node}/rrd Read node RRD statistics (returns PNG)
PVENodesApi Get-PVENodesRrddataByNode GET /nodes/{node}/rrddata Read node RRD statistics
PVENodesApi Get-PVENodesScanByNode GET /nodes/{node}/scan Index of available scan methods
PVENodesApi Get-PVENodesScanCifsByNode GET /nodes/{node}/scan/cifs Scan remote CIFS server.
PVENodesApi Get-PVENodesScanIscsiByNode GET /nodes/{node}/scan/iscsi Scan remote iSCSI server.
PVENodesApi Get-PVENodesScanLvmByNode GET /nodes/{node}/scan/lvm List local LVM volume groups.
PVENodesApi Get-PVENodesScanLvmthinByNode GET /nodes/{node}/scan/lvmthin List local LVM Thin Pools.
PVENodesApi Get-PVENodesScanNfsByNode GET /nodes/{node}/scan/nfs Scan remote NFS server.
PVENodesApi Get-PVENodesScanPbsByNode GET /nodes/{node}/scan/pbs Scan remote Proxmox Backup Server.
PVENodesApi Get-PVENodesScanZfsByNode GET /nodes/{node}/scan/zfs Scan zfs pool list on local node.
PVENodesApi Get-PVENodesSdnByNode GET /nodes/{node}/sdn SDN index.
PVENodesApi Get-PVENodesSdnFabricsByNodeAndFabric GET /nodes/{node}/sdn/fabrics/{fabric} Directory index for SDN fabric status.
PVENodesApi Get-PVENodesSdnFabricsInterfacesByNodeAndFabric GET /nodes/{node}/sdn/fabrics/{fabric}/interfaces Get all interfaces for a fabric.
PVENodesApi Get-PVENodesSdnFabricsNeighborsByNodeAndFabric GET /nodes/{node}/sdn/fabrics/{fabric}/neighbors Get all neighbors for a fabric.
PVENodesApi Get-PVENodesSdnFabricsRoutesByNodeAndFabric GET /nodes/{node}/sdn/fabrics/{fabric}/routes Get all routes for a fabric.
PVENodesApi Get-PVENodesSdnVnetsByNodeAndVnet GET /nodes/{node}/sdn/vnets/{vnet}
PVENodesApi Get-PVENodesSdnVnetsMacvrfByNodeAndVnet GET /nodes/{node}/sdn/vnets/{vnet}/mac-vrf Get the MAC VRF for a VNet in an EVPN zone.
PVENodesApi Get-PVENodesSdnZonesBridgesByNodeAndZone GET /nodes/{node}/sdn/zones/{zone}/bridges Get a list of all bridges (vnets) that are part of a zone, as well as the ports that are members of that bridge.
PVENodesApi Get-PVENodesSdnZonesByNode GET /nodes/{node}/sdn/zones Get status for all zones.
PVENodesApi Get-PVENodesSdnZonesByNodeAndZone GET /nodes/{node}/sdn/zones/{zone} Directory index for SDN zone status.
PVENodesApi Get-PVENodesSdnZonesContentByNodeAndZone GET /nodes/{node}/sdn/zones/{zone}/content List zone content.
PVENodesApi Get-PVENodesSdnZonesIpvrfByNodeAndZone GET /nodes/{node}/sdn/zones/{zone}/ip-vrf Get the IP VRF of an EVPN zone.
PVENodesApi Get-PVENodesServicesByNode GET /nodes/{node}/services Service list.
PVENodesApi Get-PVENodesServicesByNodeAndService GET /nodes/{node}/services/{service} Directory index
PVENodesApi Get-PVENodesServicesStateByNodeAndService GET /nodes/{node}/services/{service}/state Read service properties
PVENodesApi Get-PVENodesStatusByNode GET /nodes/{node}/status Read node status
PVENodesApi Get-PVENodesStorageByNode GET /nodes/{node}/storage Get status for all datastores.
PVENodesApi Get-PVENodesStorageByNodeAndStorage GET /nodes/{node}/storage/{storage}
PVENodesApi Get-PVENodesStorageContentByNodeAndStorage GET /nodes/{node}/storage/{storage}/content List storage content.
PVENodesApi Get-PVENodesStorageContentByNodeAndStorageAndVolume GET /nodes/{node}/storage/{storage}/content/{volume} Get volume attributes
PVENodesApi Get-PVENodesStorageFilerestoreDownloadByNodeAndStorage GET /nodes/{node}/storage/{storage}/file-restore/download Extract a file or directory (as zip archive) from a PBS backup.
PVENodesApi Get-PVENodesStorageFilerestoreListByNodeAndStorage GET /nodes/{node}/storage/{storage}/file-restore/list List files and directories for single file restore under the given path.
PVENodesApi Get-PVENodesStorageImportmetadataByNodeAndStorage GET /nodes/{node}/storage/{storage}/import-metadata Get the base parameters for creating a guest which imports data from a foreign importable guest, like an ESXi VM
PVENodesApi Get-PVENodesStoragePrunebackupsByNodeAndStorage GET /nodes/{node}/storage/{storage}/prunebackups Get prune information for backups. NOTE: this is only a preview and might not be what a subsequent prune call does if backups are removed/added in the meantime.
PVENodesApi Get-PVENodesStorageRrdByNodeAndStorage GET /nodes/{node}/storage/{storage}/rrd Read storage RRD statistics (returns PNG).
PVENodesApi Get-PVENodesStorageRrddataByNodeAndStorage GET /nodes/{node}/storage/{storage}/rrddata Read storage RRD statistics.
PVENodesApi Get-PVENodesStorageStatusByNodeAndStorage GET /nodes/{node}/storage/{storage}/status Read storage status.
PVENodesApi Get-PVENodesSubscriptionByNode GET /nodes/{node}/subscription Read subscription info.
PVENodesApi Get-PVENodesSyslogByNode GET /nodes/{node}/syslog Read system log
PVENodesApi Get-PVENodesTasksByNode GET /nodes/{node}/tasks Read task list for one node (finished tasks).
PVENodesApi Get-PVENodesTasksByNodeAndUpid GET /nodes/{node}/tasks/{upid}
PVENodesApi Get-PVENodesTasksLogByNodeAndUpid GET /nodes/{node}/tasks/{upid}/log Read task log.
PVENodesApi Get-PVENodesTasksStatusByNodeAndUpid GET /nodes/{node}/tasks/{upid}/status Read task status.
PVENodesApi Get-PVENodesTimeByNode GET /nodes/{node}/time Read server time and time zone settings.
PVENodesApi Get-PVENodesVersionByNode GET /nodes/{node}/version API version details
PVENodesApi Get-PVENodesVncwebsocketByNode GET /nodes/{node}/vncwebsocket Opens a websocket for VNC traffic.
PVENodesApi Get-PVENodesVzdumpDefaultsByNode GET /nodes/{node}/vzdump/defaults Get the currently configured vzdump defaults.
PVENodesApi Get-PVENodesVzdumpExtractconfigByNode GET /nodes/{node}/vzdump/extractconfig Extract configuration from vzdump backup archive.
PVENodesApi New-PVENodesAplinfoByNode POST /nodes/{node}/aplinfo Download appliance templates.
PVENodesApi New-PVENodesAptRepositoriesByNode POST /nodes/{node}/apt/repositories Change the properties of a repository. Currently only allows enabling/disabling.
PVENodesApi New-PVENodesAptUpdateByNode POST /nodes/{node}/apt/update This is used to resynchronize the package index files from their sources (apt-get update).
PVENodesApi New-PVENodesCephFsByNodeAndName POST /nodes/{node}/ceph/fs/{name} Create a Ceph filesystem
PVENodesApi New-PVENodesCephInitByNode POST /nodes/{node}/ceph/init Create initial ceph default configuration and setup symlinks.
PVENodesApi New-PVENodesCephMdsByNodeAndName POST /nodes/{node}/ceph/mds/{name} Create Ceph Metadata Server (MDS)
PVENodesApi New-PVENodesCephMgrByNodeAndId POST /nodes/{node}/ceph/mgr/{id} Create Ceph Manager
PVENodesApi New-PVENodesCephMonByNodeAndMonid POST /nodes/{node}/ceph/mon/{monid} Create Ceph Monitor and Manager
PVENodesApi New-PVENodesCephOsdByNode POST /nodes/{node}/ceph/osd Create OSD
PVENodesApi New-PVENodesCephOsdInByNodeAndOsdid POST /nodes/{node}/ceph/osd/{osdid}/in ceph osd in
PVENodesApi New-PVENodesCephOsdOutByNodeAndOsdid POST /nodes/{node}/ceph/osd/{osdid}/out ceph osd out
PVENodesApi New-PVENodesCephOsdScrubByNodeAndOsdid POST /nodes/{node}/ceph/osd/{osdid}/scrub Instruct the OSD to scrub.
PVENodesApi New-PVENodesCephPoolByNode POST /nodes/{node}/ceph/pool Create Ceph pool
PVENodesApi New-PVENodesCephRestartByNode POST /nodes/{node}/ceph/restart Restart ceph services.
PVENodesApi New-PVENodesCephStartByNode POST /nodes/{node}/ceph/start Start ceph services.
PVENodesApi New-PVENodesCephStopByNode POST /nodes/{node}/ceph/stop Stop ceph services.
PVENodesApi New-PVENodesCertificatesAcmeCertificateByNode POST /nodes/{node}/certificates/acme/certificate Order a new certificate from ACME-compatible CA.
PVENodesApi New-PVENodesCertificatesCustomByNode POST /nodes/{node}/certificates/custom Upload or update custom certificate chain and key.
PVENodesApi New-PVENodesDisksDirectoryByNode POST /nodes/{node}/disks/directory Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'.
PVENodesApi New-PVENodesDisksInitgptByNode POST /nodes/{node}/disks/initgpt Initialize Disk with GPT
PVENodesApi New-PVENodesDisksLvmByNode POST /nodes/{node}/disks/lvm Create an LVM Volume Group
PVENodesApi New-PVENodesDisksLvmthinByNode POST /nodes/{node}/disks/lvmthin Create an LVM thinpool
PVENodesApi New-PVENodesDisksZfsByNode POST /nodes/{node}/disks/zfs Create a ZFS pool.
PVENodesApi New-PVENodesExecuteByNode POST /nodes/{node}/execute Execute multiple commands in order, root only.
PVENodesApi New-PVENodesFirewallRulesByNode POST /nodes/{node}/firewall/rules Create new rule.
PVENodesApi New-PVENodesHostsByNode POST /nodes/{node}/hosts Write /etc/hosts.
PVENodesApi New-PVENodesLxcByNode POST /nodes/{node}/lxc Create or restore a container.
PVENodesApi New-PVENodesLxcCloneByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/clone Create a container clone/copy
PVENodesApi New-PVENodesLxcFirewallAliasesByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/firewall/aliases Create IP or Network Alias.
PVENodesApi New-PVENodesLxcFirewallIpsetByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/firewall/ipset Create new IPSet
PVENodesApi New-PVENodesLxcFirewallIpsetByNodeAndVmidAndName POST /nodes/{node}/lxc/{vmid}/firewall/ipset/{name} Add IP or Network to IPSet.
PVENodesApi New-PVENodesLxcFirewallRulesByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/firewall/rules Create new rule.
PVENodesApi New-PVENodesLxcMigrateByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/migrate Migrate the container to another node. Creates a new migration task.
PVENodesApi New-PVENodesLxcMovevolumeByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/move_volume Move a rootfs-/mp-volume to a different storage or to a different container.
PVENodesApi New-PVENodesLxcMtunnelByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/mtunnel Migration tunnel endpoint - only for internal use by CT migration.
PVENodesApi New-PVENodesLxcRemotemigrateByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/remote_migrate Migrate the container to another cluster. Creates a new migration task. EXPERIMENTAL feature!
PVENodesApi New-PVENodesLxcSnapshotByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/snapshot Snapshot a container.
PVENodesApi New-PVENodesLxcSnapshotRollbackByNodeAndVmidAndSnapname POST /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/rollback Rollback LXC state to specified snapshot.
PVENodesApi New-PVENodesLxcSpiceproxyByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/spiceproxy Returns a SPICE configuration to connect to the CT.
PVENodesApi New-PVENodesLxcStatusRebootByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/status/reboot Reboot the container by shutting it down, and starting it again. Applies pending changes.
PVENodesApi New-PVENodesLxcStatusResumeByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/status/resume Resume the container.
PVENodesApi New-PVENodesLxcStatusShutdownByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/status/shutdown Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.
PVENodesApi New-PVENodesLxcStatusStartByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/status/start Start the container.
PVENodesApi New-PVENodesLxcStatusStopByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/status/stop Stop the container. This will abruptly stop all processes running in the container.
PVENodesApi New-PVENodesLxcStatusSuspendByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/status/suspend Suspend the container. This is experimental.
PVENodesApi New-PVENodesLxcTemplateByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/template Create a Template.
PVENodesApi New-PVENodesLxcTermproxyByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/termproxy Creates a TCP proxy connection.
PVENodesApi New-PVENodesLxcVncproxyByNodeAndVmid POST /nodes/{node}/lxc/{vmid}/vncproxy Creates a TCP VNC proxy connections.
PVENodesApi New-PVENodesMigrateallByNode POST /nodes/{node}/migrateall Migrate all VMs and Containers.
PVENodesApi New-PVENodesNetworkByNode POST /nodes/{node}/network Create network device configuration
PVENodesApi New-PVENodesQemuAgentByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent Execute QEMU Guest Agent commands.
PVENodesApi New-PVENodesQemuAgentExecByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/exec Executes the given command in the vm via the guest-agent and returns an object with the pid.
PVENodesApi New-PVENodesQemuAgentFilewriteByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/file-write Writes the given file via guest agent.
PVENodesApi New-PVENodesQemuAgentFsfreezefreezeByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/fsfreeze-freeze Execute fsfreeze-freeze.
PVENodesApi New-PVENodesQemuAgentFsfreezestatusByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/fsfreeze-status Execute fsfreeze-status.
PVENodesApi New-PVENodesQemuAgentFsfreezethawByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/fsfreeze-thaw Execute fsfreeze-thaw.
PVENodesApi New-PVENodesQemuAgentFstrimByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/fstrim Execute fstrim.
PVENodesApi New-PVENodesQemuAgentPingByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/ping Execute ping.
PVENodesApi New-PVENodesQemuAgentSetuserpasswordByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/set-user-password Sets the password for the given user to the given password
PVENodesApi New-PVENodesQemuAgentShutdownByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/shutdown Execute shutdown.
PVENodesApi New-PVENodesQemuAgentSuspenddiskByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/suspend-disk Execute suspend-disk.
PVENodesApi New-PVENodesQemuAgentSuspendhybridByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/suspend-hybrid Execute suspend-hybrid.
PVENodesApi New-PVENodesQemuAgentSuspendramByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/agent/suspend-ram Execute suspend-ram.
PVENodesApi New-PVENodesQemuByNode POST /nodes/{node}/qemu Create or restore a virtual machine.
PVENodesApi New-PVENodesQemuCloneByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/clone Create a copy of virtual machine/template.
PVENodesApi New-PVENodesQemuConfigByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/config Set virtual machine options (asynchronous API).
PVENodesApi New-PVENodesQemuDbusvmstateByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/dbus-vmstate Control the dbus-vmstate helper for a given running VM.
PVENodesApi New-PVENodesQemuFirewallAliasesByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/firewall/aliases Create IP or Network Alias.
PVENodesApi New-PVENodesQemuFirewallIpsetByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/firewall/ipset Create new IPSet
PVENodesApi New-PVENodesQemuFirewallIpsetByNodeAndVmidAndName POST /nodes/{node}/qemu/{vmid}/firewall/ipset/{name} Add IP or Network to IPSet.
PVENodesApi New-PVENodesQemuFirewallRulesByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/firewall/rules Create new rule.
PVENodesApi New-PVENodesQemuMigrateByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/migrate Migrate virtual machine. Creates a new migration task.
PVENodesApi New-PVENodesQemuMonitorByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/monitor Execute QEMU monitor commands.
PVENodesApi New-PVENodesQemuMovediskByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/move_disk Move volume to different storage or to a different VM.
PVENodesApi New-PVENodesQemuMtunnelByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/mtunnel Migration tunnel endpoint - only for internal use by VM migration.
PVENodesApi New-PVENodesQemuRemotemigrateByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/remote_migrate Migrate virtual machine to a remote cluster. Creates a new migration task. EXPERIMENTAL feature!
PVENodesApi New-PVENodesQemuSnapshotByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/snapshot Snapshot a VM.
PVENodesApi New-PVENodesQemuSnapshotRollbackByNodeAndVmidAndSnapname POST /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/rollback Rollback VM state to specified snapshot.
PVENodesApi New-PVENodesQemuSpiceproxyByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/spiceproxy Returns a SPICE configuration to connect to the VM.
PVENodesApi New-PVENodesQemuStatusRebootByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/status/reboot Reboot the VM by shutting it down, and starting it again. Applies pending changes.
PVENodesApi New-PVENodesQemuStatusResetByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/status/reset Reset virtual machine.
PVENodesApi New-PVENodesQemuStatusResumeByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/status/resume Resume virtual machine.
PVENodesApi New-PVENodesQemuStatusShutdownByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/status/shutdown Shutdown virtual machine. This is similar to pressing the power button on a physical machine. This will send an ACPI event for the guest OS, which should then proceed to a clean shutdown.
PVENodesApi New-PVENodesQemuStatusStartByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/status/start Start virtual machine.
PVENodesApi New-PVENodesQemuStatusStopByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/status/stop Stop virtual machine. The qemu process will exit immediately. This is akin to pulling the power plug of a running computer and may damage the VM data.
PVENodesApi New-PVENodesQemuStatusSuspendByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/status/suspend Suspend virtual machine.
PVENodesApi New-PVENodesQemuTemplateByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/template Create a Template.
PVENodesApi New-PVENodesQemuTermproxyByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/termproxy Creates a TCP proxy connections.
PVENodesApi New-PVENodesQemuVncproxyByNodeAndVmid POST /nodes/{node}/qemu/{vmid}/vncproxy Creates a TCP VNC proxy connections.
PVENodesApi New-PVENodesReplicationSchedulenowByNodeAndId POST /nodes/{node}/replication/{id}/schedule_now Schedule replication job to start as soon as possible.
PVENodesApi New-PVENodesServicesReloadByNodeAndService POST /nodes/{node}/services/{service}/reload Reload service. Falls back to restart if service cannot be reloaded.
PVENodesApi New-PVENodesServicesRestartByNodeAndService POST /nodes/{node}/services/{service}/restart Hard restart service. Use reload if you want to reduce interruptions.
PVENodesApi New-PVENodesServicesStartByNodeAndService POST /nodes/{node}/services/{service}/start Start service.
PVENodesApi New-PVENodesServicesStopByNodeAndService POST /nodes/{node}/services/{service}/stop Stop service.
PVENodesApi New-PVENodesSpiceshellByNode POST /nodes/{node}/spiceshell Creates a SPICE shell.
PVENodesApi New-PVENodesStartallByNode POST /nodes/{node}/startall Start all VMs and containers located on this node (by default only those with onboot=1).
PVENodesApi New-PVENodesStatusByNode POST /nodes/{node}/status Reboot or shutdown a node.
PVENodesApi New-PVENodesStopallByNode POST /nodes/{node}/stopall Stop all VMs and Containers.
PVENodesApi New-PVENodesStorageContentByNodeAndStorage POST /nodes/{node}/storage/{storage}/content Allocate disk images.
PVENodesApi New-PVENodesStorageContentByNodeAndStorageAndVolume POST /nodes/{node}/storage/{storage}/content/{volume} Copy a volume. This is experimental code - do not use.
PVENodesApi New-PVENodesStorageDownloadurlByNodeAndStorage POST /nodes/{node}/storage/{storage}/download-url Download templates, ISO images, OVAs and VM images by using an URL.
PVENodesApi New-PVENodesStorageOciregistrypullByNodeAndStorage POST /nodes/{node}/storage/{storage}/oci-registry-pull Pull an OCI image from a registry.
PVENodesApi New-PVENodesStorageUploadByNodeAndStorage POST /nodes/{node}/storage/{storage}/upload Upload templates, ISO images, OVAs and VM images.
PVENodesApi New-PVENodesSubscriptionByNode POST /nodes/{node}/subscription Update subscription info.
PVENodesApi New-PVENodesSuspendallByNode POST /nodes/{node}/suspendall Suspend all VMs.
PVENodesApi New-PVENodesTermproxyByNode POST /nodes/{node}/termproxy Creates a VNC Shell proxy.
PVENodesApi New-PVENodesVncshellByNode POST /nodes/{node}/vncshell Creates a VNC Shell proxy.
PVENodesApi New-PVENodesVzdumpByNode POST /nodes/{node}/vzdump Create backup.
PVENodesApi New-PVENodesWakeonlanByNode POST /nodes/{node}/wakeonlan Try to wake a node via 'wake on LAN' network packet.
PVENodesApi Remove-PVENodesCephMdsByNodeAndName DELETE /nodes/{node}/ceph/mds/{name} Destroy Ceph Metadata Server
PVENodesApi Remove-PVENodesCephMgrByNodeAndId DELETE /nodes/{node}/ceph/mgr/{id} Destroy Ceph Manager.
PVENodesApi Remove-PVENodesCephMonByNodeAndMonid DELETE /nodes/{node}/ceph/mon/{monid} Destroy Ceph Monitor and Manager.
PVENodesApi Remove-PVENodesCephOsdByNodeAndOsdid DELETE /nodes/{node}/ceph/osd/{osdid} Destroy OSD
PVENodesApi Remove-PVENodesCephPoolByNodeAndName DELETE /nodes/{node}/ceph/pool/{name} Destroy pool
PVENodesApi Remove-PVENodesCertificatesAcmeCertificateByNode DELETE /nodes/{node}/certificates/acme/certificate Revoke existing certificate from CA.
PVENodesApi Remove-PVENodesCertificatesCustomByNode DELETE /nodes/{node}/certificates/custom DELETE custom certificate chain and key.
PVENodesApi Remove-PVENodesDisksDirectoryByNodeAndName DELETE /nodes/{node}/disks/directory/{name} Unmounts the storage and removes the mount unit.
PVENodesApi Remove-PVENodesDisksLvmByNodeAndName DELETE /nodes/{node}/disks/lvm/{name} Remove an LVM Volume Group.
PVENodesApi Remove-PVENodesDisksLvmthinByNodeAndName DELETE /nodes/{node}/disks/lvmthin/{name} Remove an LVM thin pool.
PVENodesApi Remove-PVENodesDisksZfsByNodeAndName DELETE /nodes/{node}/disks/zfs/{name} Destroy a ZFS pool.
PVENodesApi Remove-PVENodesFirewallRulesByNodeAndPos DELETE /nodes/{node}/firewall/rules/{pos} Delete rule.
PVENodesApi Remove-PVENodesLxcByNodeAndVmid DELETE /nodes/{node}/lxc/{vmid} Destroy the container (also delete all uses files).
PVENodesApi Remove-PVENodesLxcFirewallAliasesByNodeAndVmidAndName DELETE /nodes/{node}/lxc/{vmid}/firewall/aliases/{name} Remove IP or Network alias.
PVENodesApi Remove-PVENodesLxcFirewallIpsetByNodeAndVmidAndName DELETE /nodes/{node}/lxc/{vmid}/firewall/ipset/{name} Delete IPSet
PVENodesApi Remove-PVENodesLxcFirewallIpsetByNodeAndVmidAndNameAndCidr DELETE /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr} Remove IP or Network from IPSet.
PVENodesApi Remove-PVENodesLxcFirewallRulesByNodeAndVmidAndPos DELETE /nodes/{node}/lxc/{vmid}/firewall/rules/{pos} Delete rule.
PVENodesApi Remove-PVENodesLxcSnapshotByNodeAndVmidAndSnapname DELETE /nodes/{node}/lxc/{vmid}/snapshot/{snapname} Delete a LXC snapshot.
PVENodesApi Remove-PVENodesNetworkByNode DELETE /nodes/{node}/network Revert network configuration changes.
PVENodesApi Remove-PVENodesNetworkByNodeAndIface DELETE /nodes/{node}/network/{iface} Delete network device configuration
PVENodesApi Remove-PVENodesQemuByNodeAndVmid DELETE /nodes/{node}/qemu/{vmid} Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules
PVENodesApi Remove-PVENodesQemuFirewallAliasesByNodeAndVmidAndName DELETE /nodes/{node}/qemu/{vmid}/firewall/aliases/{name} Remove IP or Network alias.
PVENodesApi Remove-PVENodesQemuFirewallIpsetByNodeAndVmidAndName DELETE /nodes/{node}/qemu/{vmid}/firewall/ipset/{name} Delete IPSet
PVENodesApi Remove-PVENodesQemuFirewallIpsetByNodeAndVmidAndNameAndCidr DELETE /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr} Remove IP or Network from IPSet.
PVENodesApi Remove-PVENodesQemuFirewallRulesByNodeAndVmidAndPos DELETE /nodes/{node}/qemu/{vmid}/firewall/rules/{pos} Delete rule.
PVENodesApi Remove-PVENodesQemuSnapshotByNodeAndVmidAndSnapname DELETE /nodes/{node}/qemu/{vmid}/snapshot/{snapname} Delete a VM snapshot.
PVENodesApi Remove-PVENodesStorageContentByNodeAndStorageAndVolume DELETE /nodes/{node}/storage/{storage}/content/{volume} Delete volume
PVENodesApi Remove-PVENodesStoragePrunebackupsByNodeAndStorage DELETE /nodes/{node}/storage/{storage}/prunebackups Prune backups. Only those using the standard naming scheme are considered.
PVENodesApi Remove-PVENodesSubscriptionByNode DELETE /nodes/{node}/subscription Delete subscription key of this node.
PVENodesApi Remove-PVENodesTasksByNodeAndUpid DELETE /nodes/{node}/tasks/{upid} Stop a task.
PVENodesApi Set-PVENodesAptRepositoriesByNode PUT /nodes/{node}/apt/repositories Add a standard repository to the configuration
PVENodesApi Set-PVENodesCephPoolByNodeAndName PUT /nodes/{node}/ceph/pool/{name} Change POOL settings
PVENodesApi Set-PVENodesCertificatesAcmeCertificateByNode PUT /nodes/{node}/certificates/acme/certificate Renew existing certificate from CA.
PVENodesApi Set-PVENodesConfigByNode PUT /nodes/{node}/config Set node configuration options.
PVENodesApi Set-PVENodesDisksWipediskByNode PUT /nodes/{node}/disks/wipedisk Wipe a disk or partition.
PVENodesApi Set-PVENodesDnsByNode PUT /nodes/{node}/dns Write DNS settings.
PVENodesApi Set-PVENodesFirewallOptionsByNode PUT /nodes/{node}/firewall/options Set Firewall options.
PVENodesApi Set-PVENodesFirewallRulesByNodeAndPos PUT /nodes/{node}/firewall/rules/{pos} Modify rule data.
PVENodesApi Set-PVENodesLxcConfigByNodeAndVmid PUT /nodes/{node}/lxc/{vmid}/config Set container options.
PVENodesApi Set-PVENodesLxcFirewallAliasesByNodeAndVmidAndName PUT /nodes/{node}/lxc/{vmid}/firewall/aliases/{name} Update IP or Network alias.
PVENodesApi Set-PVENodesLxcFirewallIpsetByNodeAndVmidAndNameAndCidr PUT /nodes/{node}/lxc/{vmid}/firewall/ipset/{name}/{cidr} Update IP or Network settings
PVENodesApi Set-PVENodesLxcFirewallOptionsByNodeAndVmid PUT /nodes/{node}/lxc/{vmid}/firewall/options Set Firewall options.
PVENodesApi Set-PVENodesLxcFirewallRulesByNodeAndVmidAndPos PUT /nodes/{node}/lxc/{vmid}/firewall/rules/{pos} Modify rule data.
PVENodesApi Set-PVENodesLxcResizeByNodeAndVmid PUT /nodes/{node}/lxc/{vmid}/resize Resize a container mount point.
PVENodesApi Set-PVENodesLxcSnapshotConfigByNodeAndVmidAndSnapname PUT /nodes/{node}/lxc/{vmid}/snapshot/{snapname}/config Update snapshot metadata.
PVENodesApi Set-PVENodesNetworkByNode PUT /nodes/{node}/network Reload network configuration
PVENodesApi Set-PVENodesNetworkByNodeAndIface PUT /nodes/{node}/network/{iface} Update network device configuration
PVENodesApi Set-PVENodesQemuCloudinitByNodeAndVmid PUT /nodes/{node}/qemu/{vmid}/cloudinit Regenerate and change cloudinit config drive.
PVENodesApi Set-PVENodesQemuConfigByNodeAndVmid PUT /nodes/{node}/qemu/{vmid}/config Set virtual machine options (synchronous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.
PVENodesApi Set-PVENodesQemuFirewallAliasesByNodeAndVmidAndName PUT /nodes/{node}/qemu/{vmid}/firewall/aliases/{name} Update IP or Network alias.
PVENodesApi Set-PVENodesQemuFirewallIpsetByNodeAndVmidAndNameAndCidr PUT /nodes/{node}/qemu/{vmid}/firewall/ipset/{name}/{cidr} Update IP or Network settings
PVENodesApi Set-PVENodesQemuFirewallOptionsByNodeAndVmid PUT /nodes/{node}/qemu/{vmid}/firewall/options Set Firewall options.
PVENodesApi Set-PVENodesQemuFirewallRulesByNodeAndVmidAndPos PUT /nodes/{node}/qemu/{vmid}/firewall/rules/{pos} Modify rule data.
PVENodesApi Set-PVENodesQemuResizeByNodeAndVmid PUT /nodes/{node}/qemu/{vmid}/resize Extend volume size.
PVENodesApi Set-PVENodesQemuSendkeyByNodeAndVmid PUT /nodes/{node}/qemu/{vmid}/sendkey Send key event to virtual machine.
PVENodesApi Set-PVENodesQemuSnapshotConfigByNodeAndVmidAndSnapname PUT /nodes/{node}/qemu/{vmid}/snapshot/{snapname}/config Update snapshot metadata.
PVENodesApi Set-PVENodesQemuUnlinkByNodeAndVmid PUT /nodes/{node}/qemu/{vmid}/unlink Unlink/delete disk images.
PVENodesApi Set-PVENodesStorageContentByNodeAndStorageAndVolume PUT /nodes/{node}/storage/{storage}/content/{volume} Update volume attributes
PVENodesApi Set-PVENodesSubscriptionByNode PUT /nodes/{node}/subscription Set subscription key.
PVENodesApi Set-PVENodesTimeByNode PUT /nodes/{node}/time Set time zone.
PVEPoolsApi Get-PVEPools GET /pools List pools or get pool configuration.
PVEPoolsApi Get-PVEPoolsByPoolid GET /pools/{poolid} Get pool configuration (deprecated, no support for nested pools, use 'GET /pools/?poolid={poolid}').
PVEPoolsApi New-PVEPools POST /pools Create new pool.
PVEPoolsApi Remove-PVEPools DELETE /pools Delete pool.
PVEPoolsApi Remove-PVEPoolsByPoolid DELETE /pools/{poolid} Delete pool (deprecated, no support for nested pools, use 'DELETE /pools/?poolid={poolid}').
PVEPoolsApi Set-PVEPools PUT /pools Update pool.
PVEPoolsApi Set-PVEPoolsByPoolid PUT /pools/{poolid} Update pool data (deprecated, no support for nested pools - use 'PUT /pools/?poolid={poolid}' instead).
PVEStorageApi Get-PVEStorage GET /storage Storage index.
PVEStorageApi Get-PVEStorageByStorage GET /storage/{storage} Read storage configuration.
PVEStorageApi New-PVEStorage POST /storage Create a new storage.
PVEStorageApi Remove-PVEStorageByStorage DELETE /storage/{storage} Delete storage configuration.
PVEStorageApi Set-PVEStorageByStorage PUT /storage/{storage} Update storage configuration.
PVEVersionApi Get-PVEVersion GET /version API version details, including some parts of the global datacenter config.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

About

A generated Powershell module to access a local proxmox pve api.

Resources

Readme

License

GPL-3.0 license

Code of conduct

Code of conduct

Contributing

Contributing
Activity

Stars

7 stars

Watchers

2 watching

Forks

2 forks
Report repository

Releases 5

9.1.1 Latest
Nov 21, 2025
+ 4 releases

Packages

No packages published

Contributors 2

  •  
  •  

Languages