diff --git a/src/PveClient.php b/src/PveClient.php index 5364f41..2012ab4 100644 --- a/src/PveClient.php +++ b/src/PveClient.php @@ -2999,7 +2999,7 @@ public function index($type = null) { * @param string $type ACME challenge type. * Enum: dns,standalone * @param string $api API plugin name - * Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,arvan,aurora,autodns,aws,azion,azure,cf,clouddns,cloudns,cn,conoha,constellix,cx,cyon,da,ddnss,desec,df,dgon,dnsimple,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,freedns,gandi_livedns,gcloud,gd,gdnsdk,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ispconfig,jd,joker,kappernet,kas,kinghost,knot,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,namecheap,namecom,namesilo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rcode0,regru,scaleway,schlundtech,selectel,servercow,simply,tele3,transip,ultra,unoeuro,variomedia,veesp,vscale,vultr,websupport,world4you,yandex,zilore,zone,zonomi + * Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,arvan,aurora,autodns,aws,azion,azure,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gd,geoscaling,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi * @param string $data DNS plugin data. (base64 encoded) * @param bool $disable Flag to disable the config. * @param string $nodes List of cluster node names. @@ -3062,7 +3062,7 @@ public function getPluginConfig() { /** * Update ACME plugin configuration. * @param string $api API plugin name - * Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,arvan,aurora,autodns,aws,azion,azure,cf,clouddns,cloudns,cn,conoha,constellix,cx,cyon,da,ddnss,desec,df,dgon,dnsimple,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,freedns,gandi_livedns,gcloud,gd,gdnsdk,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ispconfig,jd,joker,kappernet,kas,kinghost,knot,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,namecheap,namecom,namesilo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rcode0,regru,scaleway,schlundtech,selectel,servercow,simply,tele3,transip,ultra,unoeuro,variomedia,veesp,vscale,vultr,websupport,world4you,yandex,zilore,zone,zonomi + * Enum: 1984hosting,acmedns,acmeproxy,active24,ad,ali,anx,arvan,aurora,autodns,aws,azion,azure,bunny,cf,clouddns,cloudns,cn,conoha,constellix,cpanel,curanet,cyon,da,ddnss,desec,df,dgon,dnshome,dnsimple,dnsservices,do,doapi,domeneshop,dp,dpi,dreamhost,duckdns,durabledns,dyn,dynu,dynv6,easydns,edgedns,euserv,exoscale,fornex,freedns,gandi_livedns,gcloud,gd,geoscaling,he,hetzner,hexonet,hostingde,huaweicloud,infoblox,infomaniak,internetbs,inwx,ionos,ispconfig,jd,joker,kappernet,kas,kinghost,knot,la,leaseweb,lexicon,linode,linode_v4,loopia,lua,maradns,me,miab,misaka,myapi,mydevil,mydnsjp,mythic_beasts,namecheap,namecom,namesilo,nederhost,neodigit,netcup,netlify,nic,njalla,nm,nsd,nsone,nsupdate,nw,oci,one,online,openprovider,openstack,opnsense,ovh,pdns,pleskxml,pointhq,porkbun,rackcorp,rackspace,rage4,rcode0,regru,scaleway,schlundtech,selectel,selfhost,servercow,simply,tele3,transip,udr,ultra,unoeuro,variomedia,veesp,vercel,vscale,vultr,websupport,world4you,yandex,yc,zilore,zone,zonomi * @param string $data DNS plugin data. (base64 encoded) * @param string $delete A list of settings you want to delete. * @param string $digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. @@ -4690,6 +4690,7 @@ public function getOptions() { * @param string $migration For cluster wide migration settings. * @param bool $migration_unsecure Migration is secure using SSH tunnel by default. For secure private networks you can disable it to speed up migration. Deprecated, use the 'migration' property instead! * @param string $next_id Control the range for the free VMID auto-selection pool. + * @param string $notify Cluster-wide notification settings. * @param string $registered_tags A list of tags that require a `Sys.Modify` on '/' to set and delete. Tags set here that are also in 'user-tag-access' also require `Sys.Modify`. * @param string $tag_style Tag style options. * @param string $u2f u2f @@ -4697,7 +4698,7 @@ public function getOptions() { * @param string $webauthn webauthn configuration * @return Result */ - public function setOptions($bwlimit = null, $console = null, $crs = null, $delete = null, $description = null, $email_from = null, $fencing = null, $ha = null, $http_proxy = null, $keyboard = null, $language = null, $mac_prefix = null, $max_workers = null, $migration = null, $migration_unsecure = null, $next_id = null, $registered_tags = null, $tag_style = null, $u2f = null, $user_tag_access = null, $webauthn = null) { + public function setOptions($bwlimit = null, $console = null, $crs = null, $delete = null, $description = null, $email_from = null, $fencing = null, $ha = null, $http_proxy = null, $keyboard = null, $language = null, $mac_prefix = null, $max_workers = null, $migration = null, $migration_unsecure = null, $next_id = null, $notify = null, $registered_tags = null, $tag_style = null, $u2f = null, $user_tag_access = null, $webauthn = null) { $params = ['bwlimit' => $bwlimit, 'console' => $console, 'crs' => $crs, @@ -4714,6 +4715,7 @@ public function setOptions($bwlimit = null, $console = null, $crs = null, $delet 'migration' => $migration, 'migration_unsecure' => $migration_unsecure, 'next-id' => $next_id, + 'notify' => $notify, 'registered-tags' => $registered_tags, 'tag-style' => $tag_style, 'u2f' => $u2f, @@ -5434,14 +5436,14 @@ public function vmlist($full = null) { * @param int $vmid The (unique) ID of the VM. * @param bool $acpi Enable/disable ACPI. * @param string $affinity List of host cores used to execute guest processes, for example: 0,5,8-11 - * @param string $agent Enable/disable communication with the Qemu Guest Agent and its properties. + * @param string $agent Enable/disable communication with the QEMU Guest Agent and its properties. * @param string $arch Virtual processor architecture. Defaults to the host. * Enum: x86_64,aarch64 * @param string $archive The backup archive. Either the file system path to a .tar or .vma file (use '-' to pipe data from stdin) or a proxmox storage backup volume identifier. * @param string $args Arbitrary arguments passed to kvm. * @param string $audio0 Configure a audio device, useful in combination with QXL/Spice. * @param bool $autostart Automatic restart after crash (currently ignored). - * @param int $balloon Amount of target RAM for the VM in MB. Using zero disables the ballon driver. + * @param int $balloon Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. * @param string $bios Select BIOS implementation. * Enum: seabios,ovmf * @param string $boot Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. @@ -5458,7 +5460,7 @@ public function vmlist($full = null) { * @param float $cpulimit Limit of CPU usage. * @param int $cpuunits CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. * @param string $description Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. - * @param string $efidisk0 Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. + * @param string $efidisk0 Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. * @param bool $force Allow to overwrite existing VM. * @param bool $freeze Freeze CPU at startup (use 'c' monitor command to start execution). * @param string $hookscript Script that will be executed during various steps in the vms lifetime. @@ -5477,8 +5479,8 @@ public function vmlist($full = null) { * @param bool $localtime Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. * @param string $lock Lock/unlock the VM. * Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended - * @param string $machine Specifies the Qemu machine type. - * @param int $memory Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. + * @param string $machine Specifies the QEMU machine type. + * @param int $memory Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. * @param float $migrate_downtime Set maximum tolerated downtime (in seconds) for migrations. * @param int $migrate_speed Set maximum speed (in MB/s) for migrations. Value 0 is no limit. * @param string $name Set a name for the VM. Only used on the configuration web interface. @@ -6765,12 +6767,16 @@ function __construct($client, $node, $vmid) { /** * Read firewall log * @param int $limit + * @param int $since Display log since this UNIX epoch. * @param int $start + * @param int $until Display log until this UNIX epoch. * @return Result */ - public function log($limit = null, $start = null) { + public function log($limit = null, $since = null, $start = null, $until = null) { $params = ['limit' => $limit, - 'start' => $start]; + 'since' => $since, + 'start' => $start, + 'until' => $until]; return $this->client->get("/nodes/{$this->node}/qemu/{$this->vmid}/firewall/log", $params); } @@ -7175,7 +7181,7 @@ public function getFileWrite() { } /** - * Qemu Agent command index. + * QEMU Guest Agent command index. * @return Result */ public function index() { @@ -7183,7 +7189,7 @@ public function index() { } /** - * Execute Qemu Guest Agent commands. + * Execute QEMU Guest Agent commands. * @param string $command The QGA command. * Enum: fsfreeze-freeze,fsfreeze-status,fsfreeze-thaw,fstrim,get-fsinfo,get-host-name,get-memory-block-info,get-memory-blocks,get-osinfo,get-time,get-timezone,get-users,get-vcpus,info,network-get-interfaces,ping,shutdown,suspend-disk,suspend-hybrid,suspend-ram * @return Result @@ -8355,14 +8361,14 @@ public function vmConfig($current = null, $snapshot = null) { * Set virtual machine options (asynchrounous API). * @param bool $acpi Enable/disable ACPI. * @param string $affinity List of host cores used to execute guest processes, for example: 0,5,8-11 - * @param string $agent Enable/disable communication with the Qemu Guest Agent and its properties. + * @param string $agent Enable/disable communication with the QEMU Guest Agent and its properties. * @param string $arch Virtual processor architecture. Defaults to the host. * Enum: x86_64,aarch64 * @param string $args Arbitrary arguments passed to kvm. * @param string $audio0 Configure a audio device, useful in combination with QXL/Spice. * @param bool $autostart Automatic restart after crash (currently ignored). * @param int $background_delay Time to wait for the task to finish. We return 'null' if the task finish within that time. - * @param int $balloon Amount of target RAM for the VM in MB. Using zero disables the ballon driver. + * @param int $balloon Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. * @param string $bios Select BIOS implementation. * Enum: seabios,ovmf * @param string $boot Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. @@ -8380,7 +8386,7 @@ public function vmConfig($current = null, $snapshot = null) { * @param string $delete A list of settings you want to delete. * @param string $description Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. * @param string $digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. - * @param string $efidisk0 Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. + * @param string $efidisk0 Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. * @param bool $force Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. * @param bool $freeze Freeze CPU at startup (use 'c' monitor command to start execution). * @param string $hookscript Script that will be executed during various steps in the vms lifetime. @@ -8398,8 +8404,8 @@ public function vmConfig($current = null, $snapshot = null) { * @param bool $localtime Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. * @param string $lock Lock/unlock the VM. * Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended - * @param string $machine Specifies the Qemu machine type. - * @param int $memory Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. + * @param string $machine Specifies the QEMU machine type. + * @param int $memory Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. * @param float $migrate_downtime Set maximum tolerated downtime (in seconds) for migrations. * @param int $migrate_speed Set maximum speed (in MB/s) for migrations. Value 0 is no limit. * @param string $name Set a name for the VM. Only used on the configuration web interface. @@ -8535,13 +8541,13 @@ public function updateVmAsync($acpi = null, $affinity = null, $agent = null, $ar * Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation. * @param bool $acpi Enable/disable ACPI. * @param string $affinity List of host cores used to execute guest processes, for example: 0,5,8-11 - * @param string $agent Enable/disable communication with the Qemu Guest Agent and its properties. + * @param string $agent Enable/disable communication with the QEMU Guest Agent and its properties. * @param string $arch Virtual processor architecture. Defaults to the host. * Enum: x86_64,aarch64 * @param string $args Arbitrary arguments passed to kvm. * @param string $audio0 Configure a audio device, useful in combination with QXL/Spice. * @param bool $autostart Automatic restart after crash (currently ignored). - * @param int $balloon Amount of target RAM for the VM in MB. Using zero disables the ballon driver. + * @param int $balloon Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. * @param string $bios Select BIOS implementation. * Enum: seabios,ovmf * @param string $boot Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. @@ -8559,7 +8565,7 @@ public function updateVmAsync($acpi = null, $affinity = null, $agent = null, $ar * @param string $delete A list of settings you want to delete. * @param string $description Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. * @param string $digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. - * @param string $efidisk0 Configure a Disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. + * @param string $efidisk0 Configure a disk for storing EFI vars. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and that the default EFI vars are copied to the volume instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. * @param bool $force Force physical removal. Without this, we simple remove the disk from the config file and create an additional configuration entry called 'unused[n]', which contains the volume ID. Unlink of unused[n] always cause physical removal. * @param bool $freeze Freeze CPU at startup (use 'c' monitor command to start execution). * @param string $hookscript Script that will be executed during various steps in the vms lifetime. @@ -8577,8 +8583,8 @@ public function updateVmAsync($acpi = null, $affinity = null, $agent = null, $ar * @param bool $localtime Set the real time clock (RTC) to local time. This is enabled by default if the `ostype` indicates a Microsoft Windows OS. * @param string $lock Lock/unlock the VM. * Enum: backup,clone,create,migrate,rollback,snapshot,snapshot-delete,suspending,suspended - * @param string $machine Specifies the Qemu machine type. - * @param int $memory Amount of RAM for the VM in MB. This is the maximum available memory when you use the balloon device. + * @param string $machine Specifies the QEMU machine type. + * @param int $memory Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. * @param float $migrate_downtime Set maximum tolerated downtime (in seconds) for migrations. * @param int $migrate_speed Set maximum speed (in MB/s) for migrations. Value 0 is no limit. * @param string $name Set a name for the VM. Only used on the configuration web interface. @@ -9289,7 +9295,7 @@ function __construct($client, $node, $vmid) { /** * Start virtual machine. * @param string $force_cpu Override QEMU's -cpu argument with the given string. - * @param string $machine Specifies the Qemu machine type. + * @param string $machine Specifies the QEMU machine type. * @param string $migratedfrom The cluster node name. * @param string $migration_network CIDR of the (sub) network that is used for migration. * @param string $migration_type Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. @@ -9948,7 +9954,7 @@ function __construct($client, $node, $vmid) { } /** - * Execute Qemu monitor commands. + * Execute QEMU monitor commands. * @param string $command The monitor command. * @return Result */ @@ -10247,7 +10253,7 @@ function __construct($client, $node, $vmid, $snapname) { /** * Rollback VM state to specified snapshot. - * @param bool $start Whether the VM should get started after rolling back successfully + * @param bool $start Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.) * @return Result */ public function rollback($start = null) { @@ -10434,7 +10440,7 @@ public function vmlist() { * @param string $ostemplate The OS template or backup file. * @param int $vmid The (unique) ID of the VM. * @param string $arch OS architecture type. - * Enum: amd64,i386,arm64,armhf + * Enum: amd64,i386,arm64,armhf,riscv32,riscv64 * @param float $bwlimit Override I/O bandwidth limit (in KiB/s). * @param string $cmode Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). * Enum: shell,console,tty @@ -10884,7 +10890,7 @@ public function vmConfig($current = null, $snapshot = null) { /** * Set container options. * @param string $arch OS architecture type. - * Enum: amd64,i386,arm64,armhf + * Enum: amd64,i386,arm64,armhf,riscv32,riscv64 * @param string $cmode Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login). * Enum: shell,console,tty * @param bool $console Attach a console device (/dev/console) to the container. @@ -12398,12 +12404,16 @@ function __construct($client, $node, $vmid) { /** * Read firewall log * @param int $limit + * @param int $since Display log since this UNIX epoch. * @param int $start + * @param int $until Display log until this UNIX epoch. * @return Result */ - public function log($limit = null, $start = null) { + public function log($limit = null, $since = null, $start = null, $until = null) { $params = ['limit' => $limit, - 'start' => $start]; + 'since' => $since, + 'start' => $start, + 'until' => $until]; return $this->client->get("/nodes/{$this->node}/lxc/{$this->vmid}/firewall/log", $params); } @@ -13228,6 +13238,19 @@ function __construct($client, $node) { $this->node = $node; } + /** + * @ignore + */ + private $cfg; + + /** + * Get CephNodeNodesCfg + * @return PVECephNodeNodesCfg + */ + public function getCfg() { + return $this->cfg ?: ($this->cfg = new PVECephNodeNodesCfg($this->client, $this->node)); + } + /** * @ignore */ @@ -13293,6 +13316,19 @@ public function getFs() { return $this->fs ?: ($this->fs = new PVECephNodeNodesFs($this->client, $this->node)); } + /** + * @ignore + */ + private $pool; + + /** + * Get CephNodeNodesPool + * @return PVECephNodeNodesPool + */ + public function getPool() { + return $this->pool ?: ($this->pool = new PVECephNodeNodesPool($this->client, $this->node)); + } + /** * @ignore */ @@ -13459,6 +13495,134 @@ public function index() { } + /** + * Class PVECephNodeNodesCfg + * @package Corsinvest\VE\ProxmoxVE\Api + */ + class PVECephNodeNodesCfg { + + /** + * @ignore + */ + private $node; + + /** + * @ignore + */ + private $client; + + /** + * @ignore + */ + function __construct($client, $node) { + $this->client = $client; + $this->node = $node; + } + + /** + * @ignore + */ + private $raw; + + /** + * Get CfgCephNodeNodesRaw + * @return PVECfgCephNodeNodesRaw + */ + public function getRaw() { + return $this->raw ?: ($this->raw = new PVECfgCephNodeNodesRaw($this->client, $this->node)); + } + + /** + * @ignore + */ + private $db; + + /** + * Get CfgCephNodeNodesDb + * @return PVECfgCephNodeNodesDb + */ + public function getDb() { + return $this->db ?: ($this->db = new PVECfgCephNodeNodesDb($this->client, $this->node)); + } + + /** + * Directory index. + * @return Result + */ + public function index() { + return $this->client->get("/nodes/{$this->node}/ceph/cfg"); + } + + } + + /** + * Class PVECfgCephNodeNodesRaw + * @package Corsinvest\VE\ProxmoxVE\Api + */ + class PVECfgCephNodeNodesRaw { + + /** + * @ignore + */ + private $node; + + /** + * @ignore + */ + private $client; + + /** + * @ignore + */ + function __construct($client, $node) { + $this->client = $client; + $this->node = $node; + } + + /** + * Get the Ceph configuration file. + * @return Result + */ + public function raw() { + return $this->client->get("/nodes/{$this->node}/ceph/cfg/raw"); + } + + } + + /** + * Class PVECfgCephNodeNodesDb + * @package Corsinvest\VE\ProxmoxVE\Api + */ + class PVECfgCephNodeNodesDb { + + /** + * @ignore + */ + private $node; + + /** + * @ignore + */ + private $client; + + /** + * @ignore + */ + function __construct($client, $node) { + $this->client = $client; + $this->node = $node; + } + + /** + * Get the Ceph configuration database. + * @return Result + */ + public function db() { + return $this->client->get("/nodes/{$this->node}/ceph/cfg/db"); + } + + } + /** * Class PVECephNodeNodesOsd * @package Corsinvest\VE\ProxmoxVE\Api @@ -13554,6 +13718,32 @@ function __construct($client, $node, $osdid) { $this->osdid = $osdid; } + /** + * @ignore + */ + private $metadata; + + /** + * Get OsdidOsdCephNodeNodesMetadata + * @return PVEOsdidOsdCephNodeNodesMetadata + */ + public function getMetadata() { + return $this->metadata ?: ($this->metadata = new PVEOsdidOsdCephNodeNodesMetadata($this->client, $this->node, $this->osdid)); + } + + /** + * @ignore + */ + private $lvInfo; + + /** + * Get OsdidOsdCephNodeNodesLvInfo + * @return PVEOsdidOsdCephNodeNodesLvInfo + */ + public function getLvInfo() { + return $this->lvInfo ?: ($this->lvInfo = new PVEOsdidOsdCephNodeNodesLvInfo($this->client, $this->node, $this->osdid)); + } + /** * @ignore */ @@ -13603,6 +13793,97 @@ public function destroyosd($cleanup = null) { return $this->client->delete("/nodes/{$this->node}/ceph/osd/{$this->osdid}", $params); } + /** + * OSD index. + * @return Result + */ + public function osdindex() { + return $this->client->get("/nodes/{$this->node}/ceph/osd/{$this->osdid}"); + } + + } + + /** + * Class PVEOsdidOsdCephNodeNodesMetadata + * @package Corsinvest\VE\ProxmoxVE\Api + */ + class PVEOsdidOsdCephNodeNodesMetadata { + + /** + * @ignore + */ + private $node; + + /** + * @ignore + */ + private $osdid; + + /** + * @ignore + */ + private $client; + + /** + * @ignore + */ + function __construct($client, $node, $osdid) { + $this->client = $client; + $this->node = $node; + $this->osdid = $osdid; + } + + /** + * Get OSD details + * @return Result + */ + public function osddetails() { + return $this->client->get("/nodes/{$this->node}/ceph/osd/{$this->osdid}/metadata"); + } + + } + + /** + * Class PVEOsdidOsdCephNodeNodesLvInfo + * @package Corsinvest\VE\ProxmoxVE\Api + */ + class PVEOsdidOsdCephNodeNodesLvInfo { + + /** + * @ignore + */ + private $node; + + /** + * @ignore + */ + private $osdid; + + /** + * @ignore + */ + private $client; + + /** + * @ignore + */ + function __construct($client, $node, $osdid) { + $this->client = $client; + $this->node = $node; + $this->osdid = $osdid; + } + + /** + * Get OSD volume details + * @param string $type OSD device type + * Enum: block,db,wal + * @return Result + */ + public function osdvolume($type = null) { + $params = ['type' => $type]; + return $this->client->get("/nodes/{$this->node}/ceph/osd/{$this->osdid}/lv-info", $params); + } + } /** @@ -14091,6 +14372,220 @@ public function createfs($add_storage = null, $pg_num = null) { } + /** + * Class PVECephNodeNodesPool + * @package Corsinvest\VE\ProxmoxVE\Api + */ + class PVECephNodeNodesPool { + + /** + * @ignore + */ + private $node; + + /** + * @ignore + */ + private $client; + + /** + * @ignore + */ + function __construct($client, $node) { + $this->client = $client; + $this->node = $node; + } + + /** + * Get ItemPoolCephNodeNodesName + * @param name + * @return PVEItemPoolCephNodeNodesName + */ + public function get($name) { + return new PVEItemPoolCephNodeNodesName($this->client, $this->node, $name); + } + + /** + * List all pools and their settings (which are settable by the POST/PUT endpoints). + * @return Result + */ + public function lspools() { + return $this->client->get("/nodes/{$this->node}/ceph/pool"); + } + + /** + * Create Ceph pool + * @param string $name The name of the pool. It must be unique. + * @param bool $add_storages Configure VM and CT storage using the new pool. + * @param string $application The application of the pool. + * Enum: rbd,cephfs,rgw + * @param string $crush_rule The rule to use for mapping object placement in the cluster. + * @param string $erasure_coding Create an erasure coded pool for RBD with an accompaning replicated pool for metadata storage. With EC, the common ceph options 'size', 'min_size' and 'crush_rule' parameters will be applied to the metadata pool. + * @param int $min_size Minimum number of replicas per object + * @param string $pg_autoscale_mode The automatic PG scaling mode of the pool. + * Enum: on,off,warn + * @param int $pg_num Number of placement groups. + * @param int $pg_num_min Minimal number of placement groups. + * @param int $size Number of replicas per object + * @param string $target_size The estimated target size of the pool for the PG autoscaler. + * @param float $target_size_ratio The estimated target ratio of the pool for the PG autoscaler. + * @return Result + */ + public function createpool($name, $add_storages = null, $application = null, $crush_rule = null, $erasure_coding = null, $min_size = null, $pg_autoscale_mode = null, $pg_num = null, $pg_num_min = null, $size = null, $target_size = null, $target_size_ratio = null) { + $params = ['name' => $name, + 'add_storages' => $add_storages, + 'application' => $application, + 'crush_rule' => $crush_rule, + 'erasure-coding' => $erasure_coding, + 'min_size' => $min_size, + 'pg_autoscale_mode' => $pg_autoscale_mode, + 'pg_num' => $pg_num, + 'pg_num_min' => $pg_num_min, + 'size' => $size, + 'target_size' => $target_size, + 'target_size_ratio' => $target_size_ratio]; + return $this->client->create("/nodes/{$this->node}/ceph/pool", $params); + } + + } + + /** + * Class PVEItemPoolCephNodeNodesName + * @package Corsinvest\VE\ProxmoxVE\Api + */ + class PVEItemPoolCephNodeNodesName { + + /** + * @ignore + */ + private $node; + + /** + * @ignore + */ + private $name; + + /** + * @ignore + */ + private $client; + + /** + * @ignore + */ + function __construct($client, $node, $name) { + $this->client = $client; + $this->node = $node; + $this->name = $name; + } + + /** + * @ignore + */ + private $status; + + /** + * Get NamePoolCephNodeNodesStatus + * @return PVENamePoolCephNodeNodesStatus + */ + public function getStatus() { + return $this->status ?: ($this->status = new PVENamePoolCephNodeNodesStatus($this->client, $this->node, $this->name)); + } + + /** + * Destroy pool + * @param bool $force If true, destroys pool even if in use + * @param bool $remove_ecprofile Remove the erasure code profile. Defaults to true, if applicable. + * @param bool $remove_storages Remove all pveceph-managed storages configured for this pool + * @return Result + */ + public function destroypool($force = null, $remove_ecprofile = null, $remove_storages = null) { + $params = ['force' => $force, + 'remove_ecprofile' => $remove_ecprofile, + 'remove_storages' => $remove_storages]; + return $this->client->delete("/nodes/{$this->node}/ceph/pool/{$this->name}", $params); + } + + /** + * Pool index. + * @return Result + */ + public function poolindex() { + return $this->client->get("/nodes/{$this->node}/ceph/pool/{$this->name}"); + } + + /** + * Change POOL settings + * @param string $application The application of the pool. + * Enum: rbd,cephfs,rgw + * @param string $crush_rule The rule to use for mapping object placement in the cluster. + * @param int $min_size Minimum number of replicas per object + * @param string $pg_autoscale_mode The automatic PG scaling mode of the pool. + * Enum: on,off,warn + * @param int $pg_num Number of placement groups. + * @param int $pg_num_min Minimal number of placement groups. + * @param int $size Number of replicas per object + * @param string $target_size The estimated target size of the pool for the PG autoscaler. + * @param float $target_size_ratio The estimated target ratio of the pool for the PG autoscaler. + * @return Result + */ + public function setpool($application = null, $crush_rule = null, $min_size = null, $pg_autoscale_mode = null, $pg_num = null, $pg_num_min = null, $size = null, $target_size = null, $target_size_ratio = null) { + $params = ['application' => $application, + 'crush_rule' => $crush_rule, + 'min_size' => $min_size, + 'pg_autoscale_mode' => $pg_autoscale_mode, + 'pg_num' => $pg_num, + 'pg_num_min' => $pg_num_min, + 'size' => $size, + 'target_size' => $target_size, + 'target_size_ratio' => $target_size_ratio]; + return $this->client->set("/nodes/{$this->node}/ceph/pool/{$this->name}", $params); + } + + } + + /** + * Class PVENamePoolCephNodeNodesStatus + * @package Corsinvest\VE\ProxmoxVE\Api + */ + class PVENamePoolCephNodeNodesStatus { + + /** + * @ignore + */ + private $node; + + /** + * @ignore + */ + private $name; + + /** + * @ignore + */ + private $client; + + /** + * @ignore + */ + function __construct($client, $node, $name) { + $this->client = $client; + $this->node = $node; + $this->name = $name; + } + + /** + * Show the current pool status. + * @param bool $verbose If enabled, will display additional data(eg. statistics). + * @return Result + */ + public function getpool($verbose = null) { + $params = ['verbose' => $verbose]; + return $this->client->get("/nodes/{$this->node}/ceph/pool/{$this->name}/status", $params); + } + + } + /** * Class PVECephNodeNodesPools * @package Corsinvest\VE\ProxmoxVE\Api @@ -14125,7 +14620,7 @@ public function get($name) { } /** - * List all pools. + * List all pools. Deprecated, please use `/nodes/{node}/ceph/pool`. * @return Result */ public function lspools() { @@ -14133,7 +14628,7 @@ public function lspools() { } /** - * Create Ceph pool + * Create Ceph pool. Deprecated, please use `/nodes/{node}/ceph/pool`. * @param string $name The name of the pool. It must be unique. * @param bool $add_storages Configure VM and CT storage using the new pool. * @param string $application The application of the pool. @@ -14199,7 +14694,7 @@ function __construct($client, $node, $name) { } /** - * Destroy pool + * Destroy pool. Deprecated, please use `/nodes/{node}/ceph/pool/{name}`. * @param bool $force If true, destroys pool even if in use * @param bool $remove_ecprofile Remove the erasure code profile. Defaults to true, if applicable. * @param bool $remove_storages Remove all pveceph-managed storages configured for this pool @@ -14213,7 +14708,7 @@ public function destroypool($force = null, $remove_ecprofile = null, $remove_sto } /** - * List pool settings. + * List pool settings. Deprecated, please use `/nodes/{node}/ceph/pool/{pool}/status`. * @param bool $verbose If enabled, will display additional data(eg. statistics). * @return Result */ @@ -14223,7 +14718,7 @@ public function getpool($verbose = null) { } /** - * Change POOL settings + * Change POOL settings. Deprecated, please use `/nodes/{node}/ceph/pool/{name}`. * @param string $application The application of the pool. * Enum: rbd,cephfs,rgw * @param string $crush_rule The rule to use for mapping object placement in the cluster. @@ -14277,7 +14772,7 @@ function __construct($client, $node) { } /** - * Get Ceph configuration. + * Get the Ceph configuration file. Deprecated, please use `/nodes/{node}/ceph/cfg/raw. * @return Result */ public function config() { @@ -14311,7 +14806,7 @@ function __construct($client, $node) { } /** - * Get Ceph configuration database. + * Get the Ceph configuration database. Deprecated, please use `/nodes/{node}/ceph/cfg/db. * @return Result */ public function configdb() { @@ -15669,12 +16164,14 @@ function __construct($client, $node, $upid) { /** * Read task log. - * @param int $limit The maximum amount of lines that should be printed. - * @param int $start The line number to start printing at. + * @param bool $download Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters + * @param int $limit The amount of lines to read from the tasklog. + * @param int $start Start at this line when reading the tasklog * @return Result */ - public function readTaskLog($limit = null, $start = null) { - $params = ['limit' => $limit, + public function readTaskLog($download = null, $limit = null, $start = null) { + $params = ['download' => $download, + 'limit' => $limit, 'start' => $start]; return $this->client->get("/nodes/{$this->node}/tasks/{$this->upid}/log", $params); } @@ -18637,6 +19134,7 @@ public function getOptions() { * @param bool $log_nf_conntrack Enable logging of conntrack information. * @param bool $ndp Enable NDP (Neighbor Discovery Protocol). * @param bool $nf_conntrack_allow_invalid Allow invalid packets on connection tracking. + * @param string $nf_conntrack_helpers Enable conntrack helpers for specific protocols. Supported protocols: amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp * @param int $nf_conntrack_max Maximum number of tracked connections. * @param int $nf_conntrack_tcp_timeout_established Conntrack established timeout. * @param int $nf_conntrack_tcp_timeout_syn_recv Conntrack syn recv timeout. @@ -18651,7 +19149,7 @@ public function getOptions() { * @param bool $tcpflags Filter illegal combinations of TCP flags. * @return Result */ - public function setOptions($delete = null, $digest = null, $enable = null, $log_level_in = null, $log_level_out = null, $log_nf_conntrack = null, $ndp = null, $nf_conntrack_allow_invalid = null, $nf_conntrack_max = null, $nf_conntrack_tcp_timeout_established = null, $nf_conntrack_tcp_timeout_syn_recv = null, $nosmurfs = null, $protection_synflood = null, $protection_synflood_burst = null, $protection_synflood_rate = null, $smurf_log_level = null, $tcp_flags_log_level = null, $tcpflags = null) { + public function setOptions($delete = null, $digest = null, $enable = null, $log_level_in = null, $log_level_out = null, $log_nf_conntrack = null, $ndp = null, $nf_conntrack_allow_invalid = null, $nf_conntrack_helpers = null, $nf_conntrack_max = null, $nf_conntrack_tcp_timeout_established = null, $nf_conntrack_tcp_timeout_syn_recv = null, $nosmurfs = null, $protection_synflood = null, $protection_synflood_burst = null, $protection_synflood_rate = null, $smurf_log_level = null, $tcp_flags_log_level = null, $tcpflags = null) { $params = ['delete' => $delete, 'digest' => $digest, 'enable' => $enable, @@ -18660,6 +19158,7 @@ public function setOptions($delete = null, $digest = null, $enable = null, $log_ 'log_nf_conntrack' => $log_nf_conntrack, 'ndp' => $ndp, 'nf_conntrack_allow_invalid' => $nf_conntrack_allow_invalid, + 'nf_conntrack_helpers' => $nf_conntrack_helpers, 'nf_conntrack_max' => $nf_conntrack_max, 'nf_conntrack_tcp_timeout_established' => $nf_conntrack_tcp_timeout_established, 'nf_conntrack_tcp_timeout_syn_recv' => $nf_conntrack_tcp_timeout_syn_recv, @@ -18702,12 +19201,16 @@ function __construct($client, $node) { /** * Read firewall log * @param int $limit + * @param int $since Display log since this UNIX epoch. * @param int $start + * @param int $until Display log until this UNIX epoch. * @return Result */ - public function log($limit = null, $start = null) { + public function log($limit = null, $since = null, $start = null, $until = null) { $params = ['limit' => $limit, - 'start' => $start]; + 'since' => $since, + 'start' => $start, + 'until' => $until]; return $this->client->get("/nodes/{$this->node}/firewall/log", $params); } @@ -19843,7 +20346,7 @@ function __construct($client, $node) { /** * Creates a VNC Shell proxy. * @param string $cmd Run specific command or default to login. - * Enum: ceph_install,login,upgrade + * Enum: ceph_install,upgrade,login * @param string $cmd_opts Add parameters to a command. Encoded as null terminated strings. * @param int $height sets the height of the console in pixels. * @param bool $websocket use websocket instead of standard vnc. @@ -19888,7 +20391,7 @@ function __construct($client, $node) { /** * Creates a VNC Shell proxy. * @param string $cmd Run specific command or default to login. - * Enum: ceph_install,login,upgrade + * Enum: ceph_install,upgrade,login * @param string $cmd_opts Add parameters to a command. Encoded as null terminated strings. * @return Result */ @@ -19965,7 +20468,7 @@ function __construct($client, $node) { /** * Creates a SPICE shell. * @param string $cmd Run specific command or default to login. - * Enum: ceph_install,login,upgrade + * Enum: ceph_install,upgrade,login * @param string $cmd_opts Add parameters to a command. Encoded as null terminated strings. * @param string $proxy SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As reasonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI). * @return Result @@ -20255,11 +20758,15 @@ function __construct($client, $node) { /** * Stop all VMs and Containers. + * @param bool $force_stop Force a hard-stop after the timeout. + * @param int $timeout Timeout for each guest shutdown task. Depending on `force-stop`, the shutdown gets then simply aborted or a hard-stop is forced. * @param string $vms Only consider Guests with these IDs. * @return Result */ - public function stopall($vms = null) { - $params = ['vms' => $vms]; + public function stopall($force_stop = null, $timeout = null, $vms = null) { + $params = ['force-stop' => $force_stop, + 'timeout' => $timeout, + 'vms' => $vms]; return $this->client->create("/nodes/{$this->node}/stopall", $params); } @@ -20292,7 +20799,7 @@ function __construct($client, $node) { /** * Migrate all VMs and Containers. * @param string $target Target node. - * @param int $maxworkers Maximal number of parallel migration job. If not set use 'max_workers' from datacenter.cfg, one of both must be set! + * @param int $maxworkers Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set! * @param string $vms Only consider Guests with these IDs. * @param bool $with_local_disks Enable live storage migration for local disk * @return Result @@ -20403,6 +20910,7 @@ public function index($type = null) { * @param string $comstar_hg host group for comstar views * @param string $comstar_tg target group for comstar views * @param string $content Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. + * @param string $content_dirs Overrides for default content type directories. * @param string $data_pool Data Pool (for erasure coding only) * @param string $datastore Proxmox Backup Server datastore name. * @param bool $disable Flag to disable the storage. @@ -20457,7 +20965,7 @@ public function index($type = null) { * @param string $volume Glusterfs Volume. * @return Result */ - public function create($storage, $type, $authsupported = null, $base = null, $blocksize = null, $bwlimit = null, $comstar_hg = null, $comstar_tg = null, $content = null, $data_pool = null, $datastore = null, $disable = null, $domain = null, $encryption_key = null, $export = null, $fingerprint = null, $format = null, $fs_name = null, $fuse = null, $is_mountpoint = null, $iscsiprovider = null, $keyring = null, $krbd = null, $lio_tpg = null, $master_pubkey = null, $max_protected_backups = null, $maxfiles = null, $mkdir = null, $monhost = null, $mountpoint = null, $namespace = null, $nocow = null, $nodes = null, $nowritecache = null, $options = null, $password = null, $path = null, $pool = null, $port = null, $portal = null, $preallocation = null, $prune_backups = null, $saferemove = null, $saferemove_throughput = null, $server = null, $server2 = null, $share = null, $shared = null, $smbversion = null, $sparse = null, $subdir = null, $tagged_only = null, $target = null, $thinpool = null, $transport = null, $username = null, $vgname = null, $volume = null) { + public function create($storage, $type, $authsupported = null, $base = null, $blocksize = null, $bwlimit = null, $comstar_hg = null, $comstar_tg = null, $content = null, $content_dirs = null, $data_pool = null, $datastore = null, $disable = null, $domain = null, $encryption_key = null, $export = null, $fingerprint = null, $format = null, $fs_name = null, $fuse = null, $is_mountpoint = null, $iscsiprovider = null, $keyring = null, $krbd = null, $lio_tpg = null, $master_pubkey = null, $max_protected_backups = null, $maxfiles = null, $mkdir = null, $monhost = null, $mountpoint = null, $namespace = null, $nocow = null, $nodes = null, $nowritecache = null, $options = null, $password = null, $path = null, $pool = null, $port = null, $portal = null, $preallocation = null, $prune_backups = null, $saferemove = null, $saferemove_throughput = null, $server = null, $server2 = null, $share = null, $shared = null, $smbversion = null, $sparse = null, $subdir = null, $tagged_only = null, $target = null, $thinpool = null, $transport = null, $username = null, $vgname = null, $volume = null) { $params = ['storage' => $storage, 'type' => $type, 'authsupported' => $authsupported, @@ -20467,6 +20975,7 @@ public function create($storage, $type, $authsupported = null, $base = null, $bl 'comstar_hg' => $comstar_hg, 'comstar_tg' => $comstar_tg, 'content' => $content, + 'content-dirs' => $content_dirs, 'data-pool' => $data_pool, 'datastore' => $datastore, 'disable' => $disable, @@ -20568,6 +21077,7 @@ public function read() { * @param string $comstar_hg host group for comstar views * @param string $comstar_tg target group for comstar views * @param string $content Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. + * @param string $content_dirs Overrides for default content type directories. * @param string $data_pool Data Pool (for erasure coding only) * @param string $delete A list of settings you want to delete. * @param string $digest Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. @@ -20614,12 +21124,13 @@ public function read() { * @param string $username RBD Id. * @return Result */ - public function update($blocksize = null, $bwlimit = null, $comstar_hg = null, $comstar_tg = null, $content = null, $data_pool = null, $delete = null, $digest = null, $disable = null, $domain = null, $encryption_key = null, $fingerprint = null, $format = null, $fs_name = null, $fuse = null, $is_mountpoint = null, $keyring = null, $krbd = null, $lio_tpg = null, $master_pubkey = null, $max_protected_backups = null, $maxfiles = null, $mkdir = null, $monhost = null, $mountpoint = null, $namespace = null, $nocow = null, $nodes = null, $nowritecache = null, $options = null, $password = null, $pool = null, $port = null, $preallocation = null, $prune_backups = null, $saferemove = null, $saferemove_throughput = null, $server = null, $server2 = null, $shared = null, $smbversion = null, $sparse = null, $subdir = null, $tagged_only = null, $transport = null, $username = null) { + public function update($blocksize = null, $bwlimit = null, $comstar_hg = null, $comstar_tg = null, $content = null, $content_dirs = null, $data_pool = null, $delete = null, $digest = null, $disable = null, $domain = null, $encryption_key = null, $fingerprint = null, $format = null, $fs_name = null, $fuse = null, $is_mountpoint = null, $keyring = null, $krbd = null, $lio_tpg = null, $master_pubkey = null, $max_protected_backups = null, $maxfiles = null, $mkdir = null, $monhost = null, $mountpoint = null, $namespace = null, $nocow = null, $nodes = null, $nowritecache = null, $options = null, $password = null, $pool = null, $port = null, $preallocation = null, $prune_backups = null, $saferemove = null, $saferemove_throughput = null, $server = null, $server2 = null, $shared = null, $smbversion = null, $sparse = null, $subdir = null, $tagged_only = null, $transport = null, $username = null) { $params = ['blocksize' => $blocksize, 'bwlimit' => $bwlimit, 'comstar_hg' => $comstar_hg, 'comstar_tg' => $comstar_tg, 'content' => $content, + 'content-dirs' => $content_dirs, 'data-pool' => $data_pool, 'delete' => $delete, 'digest' => $digest, @@ -20865,7 +21376,7 @@ public function index($enabled = null, $full = null) { /** * Create new user. - * @param string $userid User ID + * @param string $userid Full User ID, in the `name@realm` format. * @param string $comment * @param string $email * @param bool $enable Enable the account (default). You can set this to '0' to disable the account @@ -21685,7 +22196,7 @@ function __construct($client, $realm) { * @param bool $enable_new Enable newly synced users immediately. * @param bool $full DEPRECATED: use 'remove-vanished' instead. If set, uses the LDAP Directory as source of truth, deleting users or groups not returned from the sync and removing all locally modified properties of synced users. If not set, only syncs information which is present in the synced data, and does not delete or modify anything else. * @param bool $purge DEPRECATED: use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync. - * @param string $remove_vanished A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible: 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. + * @param string $remove_vanished A semicolon-seperated list of things to remove when they or the user vanishes during a sync. The following values are possible: 'entry' removes the user/group when not returned from the sync. 'properties' removes the set properties on existing user/group that do not appear in the source (even custom ones). 'acl' removes acls when the user/group is not returned from the sync. Instead of a list it also can be 'none' (the default). * @param string $scope Select what to sync. * Enum: users,groups,both * @return Result @@ -22070,7 +22581,7 @@ function __construct($client) { /** * Change user password. * @param string $password The new password. - * @param string $userid User ID + * @param string $userid Full User ID, in the `name@realm` format. * @return Result */ public function changePassword($password, $userid) {