Enable StackStorm to interact with the Proxmox APIv2. Carlos nzlosh@yahoo.com
Actions are generated from the Proxmox API documentation which can be read directly from the local filesystem or via the Proxmox web interface. The pack has been generated against Proxmox v6.1 through to v8.0
Each Proxmox API version is stored as a git branch that corresponds to the version. Git tags are used to link the
API version to the pack version. The branch format is v<major>.<minor>
and the tag format is v<major>.<minor>_<pack_major>.<pack_minor>.<pack_patch>
The reasons for organising the code in such a way is to allow pack installations based on the Proxmox version and/or the pack version.
For an example: if someone operates Proxmox 7.2, they can install the pack from the latest release with the following command
st2 pack install https://github.com/nzlosh/stackstorm-proxmox=v7.2
The same person could also use the tag to get a specific version of the v7.2
branch with the tag.
st2 pack install https://github.com/nzlosh/stackstorm-proxmox=v7.2_v1.0.2
The recommended method to generate the pack is to create a Python virtual environment, install the
dependencies and run the generator. The generator code dependencies are defined in
gen-requirements.txt
which is found in the root directory of the repository.
- Get the pack
git clone <pack repository>
- Create a Python virtual environment
python -m venv <path to virtualenv>
- Activate the Python virtual environment.
activate <path to virtualenv>/bin/activate
- Install generator dependencies.
cd <pack repository>; pip install -r gen-requirements.txt
- Run code generator
cd <pack repository>/contrib; ./proxmox_pack_generator.py <your options>
- Deactivate Python virtual environment.
deactivate
The generator is located in the contrib
directory of the repository. It parses the apidoc.js
file to extract the available API method signatures. The generator accepts the api_source file in
the form of a local filesystem filename (e.g. /home/my_account/apidoc.js
) or a URL to Proxmox's
API root (e.g. https://my_proxmox.example.local:8006
)
$ ./proxmox_pack_generator.py -h
usage: proxmox_pack_generator.py [-h] [--username USERNAME]
[--password PASSWORD] [--realm REALM]
--pack_path PACK_PATH
api_source
Proxmox pack action generator.
positional arguments:
api_source Source of API documentation. Can be filename or url to
apidoc.
optional arguments:
-h, --help show this help message and exit
--username USERNAME Proxmox API username
--password PASSWORD Proxmox API password
--realm REALM Proxmox API authentication realm
--pack_path PACK_PATH
Path to pack where files will be written.
The Proxmox pack uses the notion of profiles to make it simple to target proxmox servers. Each action takes a profile_name variable that will use the connection information from the pack configuration for that action execution.
Below is an example that defines dev
, preprod
, prod
profiles and will default to the prod
profile
if no profile is supplied to the action execution.
default_profile: prod
profiles:
- host: proxmox.preprod.example.local
name: preprod
password: zzz
port: 8006
auth_realm: LDAP
username: proxmox_admin
verify_tls: true
- host: proxmox.example.local
name: prod
password: zzz
port: 8006
auth_realm: LDAP
username: proxmox_admin
verify_tls: true
- host: proxmox.dev.example.local
name: dev
password: yyy
port: 8006
auth_realm: pam
username: dev_user
verify_tls: false
The following options are required to be configured for the pack to work correctly.
Option | Type | Required | Secret | Description |
---|---|---|---|---|
default_profile |
string | True | The default profile to use in actions when none is given. | |
profiles |
array | True | A profile describing environment and credentials require to establish a connection. |
The pack provides the following actions:
Create new IPSet
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | IP set name. |
rename |
string | False | default | Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. |
profile_name |
string | False | default | The profile to use to run the action. |
Destroy a ZFS pool.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cleanup_config |
boolean | False | default | Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). |
cleanup_disks |
boolean | False | default | Also wipe disks so they can be repurposed afterwards. |
name |
string | True | default | The storage identifier. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Add a TFA entry for a user.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
description |
string | False | default | A description to distinguish multiple entries from one another |
enable |
boolean | False | default | Whether the entry should be enabled for login. |
prox_id |
string | True | default | A TFA entry id. |
password |
string | False | True | The current password. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Start all VMs and containers located on this node (by default only those with onboot=1).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | Issue start command even if virtual guest have 'onboot' not set or set to off. |
node |
string | True | default | The cluster node name. |
vms |
string | False | default | Only consider guests from this comma separated list of VMIDs. |
profile_name |
string | False | default | The profile to use to run the action. |
Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
socket |
string | True | default | unix socket to forward to |
ticket |
string | True | default | ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read cluster log
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_max |
integer | False | default | Maximum number of entries. |
profile_name |
string | False | default | The profile to use to run the action. |
Remove Hardware Mapping.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Get ACME plugin configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Unique identifier for ACME plugin instance. |
profile_name |
string | False | default | The profile to use to run the action. |
Unmounts the storage and removes the mount unit.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cleanup_config |
boolean | False | default | Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). |
cleanup_disks |
boolean | False | default | Also wipe disk so it can be repurposed afterwards. |
name |
string | True | default | The storage identifier. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Upload templates and ISO images.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
checksum |
string | False | default | The expected checksum of the file. |
checksum_algorithm |
string | False | default | The algorithm to calculate the checksum of the file. |
content |
string | True | default | Content type. |
filename |
string | True | default | The name of the file to create. Caution: This will be normalized! |
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage identifier. |
tmpfilename |
string | False | default | The source file name. This parameter is usually set by the REST handler. You can only overwrite it when connecting to the trusted port on localhost. |
profile_name |
string | False | default | The profile to use to run the action. |
Unlock a user's TFA authentication.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Change POOL settings
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
application |
string | False | default | The application of the pool. |
crush_rule |
string | False | default | The rule to use for mapping object placement in the cluster. |
min_size |
integer | False | default | Minimum number of replicas per object |
name |
string | True | default | The name of the pool. It must be unique. |
node |
string | True | default | The cluster node name. |
pg_autoscale_mode |
string | False | default | The automatic PG scaling mode of the pool. |
pg_num |
integer | False | default | Number of placement groups. |
pg_num_min |
integer | False | default | Minimal number of placement groups. |
size |
integer | False | default | Number of replicas per object |
target_size |
string | False | default | The estimated target size of the pool for the PG autoscaler. |
target_size_ratio |
number | False | default | The estimated target ratio of the pool for the PG autoscaler. |
profile_name |
string | False | default | The profile to use to run the action. |
Read sdn vnet configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
pending |
boolean | False | default | Display pending config. |
running |
boolean | False | default | Display running config. |
vnet |
string | True | default | The SDN vnet object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Executes the given command in the vm via the guest-agent and returns an object with the pid.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
command |
array | True | default | The command as a list of program + arguments. |
input_data |
string | False | default | Data to pass as 'input-data' to the guest. Usually treated as STDIN to 'command'. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get single rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
profile_name |
string | False | default | The profile to use to run the action. |
List aliases
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Get corosync totem protocol settings.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Get the content of /etc/hosts.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
List available macros
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
__
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
MGR directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
List rules.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get snapshot configuration
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create Ceph Metadata Server (MDS)
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
hotstandby |
boolean | False | default | Determines whether a ceph-mds daemon should poll and replay the log of an active MDS. Faster switch on MDS failure, but needs more idle resources. |
name |
string | False | default | The ID for the mds, when omitted the same as the nodename |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Instruct the OSD to scrub.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
deep |
boolean | False | default | If set, instructs a deep scrub instead of a normal one. |
node |
string | True | default | The cluster node name. |
osdid |
integer | True | default | OSD ID |
profile_name |
string | False | default | The profile to use to run the action. |
Update an existing role.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
append |
boolean | False | default | Description unavailable. |
privs |
string | False | default | Description unavailable. |
roleid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a Template.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
disk |
string | False | default | If you want to convert only 1 disk to base image. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
List ceph rules.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new sdn zone object.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
advertise_subnets |
boolean | False | default | Advertise evpn subnets if you have silent hosts |
bridge |
string | False | default | Description unavailable. |
bridge_disable_mac_learning |
boolean | False | default | Disable auto mac learning. |
controller |
string | False | default | Frr router name |
disable_arp_nd_suppression |
boolean | False | default | Disable ipv4 arp && ipv6 neighbour discovery suppression |
dns |
string | False | default | dns api server |
dnszone |
string | False | default | dns domain zone ex: mydomain.com |
dp_id |
integer | False | default | Faucet dataplane id |
exitnodes |
string | False | default | List of cluster node names. |
exitnodes_local_routing |
boolean | False | default | Allow exitnodes to connect to evpn guests |
exitnodes_primary |
string | False | default | Force traffic to this exitnode first. |
ipam |
string | False | default | use a specific ipam |
mac |
string | False | default | Anycast logical router mac address |
mtu |
integer | False | default | MTU |
nodes |
string | False | default | List of cluster node names. |
peers |
string | False | default | peers address list. |
reversedns |
string | False | default | reverse dns api server |
rt_import |
string | False | default | Route-Target import |
tag |
integer | False | default | Service-VLAN Tag |
prox_type |
string | True | default | Plugin type. |
vlan_protocol |
string | False | default | Description unavailable. |
vrf_vxlan |
integer | False | default | l3vni. |
vxlan_port |
integer | False | default | Vxlan tunnel udp port (default 4789). |
zone |
string | True | default | The SDN zone object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
List aliases
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete an authentication server.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
realm |
string | True | default | Authentication domain ID |
profile_name |
string | False | default | The profile to use to run the action. |
Read replication job configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. |
profile_name |
string | False | default | The profile to use to run the action. |
Gets the status of the given pid started by the guest-agent
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
pid |
integer | True | default | The PID to query |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Remove Hardware Mapping.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute get-timezone.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Index of hardware types
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Destroy Ceph Manager.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | The ID of the manager |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Start ceph services.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
service |
string | False | default | Ceph service name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read network device configuration
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
iface |
string | True | default | Network interface name. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Update sdn subnet object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dnszoneprefix |
string | False | default | dns domain zone prefix ex: 'adm' -> .adm.mydomain.com |
gateway |
string | False | default | Subnet Gateway: Will be assign on vnet for layer3 zones |
snat |
boolean | False | default | enable masquerade for this subnet if pve-firewall |
subnet |
string | True | default | The SDN subnet object identifier. |
vnet |
string | False | default | associated vnet |
profile_name |
string | False | default | The profile to use to run the action. |
Read task status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
upid |
string | True | default | The task's unique ID. |
profile_name |
string | False | default | The profile to use to run the action. |
__
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
upid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Update sdn controller object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
asn |
integer | False | default | autonomous system number |
bgp_multipath_as_path_relax |
boolean | False | default | Description unavailable. |
controller |
string | True | default | The SDN controller object identifier. |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
ebgp |
boolean | False | default | Enable ebgp. (remote-as external) |
ebgp_multihop |
integer | False | default | Description unavailable. |
loopback |
string | False | default | source loopback interface. |
node |
string | False | default | The cluster node name. |
peers |
string | False | default | peers address list. |
profile_name |
string | False | default | The profile to use to run the action. |
SDN ipams index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_type |
string | False | default | Only list sdn ipams of specific type |
profile_name |
string | False | default | The profile to use to run the action. |
Remove IP or Network from IPSet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | IP set name. |
profile_name |
string | False | default | The profile to use to run the action. |
List IPSet content
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | IP set name. |
profile_name |
string | False | default | The profile to use to run the action. |
Creates a TCP proxy connections.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
serial |
string | False | default | opens a serial terminal (defaults to display) |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new realm-sync job.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description for the Job. |
enable_new |
boolean | False | default | Enable newly synced users immediately. |
enabled |
boolean | False | default | Determines if the job is enabled. |
prox_id |
string | True | default | The ID of the job. |
realm |
string | False | default | Authentication domain ID |
remove_vanished |
string | False | default | 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). |
schedule |
string | True | default | Backup schedule. The format is a subset of systemd calendar events. |
scope |
string | False | default | Select what to sync. |
profile_name |
string | False | default | The profile to use to run the action. |
Update Access Control List (add or remove permissions).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
boolean | False | default | Remove permissions (instead of adding it). |
groups |
string | False | default | List of groups. |
path |
string | True | default | Access control path |
propagate |
boolean | False | default | Allow to propagate (inherit) permissions. |
roles |
string | True | default | List of roles. |
tokens |
string | False | default | List of API tokens. |
users |
string | False | default | List of users. |
profile_name |
string | False | default | The profile to use to run the action. |
Lists possible IPSet/Alias reference which are allowed in source/dest properties.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
prox_type |
string | False | default | Only list references of specified type. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get user TFA types (Personal and Realm).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
multiple |
boolean | False | default | Request all entries as an array. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Index for jobs related endpoints.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Reboot the container by shutting it down, and starting it again. Applies pending changes.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
timeout |
integer | False | default | Wait maximal timeout seconds for the shutdown. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update subscription info.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | Always connect to server, even if local cache is still valid. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Reboot or shutdown a node.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
command |
string | True | default | Specify the command. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Reload service. Falls back to restart if service cannot be reloaded.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
service |
string | True | default | Service ID |
profile_name |
string | False | default | The profile to use to run the action. |
Get OSD crush map
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Scan remote NFS server.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
server |
string | True | default | The server address (name or IP). |
profile_name |
string | False | default | The profile to use to run the action. |
Start the container.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
debug |
boolean | False | default | If set, enables very verbose debug log-level on start. |
node |
string | True | default | The cluster node name. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
List IPSet content
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get information needed to join this cluster over the connected node.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | False | default | _The node for which the joinee gets the nodeinfo. _ |
profile_name |
string | False | default | The profile to use to run the action. |
Get ceph metadata.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
scope |
string | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Creates a SPICE shell.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cmd |
string | False | default | Run specific command or default to login. |
cmd_opts |
string | False | default | Add parameters to a command. Encoded as null terminated strings. |
node |
string | True | default | The cluster node name. |
proxy |
string | False | default | 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). |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new sdn dns object.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
dns |
string | True | default | The SDN dns object identifier. |
key |
string | True | True | Description unavailable. |
reversemaskv6 |
integer | False | default | Description unavailable. |
reversev6mask |
integer | False | default | Description unavailable. |
ttl |
integer | False | default | Description unavailable. |
prox_type |
string | True | default | Plugin type. |
url |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Update IP or Network alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | Alias name. |
node |
string | True | default | The cluster node name. |
rename |
string | False | default | Rename an existing alias. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get single rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
pos |
integer | False | default | Update rule at position . |
profile_name |
string | False | default | The profile to use to run the action. |
Return the version of the cluster join API available on this node.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | Target node. |
sid |
string | True | default | HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). |
profile_name |
string | False | default | The profile to use to run the action. |
Get the currently configured vzdump defaults.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
storage |
string | False | default | The storage identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
List available updates.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
List IPSet content
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get package information for important Proxmox packages.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
List local disks.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
include_partitions |
boolean | False | default | Also include partitions. |
node |
string | True | default | The cluster node name. |
skipsmart |
boolean | False | default | Skip smart checks. |
prox_type |
string | False | default | Only list specific types of disks. |
profile_name |
string | False | default | The profile to use to run the action. |
Mark replication job for removal.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | Will remove the jobconfig entry, but will not cleanup. |
prox_id |
string | True | default | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. |
keep |
boolean | False | default | Keep replicated data at target (do not remove). |
profile_name |
string | False | default | The profile to use to run the action. |
Update group data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
groupid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Lists possible IPSet/Alias reference which are allowed in source/dest properties.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_type |
string | False | default | Only list references of specified type. |
profile_name |
string | False | default | The profile to use to run the action. |
Set subscription key.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
key |
string | True | True | Proxmox VE subscription key |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Writes the given file via guest agent.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
content |
string | True | default | The content to write into the file. |
encode |
boolean | False | default | If set, the content will be encoded as base64 (required by QEMU).Otherwise the content needs to be encoded beforehand - defaults to true. |
file |
string | True | default | The path to the file. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
SDN vnets index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
pending |
boolean | False | default | Display pending config. |
running |
boolean | False | default | Display running config. |
profile_name |
string | False | default | The profile to use to run the action. |
Read storage RRD statistics (returns PNG).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cf |
string | False | default | The RRD consolidation function |
ds |
string | True | default | The list of datasources you want to display. |
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage identifier. |
timeframe |
string | True | default | Specify the time frame you are interested in. |
profile_name |
string | False | default | The profile to use to run the action. |
Set/Unset multiple ceph flags at once.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
nobackfill |
boolean | False | default | Backfilling of PGs is suspended. |
nodeep_scrub |
boolean | False | default | Deep Scrubbing is disabled. |
nodown |
boolean | False | default | OSD failure reports are being ignored, such that the monitors will not mark OSDs down. |
noin |
boolean | False | default | OSDs that were previously marked out will not be marked back in when they start. |
noout |
boolean | False | default | OSDs will not automatically be marked out after the configured interval. |
norebalance |
boolean | False | default | Rebalancing of PGs is suspended. |
norecover |
boolean | False | default | Recovery of PGs is suspended. |
noscrub |
boolean | False | default | Scrubbing is disabled. |
notieragent |
boolean | False | default | Cache tiering activity is suspended. |
noup |
boolean | False | default | OSDs are not allowed to start. |
pause |
boolean | False | default | Pauses read and writes. |
profile_name |
string | False | default | The profile to use to run the action. |
Remove IP or Network alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | Alias name. |
profile_name |
string | False | default | The profile to use to run the action. |
SDN controllers index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
pending |
boolean | False | default | Display pending config. |
running |
boolean | False | default | Display running config. |
prox_type |
string | False | default | Only list sdn controllers of specific type |
profile_name |
string | False | default | The profile to use to run the action. |
Group index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Execute fsfreeze-freeze.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
ceph osd in
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
osdid |
integer | True | default | OSD ID |
profile_name |
string | False | default | The profile to use to run the action. |
Get replication job status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
List all snapshots.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Set or clear (unset) a specific ceph flag
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
flag |
string | True | default | The ceph flag to update |
value |
boolean | True | default | The new value of the flag |
profile_name |
string | False | default | The profile to use to run the action. |
API version details
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read sdn subnet configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
pending |
boolean | False | default | Display pending config. |
running |
boolean | False | default | Display running config. |
subnet |
string | True | default | The SDN subnet object identifier. |
vnet |
string | True | default | The SDN vnet object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new IPSet
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
rename |
string | False | default | Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Deactivate existing ACME account at CA.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | False | default | ACME account config file name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get the Ceph configuration file.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Snapshot a VM.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
description |
string | False | default | A textual description or comment. |
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
vmstate |
boolean | False | default | Save the vmstate |
profile_name |
string | False | default | The profile to use to run the action. |
Create Ceph Monitor and Manager
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
mon_address |
string | False | default | Overwrites autodetected monitor IP address(es). Must be in the public network(s) of Ceph. |
monid |
string | False | default | The ID for the monitor, when omitted the same as the nodename |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | True | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
group |
string | True | default | Security Group name. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | True | default | Rule type. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute QEMU Guest Agent commands.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
command |
string | True | default | The QGA command. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Upload or update custom certificate chain and key.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
certificates |
string | True | default | PEM encoded certificate (chain). |
force |
boolean | False | default | Overwrite existing custom or ACME certificate files. |
key |
string | False | True | PEM encoded private key. |
node |
string | True | default | The cluster node name. |
restart |
boolean | False | default | Restart pveproxy. |
profile_name |
string | False | default | The profile to use to run the action. |
Update ACME plugin configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
api |
string | False | default | API plugin name |
data |
string | False | default | DNS plugin data. (base64 encoded) |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
disable |
boolean | False | default | Flag to disable the config. |
prox_id |
string | True | default | ACME Plugin ID name |
nodes |
string | False | default | List of cluster node names. |
validation_delay |
integer | False | default | Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. |
profile_name |
string | False | default | The profile to use to run the action. |
Create OSD
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
crush_device_class |
string | False | default | Set the device class of the OSD in crush. |
db_dev |
string | False | default | Block device name for block.db. |
db_dev_size |
number | False | default | Size in GiB for block.db. |
dev |
string | True | default | Block device name. |
encrypted |
boolean | False | default | Enables encryption of the OSD. |
node |
string | True | default | The cluster node name. |
wal_dev |
string | False | default | Block device name for block.wal. |
wal_dev_size |
number | False | default | Size in GiB for block.wal. |
profile_name |
string | False | default | The profile to use to run the action. |
Resume virtual machine.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
nocheck |
boolean | False | default | Description unavailable. |
node |
string | True | default | The cluster node name. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Cluster node index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Create a new sdn vnet object.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
alias |
string | False | default | alias name of the vnet |
tag |
integer | False | default | vlan or vxlan id |
prox_type |
string | False | default | Type |
vlanaware |
boolean | False | default | Allow vm VLANs to pass through this vnet. |
vnet |
string | True | default | The SDN vnet object identifier. |
zone |
string | True | default | zone id |
profile_name |
string | False | default | The profile to use to run the action. |
Cluster ceph index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read storage status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Get container configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
current |
boolean | False | default | Get current values (instead of pending values). |
node |
string | True | default | The cluster node name. |
snapshot |
string | False | default | Fetch config values from given snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
profile_name |
string | False | default | The profile to use to run the action. |
Execute fsfreeze-status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get next free VMID. Pass a VMID to assert that its free (at time of check).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
vmid |
integer | False | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete ACME plugin configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Unique identifier for ACME plugin instance. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new role.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
privs |
string | False | default | Description unavailable. |
roleid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Opens a weksocket for VNC traffic.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
port |
integer | True | default | Port number returned by previous vncproxy call. |
vmid |
integer | True | default | The (unique) ID of the VM. |
vncticket |
string | True | default | Ticket from previous call to vncproxy. |
profile_name |
string | False | default | The profile to use to run the action. |
Read VM RRD statistics (returns PNG)
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cf |
string | False | default | The RRD consolidation function |
ds |
string | True | default | The list of datasources you want to display. |
node |
string | True | default | The cluster node name. |
timeframe |
string | True | default | Specify the time frame you are interested in. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Returns a SPICE configuration to connect to the CT.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
proxy |
string | False | default | 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). |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Set Firewall options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
ebtables |
boolean | False | default | Enable ebtables rules cluster wide. |
enable |
integer | False | default | Enable or disable the firewall cluster wide. |
log_ratelimit |
string | False | default | Log ratelimiting settings |
policy_in |
string | False | default | Input policy. |
policy_out |
string | False | default | Output policy. |
profile_name |
string | False | default | The profile to use to run the action. |
Index for backup info related endpoints
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Delete pool.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
poolid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Creates a VNC Shell proxy.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cmd |
string | False | default | Run specific command or default to login. |
cmd_opts |
string | False | default | Add parameters to a command. Encoded as null terminated strings. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | Alias name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read metric server configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
__
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Get Firewall options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Get role configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
roleid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Update metric server configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
api_path_prefix |
string | False | default | An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. |
bucket |
string | False | default | The InfluxDB bucket/db. Only necessary when using the http v2 api. |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
disable |
boolean | False | default | Flag to disable the plugin. |
prox_id |
string | True | default | The ID of the entry. |
influxdbproto |
string | False | default | Description unavailable. |
max_body_size |
integer | False | default | InfluxDB max-body-size in bytes. Requests are batched up to this size. |
mtu |
integer | False | default | MTU for metrics transmission over UDP |
organization |
string | False | default | The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. |
path |
string | False | default | root graphite path (ex: proxmox.mycluster.mykey) |
port |
integer | True | default | server network port |
proto |
string | False | default | Protocol to send graphite data. TCP or UDP (default) |
server |
string | True | default | server dns name or IP address |
timeout |
integer | False | default | graphite TCP socket timeout (default=1) |
token |
string | False | default | The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead. |
verify_certificate |
boolean | False | default | Set to 0 to disable certificate verification for https endpoints. |
profile_name |
string | False | default | The profile to use to run the action. |
Download templates and ISO images by using an URL.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
checksum |
string | False | default | The expected checksum of the file. |
checksum_algorithm |
string | False | default | The algorithm to calculate the checksum of the file. |
content |
string | True | default | Content type. |
filename |
string | True | default | The name of the file to create. Caution: This will be normalized! |
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage identifier. |
url |
string | True | default | The URL to download the file from. |
verify_certificates |
boolean | False | default | If false, no SSL/TLS certificates will be verified. |
profile_name |
string | False | default | The profile to use to run the action. |
Update volume attributes
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
notes |
string | False | default | The new notes. |
protected |
boolean | False | default | Protection status. Currently only supported for backups. |
storage |
string | False | default | The storage identifier. |
volume |
string | True | default | Volume identifier |
profile_name |
string | False | default | The profile to use to run the action. |
QEMU capabilities index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete user.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Remove IP or Network from IPSet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Create IP or Network Alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
name |
string | True | default | Alias name. |
profile_name |
string | False | default | The profile to use to run the action. |
Stop service.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
service |
string | True | default | Service ID |
profile_name |
string | False | default | The profile to use to run the action. |
Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
current |
boolean | False | default | Get current values (instead of pending values). |
node |
string | True | default | The cluster node name. |
snapshot |
string | False | default | Fetch config values from given snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Service list.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
User index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
enabled |
boolean | False | default | Optional filter for enable property. |
full |
boolean | False | default | Include group and token information. |
profile_name |
string | False | default | The profile to use to run the action. |
Read firewall log
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
limit |
integer | False | default | Description unavailable. |
node |
string | True | default | The cluster node name. |
since |
integer | False | default | Display log since this UNIX epoch. |
start |
integer | False | default | Description unavailable. |
until |
integer | False | default | Display log until this UNIX epoch. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new security group.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
group |
string | True | default | Security Group name. |
rename |
string | False | default | Rename/update an existing security group. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing group. |
profile_name |
string | False | default | The profile to use to run the action. |
Read task log.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
download |
boolean | False | default | Whether the tasklog file should be downloaded. This parameter can't be used in conjunction with other parameters |
limit |
integer | False | default | The amount of lines to read from the tasklog. |
node |
string | True | default | The cluster node name. |
start |
integer | False | default | Start at this line when reading the tasklog |
upid |
string | True | default | The task's unique ID. |
profile_name |
string | False | default | The profile to use to run the action. |
List all custom and default CPU models.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
SDN zones index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
pending |
boolean | False | default | Display pending config. |
running |
boolean | False | default | Display running config. |
prox_type |
string | False | default | Only list SDN zones of specific type |
profile_name |
string | False | default | The profile to use to run the action. |
Get schema of ACME challenge types.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Update network device configuration
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
address |
string | False | default | IP address. |
address6 |
string | False | default | IP address. |
autostart |
boolean | False | default | Automatically start interface on boot. |
bond_primary |
string | False | default | Specify the primary interface for active-backup bond. |
bond_mode |
string | False | default | Bonding mode. |
bond_xmit_hash_policy |
string | False | default | Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. |
bridge_ports |
string | False | default | Specify the interfaces you want to add to your bridge. |
bridge_vlan_aware |
boolean | False | default | Enable bridge vlan support. |
cidr |
string | False | default | IPv4 CIDR. |
cidr6 |
string | False | default | IPv6 CIDR. |
comments |
string | False | default | Comments |
comments6 |
string | False | default | Comments |
delete |
string | False | default | A list of settings you want to delete. |
gateway |
string | False | default | Default gateway address. |
gateway6 |
string | False | default | Default ipv6 gateway address. |
iface |
string | True | default | Network interface name. |
mtu |
integer | False | default | MTU. |
netmask |
string | False | default | Network mask. |
netmask6 |
integer | False | default | Network mask. |
node |
string | True | default | The cluster node name. |
ovs_bonds |
string | False | default | Specify the interfaces used by the bonding device. |
ovs_bridge |
string | False | default | The OVS bridge associated with a OVS port. This is required when you create an OVS port. |
ovs_options |
string | False | default | OVS interface options. |
ovs_ports |
string | False | default | Specify the interfaces you want to add to your bridge. |
ovs_tag |
integer | False | default | Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) |
slaves |
string | False | default | Specify the interfaces used by the bonding device. |
prox_type |
string | True | default | Network interface type |
vlan_id |
integer | False | default | vlan-id for a custom named vlan interface (ifupdown2 only). |
vlan_raw_device |
string | False | default | Specify the raw interface for the vlan interface. |
profile_name |
string | False | default | The profile to use to run the action. |
List aliases
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Migrate the container to another cluster. Creates a new migration task. EXPERIMENTAL feature!
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bwlimit |
number | False | default | Override I/O bandwidth limit (in KiB/s). |
delete |
boolean | False | default | Delete the original CT and related data after successful migration. By default the original CT is kept on the source cluster in a stopped state. |
node |
string | True | default | The cluster node name. |
online |
boolean | False | default | Use online/live migration. |
restart |
boolean | False | default | Use restart migration |
target_bridge |
string | True | default | Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. |
target_endpoint |
string | True | default | Remote target endpoint |
target_storage |
string | True | default | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. |
target_vmid |
integer | False | default | The (unique) ID of the VM. |
timeout |
integer | False | default | Timeout in seconds for shutdown for restart migration |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update existing ACME account information with CA. Note: not specifying any new account information triggers a refresh.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
contact |
string | False | default | Contact email addresses. |
name |
string | False | default | ACME account config file name. |
profile_name |
string | False | default | The profile to use to run the action. |
Generate new cluster configuration. If no links given, default to local IP address as link0.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
clustername |
string | True | default | The name of the cluster. |
link_list |
string | False | default | Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) |
nodeid |
integer | False | default | Node id for this node. |
votes |
integer | False | default | Number of votes for this node. |
profile_name |
string | False | default | The profile to use to run the action. |
Check if feature for virtual machine is available.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
feature |
string | True | default | Feature to check. |
node |
string | True | default | The cluster node name. |
snapname |
string | False | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read firewall log
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
limit |
integer | False | default | Description unavailable. |
node |
string | True | default | The cluster node name. |
since |
integer | False | default | Display log since this UNIX epoch. |
start |
integer | False | default | Description unavailable. |
until |
integer | False | default | Display log until this UNIX epoch. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Set container options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
arch |
string | False | default | OS architecture type. |
cmode |
string | False | default | 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). |
console |
boolean | False | default | Attach a console device (/dev/console) to the container. |
cores |
integer | False | default | The number of cores assigned to the container. A container can use all available cores by default. |
cpulimit |
number | False | default | Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. |
cpuunits |
integer | False | default | CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. |
debug |
boolean | False | default | Try to be more verbose. For now this only enables debug log-level on start. |
delete |
string | False | default | A list of settings you want to delete. |
description |
string | False | default | Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
features |
string | False | default | Allow containers access to advanced features. |
hookscript |
string | False | default | Script that will be exectued during various steps in the containers lifetime. |
hostname |
string | False | default | Set a host name for the container. |
lock |
string | False | default | Lock/unlock the container. |
memory |
integer | False | default | Amount of RAM for the container in MB. |
mp_list |
string | False | default | Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. |
nameserver |
string | False | default | Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. |
net_list |
string | False | default | Specifies network interfaces for the container. |
node |
string | True | default | The cluster node name. |
onboot |
boolean | False | default | Specifies whether a container will be started during system bootup. |
ostype |
string | False | default | OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. |
protection |
boolean | False | default | Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. |
revert |
string | False | default | Revert a pending change. |
rootfs |
string | False | default | Use volume as container root. |
searchdomain |
string | False | default | Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. |
startup |
string | False | default | Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. |
swap |
integer | False | default | Amount of SWAP for the container in MB. |
tags |
string | False | default | Tags of the Container. This is only meta information. |
template |
boolean | False | default | Enable/disable Template. |
timezone |
string | False | default | Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab |
tty |
integer | False | default | Specify the number of tty available to the container |
unprivileged |
boolean | False | default | Makes the container run as unprivileged user. (Should not be modified manually.) |
unused_list |
string | False | default | Reference to unused volumes. This is used internally, and should not be modified manually. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete IPSet
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | Delete all members of the IPSet, if there are any. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get virtual machine status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
LXC container index (per node).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Remove Metric server.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
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.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
prune_backups |
string | False | default | Use these retention options instead of those from the storage configuration. |
storage |
string | True | default | The storage identifier. |
prox_type |
string | False | default | Either 'qemu' or 'lxc'. Only consider backups for guests of this type. |
vmid |
integer | False | default | Only consider backups for this guest. |
profile_name |
string | False | default | The profile to use to run the action. |
List configured metric servers.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Suspend the container. This is experimental.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get single rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
get the status of all ceph flags
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
List zone content.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
zone |
string | True | default | The SDN zone object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Regenerate and change cloudinit config drive.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
API version details, including some parts of the global datacenter config.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
add_storage |
boolean | False | default | Configure storage using the directory. |
device |
string | True | default | The block device you want to create the filesystem on. |
filesystem |
string | False | default | The desired filesystem. |
name |
string | True | default | The storage identifier. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Scan remote CIFS server.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
domain |
string | False | default | SMB domain (Workgroup). |
node |
string | True | default | The cluster node name. |
password |
string | False | True | User password. |
server |
string | True | default | The server address (name or IP). |
username |
string | False | default | User name. |
profile_name |
string | False | default | The profile to use to run the action. |
Revoke existing certificate from CA.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read IP or Network settings from IPSet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
name |
string | True | default | IP set name. |
profile_name |
string | False | default | The profile to use to run the action. |
ACME plugin index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_type |
string | False | default | Only list ACME plugins of a specific type |
profile_name |
string | False | default | The profile to use to run the action. |
Get package changelogs.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | Package name. |
node |
string | True | default | The cluster node name. |
version |
string | False | default | Package version. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete sdn subnet object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
subnet |
string | True | default | The SDN subnet object identifier. |
vnet |
string | True | default | The SDN vnet object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Read realm-sync job definition.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute get-memory-block-info.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get the status of a specific ceph flag.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
flag |
string | True | default | The name of the flag name to get. |
profile_name |
string | False | default | The profile to use to run the action. |
SDN dns index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_type |
string | False | default | Only list sdn dns of specific type |
profile_name |
string | False | default | The profile to use to run the action. |
Role index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Get auth server configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
realm |
string | True | default | Authentication domain ID |
profile_name |
string | False | default | The profile to use to run the action. |
Update realm-sync job definition.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description for the Job. |
delete |
string | False | default | A list of settings you want to delete. |
enable_new |
boolean | False | default | Enable newly synced users immediately. |
enabled |
boolean | False | default | Determines if the job is enabled. |
prox_id |
string | True | default | The ID of the job. |
remove_vanished |
string | False | default | 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). |
schedule |
string | True | default | Backup schedule. The format is a subset of systemd calendar events. |
scope |
string | False | default | Select what to sync. |
profile_name |
string | False | default | The profile to use to run the action. |
Remove IP or Network from IPSet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete a TFA entry by ID.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | A TFA entry id. |
password |
string | False | True | The current password. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Create or restore a container.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
arch |
string | False | default | OS architecture type. |
bwlimit |
number | False | default | Override I/O bandwidth limit (in KiB/s). |
cmode |
string | False | default | 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). |
console |
boolean | False | default | Attach a console device (/dev/console) to the container. |
cores |
integer | False | default | The number of cores assigned to the container. A container can use all available cores by default. |
cpulimit |
number | False | default | Limit of CPU usage. NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit. |
cpuunits |
integer | False | default | CPU weight for a container, will be clamped to [1, 10000] in cgroup v2. |
debug |
boolean | False | default | Try to be more verbose. For now this only enables debug log-level on start. |
description |
string | False | default | Description for the Container. Shown in the web-interface CT's summary. This is saved as comment inside the configuration file. |
features |
string | False | default | Allow containers access to advanced features. |
force |
boolean | False | default | Allow to overwrite existing container. |
hookscript |
string | False | default | Script that will be exectued during various steps in the containers lifetime. |
hostname |
string | False | default | Set a host name for the container. |
ignore_unpack_errors |
boolean | False | default | Ignore errors when extracting the template. |
lock |
string | False | default | Lock/unlock the container. |
memory |
integer | False | default | Amount of RAM for the container in MB. |
mp_list |
string | False | default | Use volume as container mount point. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. |
nameserver |
string | False | default | Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. |
net_list |
string | False | default | Specifies network interfaces for the container. |
node |
string | True | default | The cluster node name. |
onboot |
boolean | False | default | Specifies whether a container will be started during system bootup. |
ostemplate |
string | True | default | The OS template or backup file. |
ostype |
string | False | default | OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/.common.conf. Value 'unmanaged' can be used to skip and OS specific setup. |
password |
string | False | True | Sets root password inside container. |
pool |
string | False | default | Add the VM to the specified pool. |
protection |
boolean | False | default | Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation. |
restore |
boolean | False | default | Mark this as restore task. |
rootfs |
string | False | default | Use volume as container root. |
searchdomain |
string | False | default | Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver. |
ssh_public_keys |
string | False | default | Setup public SSH keys (one key per line, OpenSSH format). |
start |
boolean | False | default | Start the CT after its creation finished successfully. |
startup |
string | False | default | Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. |
storage |
string | False | default | Default Storage. |
swap |
integer | False | default | Amount of SWAP for the container in MB. |
tags |
string | False | default | Tags of the Container. This is only meta information. |
template |
boolean | False | default | Enable/disable Template. |
timezone |
string | False | default | Time zone to use in the container. If option isn't set, then nothing will be done. Can be set to 'host' to match the host time zone, or an arbitrary time zone option from /usr/share/zoneinfo/zone.tab |
tty |
integer | False | default | Specify the number of tty available to the container |
unique |
boolean | False | default | Assign a unique random ethernet address. |
unprivileged |
boolean | False | default | Makes the container run as unprivileged user. (Should not be modified manually.) |
unused_list |
string | False | default | Reference to unused volumes. This is used internally, and should not be modified manually. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Resume the container.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read IP or Network settings from IPSet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update snapshot metadata.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
description |
string | False | default | A textual description or comment. |
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
List available networks
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
prox_type |
string | False | default | Only list specific interface types. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
service |
string | True | default | Service ID |
profile_name |
string | False | default | The profile to use to run the action. |
List status of all replication jobs on this node.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
guest |
integer | False | default | Only list replication jobs for this guest. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Order a new certificate from ACME-compatible CA.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | Overwrite existing custom certificate. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read sdn controller configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
controller |
string | True | default | The SDN controller object identifier. |
pending |
boolean | False | default | Display pending config. |
running |
boolean | False | default | Display running config. |
profile_name |
string | False | default | The profile to use to run the action. |
Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
forceStop |
boolean | False | default | Make sure the Container stops. |
node |
string | True | default | The cluster node name. |
timeout |
integer | False | default | Wait maximal timeout seconds. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new replication job
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description. |
disable |
boolean | False | default | Flag to disable/deactivate the entry. |
prox_id |
string | True | default | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. |
rate |
number | False | default | Rate limit in mbps (megabytes per second) as floating point number. |
remove_job |
string | False | default | Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. |
schedule |
string | False | default | Storage replication schedule. The format is a subset of systemd calendar events. |
source |
string | False | default | For internal use, to detect if the guest was stolen. |
target |
string | True | default | Target node. |
prox_type |
string | True | default | Section type. |
profile_name |
string | False | default | The profile to use to run the action. |
Remove API token for a specific user.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
tokenid |
string | True | default | User-specific token identifier. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Get OSD volume details
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
osdid |
integer | True | default | OSD ID |
prox_type |
string | False | default | OSD device type |
profile_name |
string | False | default | The profile to use to run the action. |
Migrate the container to another node. Creates a new migration task.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bwlimit |
number | False | default | Override I/O bandwidth limit (in KiB/s). |
node |
string | True | default | The cluster node name. |
online |
boolean | False | default | Use online/live migration. |
restart |
boolean | False | default | Use restart migration |
target |
string | True | default | Target node. |
target_storage |
string | False | default | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. |
timeout |
integer | False | default | Timeout in seconds for shutdown for restart migration |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get list of appliances.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Download appliance templates.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage where the template will be stored |
template |
string | True | default | The template which will downloaded |
profile_name |
string | False | default | The profile to use to run the action. |
Delete a VM snapshot.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | For removal from config file, even if removing disk snapshots fails. |
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete security group.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
group |
string | True | default | Security Group name. |
profile_name |
string | False | default | The profile to use to run the action. |
Modify rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | False | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
delete |
string | False | default | A list of settings you want to delete. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
group |
string | True | default | Security Group name. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
moveto |
integer | False | default | Move rule to new position . Other arguments are ignored. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | False | default | Rule type. |
profile_name |
string | False | default | The profile to use to run the action. |
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!
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
expire |
integer | False | default | API token expiration date (seconds since epoch). '0' means no expiration date. |
privsep |
boolean | False | default | Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. |
tokenid |
string | True | default | User-specific token identifier. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Read ha group configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
group |
string | True | default | The HA group identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Node index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Storage index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_type |
string | False | default | Only list storage of specific type |
profile_name |
string | False | default | The profile to use to run the action. |
Delete rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
pos |
integer | False | default | Update rule at position . |
profile_name |
string | False | default | The profile to use to run the action. |
Remove IP or Network alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | Alias name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Opens a websocket for VNC traffic.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
port |
integer | True | default | Port number returned by previous vncproxy call. |
vncticket |
string | True | default | Ticket from previous call to vncproxy. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete IPSet
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | Delete all members of the IPSet, if there are any. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Hard restart service. Use reload if you want to reduce interruptions.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
service |
string | True | default | Service ID |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Pool index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | The name of the pool. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read VM RRD statistics
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cf |
string | False | default | The RRD consolidation function |
node |
string | True | default | The cluster node name. |
timeframe |
string | True | default | Specify the time frame you are interested in. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Migrate all VMs and Containers.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
maxworkers |
integer | False | default | Maximal number of parallel migration job. If not set, uses'max_workers' from datacenter.cfg. One of both must be set! |
node |
string | True | default | The cluster node name. |
target |
string | True | default | Target node. |
vms |
string | False | default | Only consider Guests with these IDs. |
with_local_disks |
boolean | False | default | Enable live storage migration for local disk |
profile_name |
string | False | default | The profile to use to run the action. |
List TFA configurations of users.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Get Ceph monitor list.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
ACMEAccount index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Update sdn dns object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dns |
string | True | default | The SDN dns object identifier. |
key |
string | False | True | Description unavailable. |
reversemaskv6 |
integer | False | default | Description unavailable. |
ttl |
integer | False | default | Description unavailable. |
url |
string | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Reboot the VM by shutting it down, and starting it again. Applies pending changes.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
timeout |
integer | False | default | Wait maximal timeout seconds for the shutdown. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete volume
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delay |
integer | False | default | Time to wait for the task to finish. We return 'null' if the task finish within that time. |
node |
string | True | default | The cluster node name. |
storage |
string | False | default | The storage identifier. |
volume |
string | True | default | Volume identifier |
profile_name |
string | False | default | The profile to use to run the action. |
Update storage configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
blocksize |
string | False | default | block size |
bwlimit |
string | False | default | Set I/O bandwidth limit for various operations (in KiB/s). |
comstar_hg |
string | False | default | host group for comstar views |
comstar_tg |
string | False | default | target group for comstar views |
content |
string | False | default | _Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. _ |
content_dirs |
string | False | default | Overrides for default content type directories. |
create_base_path |
boolean | False | default | Create the base directory if it doesn't exist. |
create_subdirs |
boolean | False | default | Populate the directory with the default structure. |
data_pool |
string | False | default | Data Pool (for erasure coding only) |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
disable |
boolean | False | default | Flag to disable the storage. |
domain |
string | False | default | CIFS domain. |
encryption_key |
string | False | default | Encryption key. Use 'autogen' to generate one automatically without passphrase. |
fingerprint |
string | False | default | Certificate SHA 256 fingerprint. |
prox_format |
string | False | default | Default image format. |
fs_name |
string | False | default | The Ceph filesystem name. |
fuse |
boolean | False | default | Mount CephFS through FUSE. |
is_mountpoint |
string | False | default | Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. |
keyring |
string | False | default | Client keyring contents (for external clusters). |
krbd |
boolean | False | default | Always access rbd through krbd kernel module. |
lio_tpg |
string | False | default | target portal group for Linux LIO targets |
master_pubkey |
string | False | default | Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. |
max_protected_backups |
integer | False | default | Maximal number of protected backups per guest. Use '-1' for unlimited. |
maxfiles |
integer | False | default | Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. |
mkdir |
boolean | False | default | Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. |
monhost |
string | False | default | IP addresses of monitors (for external clusters). |
mountpoint |
string | False | default | mount point |
namespace |
string | False | default | Namespace. |
nocow |
boolean | False | default | Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. |
nodes |
string | False | default | List of cluster node names. |
nowritecache |
boolean | False | default | disable write caching on the target |
options |
string | False | default | NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') |
password |
string | False | True | Password for accessing the share/datastore. |
pool |
string | False | default | Pool. |
port |
integer | False | default | For non default port. |
preallocation |
string | False | default | Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. |
prune_backups |
string | False | default | The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. |
saferemove |
boolean | False | default | Zero-out data when removing LVs. |
saferemove_throughput |
string | False | default | Wipe throughput (cstream -t parameter value). |
server |
string | False | default | Server IP or DNS name. |
server2 |
string | False | default | Backup volfile server IP or DNS name. |
shared |
boolean | False | default | Mark storage as shared. |
smbversion |
string | False | default | SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. |
sparse |
boolean | False | default | use sparse volumes |
storage |
string | True | default | The storage identifier. |
subdir |
string | False | default | Subdir to mount. |
tagged_only |
boolean | False | default | Only use logical volumes tagged with 'pve-vm-ID'. |
transport |
string | False | default | Gluster transport: tcp or rdma |
username |
string | False | default | RBD Id. |
profile_name |
string | False | default | The profile to use to run the action. |
List all snapshots.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read VM RRD statistics
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cf |
string | False | default | The RRD consolidation function |
node |
string | True | default | The cluster node name. |
timeframe |
string | True | default | Specify the time frame you are interested in. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Reload network configuration
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | Alias name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get information about node's certificates.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Resources index (cluster wide).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_type |
string | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Update authentication server settings.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
acr_values |
string | False | default | Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. |
autocreate |
boolean | False | default | Automatically create users if they do not exist. |
base_dn |
string | False | default | LDAP base domain name |
bind_dn |
string | False | default | LDAP bind domain name |
capath |
string | False | default | Path to the CA certificate store |
case_sensitive |
boolean | False | default | username is case-sensitive |
cert |
string | False | default | Path to the client certificate |
certkey |
string | False | default | Path to the client certificate key |
client_id |
string | False | default | OpenID Client ID |
client_key |
string | False | default | OpenID Client Key |
comment |
string | False | default | Description. |
default |
boolean | False | default | Use this as default realm |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
domain |
string | False | default | AD domain name |
prox_filter |
string | False | default | LDAP filter for user sync. |
group_classes |
string | False | default | The objectclasses for groups. |
group_dn |
string | False | default | LDAP base domain name for group sync. If not set, the base_dn will be used. |
group_filter |
string | False | default | LDAP filter for group sync. |
group_name_attr |
string | False | default | LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. |
issuer_url |
string | False | default | OpenID Issuer Url |
mode |
string | False | default | LDAP protocol mode. |
password |
string | False | True | LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. |
port |
integer | False | default | Server port. |
prompt |
string | False | default | Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. |
realm |
string | True | default | Authentication domain ID |
scopes |
string | False | default | Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. |
secure |
boolean | False | default | Use secure LDAPS protocol. DEPRECATED: use 'mode' instead. |
server1 |
string | False | default | Server IP address (or DNS name) |
server2 |
string | False | default | Fallback Server IP address (or DNS name) |
sslversion |
string | False | default | LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! |
sync_defaults_options |
string | False | default | The default options for behavior of synchronizations. |
sync_attributes |
string | False | default | Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. |
tfa |
string | False | default | Use Two-factor authentication. |
user_attr |
string | False | default | LDAP user attribute name |
user_classes |
string | False | default | The objectclasses for users. |
verify |
boolean | False | default | Verify the server's SSL certificate |
profile_name |
string | False | default | The profile to use to run the action. |
Get container configuration, including pending changes.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Initialize Disk with GPT
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
disk |
string | True | default | Block device name |
node |
string | True | default | The cluster node name. |
uuid |
string | False | default | UUID for the GPT table |
profile_name |
string | False | default | The profile to use to run the action. |
Execute info.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update a hardware mapping.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
string | False | default | A list of settings you want to delete. |
description |
string | False | default | Description of the logical PCI device. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
prox_id |
string | True | default | The ID of the logical PCI mapping. |
prox_map |
array | False | default | A list of maps for the cluster nodes. |
mdev |
boolean | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute get-memory-blocks.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute network-get-interfaces.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update sdn vnet object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
alias |
string | False | default | alias name of the vnet |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
tag |
integer | False | default | vlan or vxlan id |
vlanaware |
boolean | False | default | Allow vm VLANs to pass through this vnet. |
vnet |
string | True | default | The SDN vnet object identifier. |
zone |
string | False | default | zone id |
profile_name |
string | False | default | The profile to use to run the action. |
Update replication job configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description. |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
disable |
boolean | False | default | Flag to disable/deactivate the entry. |
prox_id |
string | True | default | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. |
rate |
number | False | default | Rate limit in mbps (megabytes per second) as floating point number. |
remove_job |
string | False | default | Mark the replication job for removal. The job will remove all local replication snapshots. When set to 'full', it also tries to remove replicated volumes on the target. The job then removes itself from the configuration file. |
schedule |
string | False | default | Storage replication schedule. The format is a subset of systemd calendar events. |
source |
string | False | default | For internal use, to detect if the guest was stolen. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete resource configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
sid |
string | True | default | HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). |
profile_name |
string | False | default | The profile to use to run the action. |
Get cluster status information.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Update IP or Network settings
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | IP set name. |
nomatch |
boolean | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Get user configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete sdn zone object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
zone |
string | True | default | The SDN zone object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute get-users.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create IP or Network Alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
name |
string | True | default | Alias name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete sdn controller object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
controller |
string | True | default | The SDN controller object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
List recent tasks (cluster wide).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
List USB Hardware Mappings
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
check_node |
string | False | default | If given, checks the configurations on the given node for correctness, and adds relevant errors to the devices. |
profile_name |
string | False | default | The profile to use to run the action. |
Add an authentication server.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
acr_values |
string | False | default | Specifies the Authentication Context Class Reference values that theAuthorization Server is being requested to use for the Auth Request. |
autocreate |
boolean | False | default | Automatically create users if they do not exist. |
base_dn |
string | False | default | LDAP base domain name |
bind_dn |
string | False | default | LDAP bind domain name |
capath |
string | False | default | Path to the CA certificate store |
case_sensitive |
boolean | False | default | username is case-sensitive |
cert |
string | False | default | Path to the client certificate |
certkey |
string | False | default | Path to the client certificate key |
client_id |
string | False | default | OpenID Client ID |
client_key |
string | False | default | OpenID Client Key |
comment |
string | False | default | Description. |
default |
boolean | False | default | Use this as default realm |
domain |
string | False | default | AD domain name |
prox_filter |
string | False | default | LDAP filter for user sync. |
group_classes |
string | False | default | The objectclasses for groups. |
group_dn |
string | False | default | LDAP base domain name for group sync. If not set, the base_dn will be used. |
group_filter |
string | False | default | LDAP filter for group sync. |
group_name_attr |
string | False | default | LDAP attribute representing a groups name. If not set or found, the first value of the DN will be used as name. |
issuer_url |
string | False | default | OpenID Issuer Url |
mode |
string | False | default | LDAP protocol mode. |
password |
string | False | True | LDAP bind password. Will be stored in '/etc/pve/priv/realm/.pw'. |
port |
integer | False | default | Server port. |
prompt |
string | False | default | Specifies whether the Authorization Server prompts the End-User for reauthentication and consent. |
realm |
string | True | default | Authentication domain ID |
scopes |
string | False | default | Specifies the scopes (user details) that should be authorized and returned, for example 'email' or 'profile'. |
secure |
boolean | False | default | Use secure LDAPS protocol. DEPRECATED: use 'mode' instead. |
server1 |
string | False | default | Server IP address (or DNS name) |
server2 |
string | False | default | Fallback Server IP address (or DNS name) |
sslversion |
string | False | default | LDAPS TLS/SSL version. It's not recommended to use version older than 1.2! |
sync_defaults_options |
string | False | default | The default options for behavior of synchronizations. |
sync_attributes |
string | False | default | Comma separated list of key=value pairs for specifying which LDAP attributes map to which PVE user field. For example, to map the LDAP attribute 'mail' to PVEs 'email', write 'email=mail'. By default, each PVE user field is represented by an LDAP attribute of the same name. |
tfa |
string | False | default | Use Two-factor authentication. |
prox_type |
string | True | default | Realm type. |
user_attr |
string | False | default | LDAP user attribute name |
user_classes |
string | False | default | The objectclasses for users. |
username_claim |
string | False | default | OpenID claim used to generate the unique username. |
verify |
boolean | False | default | Verify the server's SSL certificate |
profile_name |
string | False | default | The profile to use to run the action. |
Prune backups. Only those using the standard naming scheme are considered.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
prune_backups |
string | False | default | Use these retention options instead of those from the storage configuration. |
storage |
string | True | default | The storage identifier. |
prox_type |
string | False | default | Either 'qemu' or 'lxc'. Only consider backups for guests of this type. |
vmid |
integer | False | default | Only prune backups for this VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read sdn zone configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
pending |
boolean | False | default | Display pending config. |
running |
boolean | False | default | Display running config. |
zone |
string | True | default | The SDN zone object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Get volume attributes
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
storage |
string | False | default | The storage identifier. |
volume |
string | True | default | Volume identifier |
profile_name |
string | False | default | The profile to use to run the action. |
Stop ceph services.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
service |
string | False | default | Ceph service name. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new HA group.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description. |
group |
string | True | default | The HA group identifier. |
nodes |
string | True | default | List of cluster node names with optional priority. |
nofailback |
boolean | False | default | The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. |
restricted |
boolean | False | default | Resources bound to restricted groups may only run on nodes defined by the group. |
prox_type |
string | False | default | Group type. |
profile_name |
string | False | default | The profile to use to run the action. |
Metrics index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Delete vzdump backup job definition.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | The job ID. |
profile_name |
string | False | default | The profile to use to run the action. |
Read storage configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
storage |
string | True | default | The storage identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
List rules.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
group |
string | True | default | Security Group name. |
profile_name |
string | False | default | The profile to use to run the action. |
Apply sdn controller changes && reload.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
SDN index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute suspend-hybrid.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read resource configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
sid |
string | True | default | HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). |
profile_name |
string | False | default | The profile to use to run the action. |
Get the Ceph configuration database.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get QDevice status
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Read subscription info.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Migration tunnel endpoint for websocket upgrade - only for internal use by VM migration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
socket |
string | True | default | unix socket to forward to |
ticket |
string | True | default | ticket return by initial 'mtunnel' API call, or retrieved via 'ticket' tunnel command |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Set Firewall options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
string | False | default | A list of settings you want to delete. |
dhcp |
boolean | False | default | Enable DHCP. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
enable |
boolean | False | default | Enable/disable firewall rules. |
ipfilter |
boolean | False | default | Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. |
log_level_in |
string | False | default | Log level for incoming traffic. |
log_level_out |
string | False | default | Log level for outgoing traffic. |
macfilter |
boolean | False | default | Enable/disable MAC address filter. |
ndp |
boolean | False | default | Enable NDP (Neighbor Discovery Protocol). |
node |
string | True | default | The cluster node name. |
policy_in |
string | False | default | Input policy. |
policy_out |
string | False | default | Output policy. |
radv |
boolean | False | default | Allow sending Router Advertisement. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update vzdump backup job definition.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_all |
boolean | False | default | Backup all known guest systems on this host. |
bwlimit |
integer | False | default | Limit I/O bandwidth (in KiB/s). |
comment |
string | False | default | Description for the Job. |
compress |
string | False | default | Compress dump file. |
delete |
string | False | default | A list of settings you want to delete. |
dow |
string | False | default | Day of week selection. |
dumpdir |
string | False | default | Store resulting files to specified directory. |
enabled |
boolean | False | default | Enable or disable the job. |
exclude |
string | False | default | Exclude specified guest systems (assumes --all) |
exclude_path |
array | False | default | Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. |
prox_id |
string | True | default | The job ID. |
ionice |
integer | False | default | Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. |
lockwait |
integer | False | default | Maximal time to wait for the global lock (minutes). |
mailnotification |
string | False | default | Specify when to send an email |
mailto |
string | False | default | Comma-separated list of email addresses or users that should receive email notifications. |
maxfiles |
integer | False | default | Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. |
mode |
string | False | default | Backup mode. |
node |
string | False | default | Only run if executed on this node. |
notes_template |
string | False | default | Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\' respectively. |
performance |
string | False | default | Other performance-related settings. |
pigz |
integer | False | default | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. |
pool |
string | False | default | Backup all known guest systems included in the specified pool. |
protected |
boolean | False | default | If true, mark backup(s) as protected. |
prune_backups |
string | False | default | Use these retention options instead of those from the storage configuration. |
quiet |
boolean | False | default | Be quiet. |
remove |
boolean | False | default | Prune older backups according to 'prune-backups'. |
repeat_missed |
boolean | False | default | If true, the job will be run as soon as possible if it was missed while the scheduler was not running. |
schedule |
string | False | default | Backup schedule. The format is a subset of systemd calendar events. |
script |
string | False | default | Use specified hook script. |
starttime |
string | False | default | Job Start time. |
stdexcludes |
boolean | False | default | Exclude temporary files and logs. |
stop |
boolean | False | default | Stop running backup jobs on this host. |
stopwait |
integer | False | default | Maximal time to wait until a guest system is stopped (minutes). |
storage |
string | False | default | Store resulting file to this storage. |
tmpdir |
string | False | default | Store temporary files to specified directory. |
vmid |
string | False | default | The ID of the guest system you want to backup. |
zstd |
integer | False | default | Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count. |
profile_name |
string | False | default | The profile to use to run the action. |
Wipe a disk or partition.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
disk |
string | True | default | Block device name |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get automatically generated cloudinit config.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
prox_type |
string | True | default | Config type. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Start service.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
service |
string | True | default | Service ID |
profile_name |
string | False | default | The profile to use to run the action. |
Write /etc/hosts.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
data |
string | True | default | The target content of /etc/hosts. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Migration tunnel endpoint - only for internal use by VM migration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bridges |
string | False | default | List of network bridges to check availability. Will be checked again for actually used bridges during migration. |
node |
string | True | default | The cluster node name. |
storages |
string | False | default | List of storages to check permission and availability. Will be checked again for all actually used storages during migration. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Destroy Ceph Monitor and Manager.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
monid |
string | True | default | Monitor ID |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get HA groups.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Create new rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | True | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | True | default | Rule type. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete sdn dns object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
dns |
string | True | default | The SDN dns object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
List vzdump backup schedule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Set node configuration options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
acme |
string | False | default | Node specific ACME settings. |
acmedomain_list |
string | False | default | ACME domain and validation plugin |
delete |
string | False | default | A list of settings you want to delete. |
description |
string | False | default | Description for the Node. Shown in the web-interface node notes panel. This is saved as comment inside the configuration file. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
node |
string | True | default | The cluster node name. |
startall_onboot_delay |
integer | False | default | Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled. |
wakeonlan |
string | False | default | MAC address for wake on LAN |
profile_name |
string | False | default | The profile to use to run the action. |
SDN subnets index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
pending |
boolean | False | default | Display pending config. |
running |
boolean | False | default | Display running config. |
vnet |
string | True | default | The SDN vnet object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Create an LVM thinpool
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
add_storage |
boolean | False | default | Configure storage using the thinpool. |
device |
string | True | default | The block device you want to create the thinpool on. |
name |
string | True | default | The storage identifier. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
OSD index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
osdid |
integer | True | default | OSD ID |
profile_name |
string | False | default | The profile to use to run the action. |
Reads the given file via guest agent. Is limited to 16777216 bytes.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
file |
string | True | default | The path to the file |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Modify rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | False | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
delete |
string | False | default | A list of settings you want to delete. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
moveto |
integer | False | default | Move rule to new position . Other arguments are ignored. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | False | default | Rule type. |
profile_name |
string | False | default | The profile to use to run the action. |
Copy a volume. This is experimental code - do not use.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
storage |
string | False | default | The storage identifier. |
target |
string | True | default | Target volume identifier |
target_node |
string | False | default | Target node. Default is local node. |
volume |
string | True | default | Source volume identifier |
profile_name |
string | False | default | The profile to use to run the action. |
Stop the container. This will abruptly stop all processes running in the container.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create backup.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_all |
boolean | False | default | Backup all known guest systems on this host. |
bwlimit |
integer | False | default | Limit I/O bandwidth (in KiB/s). |
compress |
string | False | default | Compress dump file. |
dumpdir |
string | False | default | Store resulting files to specified directory. |
exclude |
string | False | default | Exclude specified guest systems (assumes --all) |
exclude_path |
array | False | default | Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. |
ionice |
integer | False | default | Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. |
lockwait |
integer | False | default | Maximal time to wait for the global lock (minutes). |
mailnotification |
string | False | default | Specify when to send an email |
mailto |
string | False | default | Comma-separated list of email addresses or users that should receive email notifications. |
maxfiles |
integer | False | default | Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. |
mode |
string | False | default | Backup mode. |
node |
string | False | default | Only run if executed on this node. |
notes_template |
string | False | default | Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\' respectively. |
performance |
string | False | default | Other performance-related settings. |
pigz |
integer | False | default | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. |
pool |
string | False | default | Backup all known guest systems included in the specified pool. |
protected |
boolean | False | default | If true, mark backup(s) as protected. |
prune_backups |
string | False | default | Use these retention options instead of those from the storage configuration. |
quiet |
boolean | False | default | Be quiet. |
remove |
boolean | False | default | Prune older backups according to 'prune-backups'. |
script |
string | False | default | Use specified hook script. |
stdexcludes |
boolean | False | default | Exclude temporary files and logs. |
stdout |
boolean | False | default | Write tar to stdout, not to a file. |
stop |
boolean | False | default | Stop running backup jobs on this host. |
stopwait |
integer | False | default | Maximal time to wait until a guest system is stopped (minutes). |
storage |
string | False | default | Store resulting file to this storage. |
tmpdir |
string | False | default | Store temporary files to specified directory. |
vmid |
string | False | default | The ID of the guest system you want to backup. |
zstd |
integer | False | default | Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count. |
profile_name |
string | False | default | The profile to use to run the action. |
Retrieve effective permissions of given user/token.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
path |
string | False | default | Only dump this specific path, not the whole tree. |
userid |
string | False | default | User ID or full API token ID |
profile_name |
string | False | default | The profile to use to run the action. |
List Zpools.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
List storage content.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
content |
string | False | default | Only list content of this type. |
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage identifier. |
vmid |
integer | False | default | Only list images for this VM |
profile_name |
string | False | default | The profile to use to run the action. |
Request resource migration (online) to another node.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | Target node. |
sid |
string | True | default | HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). |
profile_name |
string | False | default | The profile to use to run the action. |
Index of available pci methods
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
pciid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Get snapshot configuration
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read vzdump backup job definition.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | The job ID. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | True | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | True | default | Rule type. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Creates a TCP VNC proxy connections.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
height |
integer | False | default | sets the height of the console in pixels. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
websocket |
boolean | False | default | use websocket instead of standard VNC. |
width |
integer | False | default | sets the width of the console in pixels. |
profile_name |
string | False | default | The profile to use to run the action. |
Suspend virtual machine.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
statestorage |
string | False | default | The storage for the VM state |
todisk |
boolean | False | default | If set, suspends the VM to disk. Will be resumed on next VM start. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Creates a TCP VNC proxy connections.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
generate_password |
boolean | False | default | Generates a random password to be used as ticket instead of the API ticket. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
websocket |
boolean | False | default | starts websockify instead of vncproxy |
profile_name |
string | False | default | The profile to use to run the action. |
Delete ha group configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
group |
string | True | default | The HA group identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Create Ceph Manager
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | False | default | The ID for the manager, when omitted the same as the nodename |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get ceph status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Returns a list of future schedule runtimes.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
iterations |
integer | False | default | Number of event-iteration to simulate and return. |
schedule |
string | True | default | Job schedule. The format is a subset of systemd calendar events. |
starttime |
integer | False | default | UNIX timestamp to start the calculation from. Defaults to the current time. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete subscription key of this node.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
__
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Modify rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | False | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
delete |
string | False | default | A list of settings you want to delete. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
moveto |
integer | False | default | Move rule to new position . Other arguments are ignored. |
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | False | default | Rule type. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read ceph log
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
limit |
integer | False | default | Description unavailable. |
node |
string | True | default | The cluster node name. |
start |
integer | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Get user API tokens.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
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.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
forceStop |
boolean | False | default | Make sure the VM stops. |
keepActive |
boolean | False | default | Do not deactivate storage volumes. |
node |
string | True | default | The cluster node name. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
timeout |
integer | False | default | Wait maximal timeout seconds. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
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).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
fingerprint |
string | True | default | Certificate SHA 256 fingerprint. |
force |
boolean | False | default | Do not throw error if node already exists. |
hostname |
string | True | default | Hostname (or IP) of an existing cluster member. |
link_list |
string | False | default | Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) |
nodeid |
integer | False | default | Node id for this node. |
password |
string | True | True | Superuser (root) password of peer node. |
votes |
integer | False | default | Number of votes for this node |
profile_name |
string | False | default | The profile to use to run the action. |
Revert network configuration changes.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | Alias name. |
profile_name |
string | False | default | The profile to use to run the action. |
Add ACME plugin configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
api |
string | False | default | API plugin name |
data |
string | False | default | DNS plugin data. (base64 encoded) |
disable |
boolean | False | default | Flag to disable the config. |
prox_id |
string | True | default | ACME Plugin ID name |
nodes |
string | False | default | List of cluster node names. |
prox_type |
string | True | default | ACME challenge type. |
validation_delay |
integer | False | default | Extra delay in seconds to wait before requesting validation. Allows to cope with a long TTL of DNS records. |
profile_name |
string | False | default | The profile to use to run the action. |
Get PCI Mapping.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Get Ceph osd list/tree.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Update pool data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
delete |
boolean | False | default | Remove vms/storage (instead of adding it). |
poolid |
string | True | default | Description unavailable. |
storage |
string | False | default | List of storage IDs. |
vms |
string | False | default | List of virtual machines. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new pool.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
poolid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
ceph osd out
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
osdid |
integer | True | default | OSD ID |
profile_name |
string | False | default | The profile to use to run the action. |
Extract configuration from vzdump backup archive.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
volume |
string | True | default | Volume identifier |
profile_name |
string | False | default | The profile to use to run the action. |
Read Journal
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
endcursor |
string | False | default | End before the given Cursor. Conflicts with 'until' |
lastentries |
integer | False | default | Limit to the last X lines. Conflicts with a range. |
node |
string | True | default | The cluster node name. |
since |
integer | False | default | Display all log since this UNIX epoch. Conflicts with 'startcursor'. |
startcursor |
string | False | default | Start after the given Cursor. Conflicts with 'since' |
until |
integer | False | default | Display all log until this UNIX epoch. Conflicts with 'endcursor'. |
profile_name |
string | False | default | The profile to use to run the action. |
Stop all VMs and Containers.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force_stop |
boolean | False | default | Force a hard-stop after the timeout. |
node |
string | True | default | The cluster node name. |
timeout |
integer | False | default | Timeout for each guest shutdown task. Depending on force-stop , the shutdown gets then simply aborted or a hard-stop is forced. |
vms |
string | False | default | Only consider Guests with these IDs. |
profile_name |
string | False | default | The profile to use to run the action. |
Resize a container mount point.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
disk |
string | True | default | The disk you want to resize. |
node |
string | True | default | The cluster node name. |
size |
string | True | default | The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Removes a node from the cluster configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Set time zone.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
timezone |
string | True | default | Time zone. The file '/usr/share/zoneinfo/zone.tab' contains the list of valid names. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Create a new hardware mapping.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
description |
string | False | default | Description of the logical PCI device. |
prox_id |
string | True | default | The ID of the logical PCI mapping. |
prox_map |
array | True | default | A list of maps for the cluster nodes. |
mdev |
boolean | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute get-fsinfo.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
This is used to resynchronize the package index files from their sources (apt-get update).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
notify |
boolean | False | default | Send notification mail about new packages (to email address specified for user 'root@pam'). |
quiet |
boolean | False | default | Only produces output suitable for logging, omitting progress indicators. |
profile_name |
string | False | default | The profile to use to run the action. |
Destroy pool
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | If true, destroys pool even if in use |
name |
string | True | default | The name of the pool. It must be unique. |
node |
string | True | default | The cluster node name. |
remove_ecprofile |
boolean | False | default | Remove the erasure code profile. Defaults to true, if applicable. |
remove_storages |
boolean | False | default | Remove all pveceph-managed storages configured for this pool |
profile_name |
string | False | default | The profile to use to run the action. |
Read service properties
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
service |
string | True | default | Service ID |
profile_name |
string | False | default | The profile to use to run the action. |
Node index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Opens a weksocket for VNC traffic.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
port |
integer | True | default | Port number returned by previous vncproxy call. |
vmid |
integer | True | default | The (unique) ID of the VM. |
vncticket |
string | True | default | Ticket from previous call to vncproxy. |
profile_name |
string | False | default | The profile to use to run the action. |
List LVM Volume Groups
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Scan remote iSCSI server.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
portal |
string | True | default | The iSCSI portal (IP or DNS name with optional port). |
profile_name |
string | False | default | The profile to use to run the action. |
List IPSets
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Retrieve ACME TermsOfService URL from CA.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
directory |
string | False | default | URL of ACME CA directory endpoint. |
profile_name |
string | False | default | The profile to use to run the action. |
List rules.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Set datacenter options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bwlimit |
string | False | default | Set I/O bandwidth limit for various operations (in KiB/s). |
console |
string | False | default | Select the default Console viewer. You can either use the builtin java applet (VNC; deprecated and maps to html5), an external virt-viewer comtatible application (SPICE), an HTML5 based vnc viewer (noVNC), or an HTML5 based console client (xtermjs). If the selected viewer is not available (e.g. SPICE not activated for the VM), the fallback is noVNC. |
crs |
string | False | default | Cluster resource scheduling settings. |
delete |
string | False | default | A list of settings you want to delete. |
description |
string | False | default | Datacenter description. Shown in the web-interface datacenter notes panel. This is saved as comment inside the configuration file. |
email_from |
string | False | default | Specify email address to send notification from (default is root@$hostname) |
fencing |
string | False | default | Set the fencing mode of the HA cluster. Hardware mode needs a valid configuration of fence devices in /etc/pve/ha/fence.cfg. With both all two modes are used. WARNING: 'hardware' and 'both' are EXPERIMENTAL & WIP |
ha |
string | False | default | Cluster wide HA settings. |
http_proxy |
string | False | default | Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/') |
keyboard |
string | False | default | Default keybord layout for vnc server. |
language |
string | False | default | Default GUI language. |
mac_prefix |
string | False | default | Prefix for autogenerated MAC addresses. |
max_workers |
integer | False | default | Defines how many workers (per node) are maximal started on actions like 'stopall VMs' or task from the ha-manager. |
migration |
string | False | default | For cluster wide migration settings. |
migration_unsecure |
boolean | False | default | 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! |
next_id |
string | False | default | Control the range for the free VMID auto-selection pool. |
notify |
string | False | default | Cluster-wide notification settings. |
registered_tags |
string | False | default | 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 . |
tag_style |
string | False | default | Tag style options. |
u2f |
string | False | default | u2f |
user_tag_access |
string | False | default | Privilege options for user-settable tags |
webauthn |
string | False | default | webauthn configuration |
profile_name |
string | False | default | The profile to use to run the action. |
Execute suspend-disk.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Stop a task.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
upid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
List local USB devices.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
List local LVM volume groups.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Add a TFA entry for a user.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
challenge |
string | False | default | When responding to a u2f challenge: the original challenge string |
description |
string | False | default | A description to distinguish multiple entries from one another |
password |
string | False | True | The current password. |
totp |
string | False | default | A totp URI. |
prox_type |
string | True | default | TFA Entry Type. |
userid |
string | True | default | Full User ID, in the name@realm format. |
value |
string | False | default | The current value for the provided totp URI, or a Webauthn/U2F challenge response |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new sdn ipam object.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
ipam |
string | True | default | The SDN ipam object identifier. |
section |
integer | False | default | Description unavailable. |
token |
string | False | default | Description unavailable. |
prox_type |
string | True | default | Plugin type. |
url |
string | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Update IP or Network alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | Alias name. |
rename |
string | False | default | Rename an existing alias. |
profile_name |
string | False | default | The profile to use to run the action. |
Get single rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
group |
string | True | default | Security Group name. |
pos |
integer | False | default | Update rule at position . |
profile_name |
string | False | default | The profile to use to run the action. |
Read node status
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Update API token for a specific user.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
expire |
integer | False | default | API token expiration date (seconds since epoch). '0' means no expiration date. |
privsep |
boolean | False | default | Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user. |
tokenid |
string | True | default | User-specific token identifier. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Sets the password for the given user to the given password
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
crypted |
boolean | False | default | set to 1 if the password has already been passed through crypt() |
node |
string | True | default | The cluster node name. |
password |
string | True | True | The new password. |
username |
string | True | default | The user to set the password for. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update IP or Network alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | Alias name. |
node |
string | True | default | The cluster node name. |
rename |
string | False | default | Rename an existing alias. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read sdn ipam configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
ipam |
string | True | default | The SDN ipam object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Get host firewall options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new IPSet
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
rename |
string | False | default | Rename an existing IPSet. You can set 'rename' to the same value as 'name' to update the 'comment' of an existing IPSet. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new external metric server config
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
api_path_prefix |
string | False | default | An API path prefix inserted between ':/' and '/api2/'. Can be useful if the InfluxDB service runs behind a reverse proxy. |
bucket |
string | False | default | The InfluxDB bucket/db. Only necessary when using the http v2 api. |
disable |
boolean | False | default | Flag to disable the plugin. |
prox_id |
string | True | default | The ID of the entry. |
influxdbproto |
string | False | default | Description unavailable. |
max_body_size |
integer | False | default | InfluxDB max-body-size in bytes. Requests are batched up to this size. |
mtu |
integer | False | default | MTU for metrics transmission over UDP |
organization |
string | False | default | The InfluxDB organization. Only necessary when using the http v2 api. Has no meaning when using v2 compatibility api. |
path |
string | False | default | root graphite path (ex: proxmox.mycluster.mykey) |
port |
integer | True | default | server network port |
proto |
string | False | default | Protocol to send graphite data. TCP or UDP (default) |
server |
string | True | default | server dns name or IP address |
timeout |
integer | False | default | graphite TCP socket timeout (default=1) |
token |
string | False | default | The InfluxDB access token. Only necessary when using the http v2 api. If the v2 compatibility api is used, use 'user:password' instead. |
prox_type |
string | True | default | Plugin type. |
verify_certificate |
boolean | False | default | Set to 0 to disable certificate verification for https endpoints. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Schedule replication job to start as soon as possible.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read firewall log
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
limit |
integer | False | default | Description unavailable. |
node |
string | True | default | The cluster node name. |
since |
integer | False | default | Display log since this UNIX epoch. |
start |
integer | False | default | Description unavailable. |
until |
integer | False | default | Display log until this UNIX epoch. |
profile_name |
string | False | default | The profile to use to run the action. |
Read storage RRD statistics.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cf |
string | False | default | The RRD consolidation function |
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage identifier. |
timeframe |
string | True | default | Specify the time frame you are interested in. |
profile_name |
string | False | default | The profile to use to run the action. |
Add IP or Network to IPSet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
nomatch |
boolean | False | default | Description unavailable. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read DNS settings.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get USB Mapping.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete realm-sync job definition.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Get status for all datastores.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
content |
string | False | default | Only list stores which support this content type. |
enabled |
boolean | False | default | Only list stores which are enabled (not disabled in config). |
prox_format |
boolean | False | default | Include information about formats |
node |
string | True | default | The cluster node name. |
storage |
string | False | default | Only list status for specified storage |
target |
string | False | default | If target is different to 'node', we only lists shared storages which content is accessible on this 'node' and the specified 'target' node. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete sdn vnet object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
vnet |
string | True | default | The SDN vnet object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Destroy the VM and all used/owned volumes. Removes any VM specific permissions and firewall rules
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
destroy_unreferenced_disks |
boolean | False | default | If set, destroy additionally all disks not referenced in the config but with a matching VMID from all enabled storages. |
node |
string | True | default | The cluster node name. |
purge |
boolean | False | default | Remove VMID from configurations, like backup & replication jobs and HA. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get node configuration options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
prox_property |
string | False | default | Return only a specific property from the node configuration. |
profile_name |
string | False | default | The profile to use to run the action. |
Create or restore a virtual machine.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
acpi |
boolean | False | default | Enable/disable ACPI. |
affinity |
string | False | default | List of host cores used to execute guest processes, for example: 0,5,8-11 |
agent |
string | False | default | Enable/disable communication with the QEMU Guest Agent and its properties. |
arch |
string | False | default | Virtual processor architecture. Defaults to the host. |
archive |
string | False | default | 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. |
args |
string | False | default | Arbitrary arguments passed to kvm. |
audio0 |
string | False | default | Configure a audio device, useful in combination with QXL/Spice. |
autostart |
boolean | False | default | Automatic restart after crash (currently ignored). |
balloon |
integer | False | default | Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. |
bios |
string | False | default | Select BIOS implementation. |
boot |
string | False | default | Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. |
bootdisk |
string | False | default | Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. |
bwlimit |
integer | False | default | Override I/O bandwidth limit (in KiB/s). |
cdrom |
string | False | default | This is an alias for option -ide2 |
cicustom |
string | False | default | cloud-init: Specify custom files to replace the automatically generated ones at start. |
cipassword |
string | False | default | cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. |
citype |
string | False | default | Specifies the cloud-init configuration format. The default depends on the configured operating system type (ostype . We use the nocloud format for Linux, and configdrive2 for windows. |
ciupgrade |
boolean | False | default | cloud-init: do an automatic package upgrade after the first boot. |
ciuser |
string | False | default | cloud-init: User name to change ssh keys and password for instead of the image's configured default user. |
cores |
integer | False | default | The number of cores per socket. |
cpu |
string | False | default | Emulated CPU type. |
cpulimit |
number | False | default | Limit of CPU usage. |
cpuunits |
integer | False | default | CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. |
description |
string | False | default | Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. |
efidisk0 |
string | False | default | 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. |
force |
boolean | False | default | Allow to overwrite existing VM. |
freeze |
boolean | False | default | Freeze CPU at startup (use 'c' monitor command to start execution). |
hookscript |
string | False | default | Script that will be executed during various steps in the vms lifetime. |
hostpci_list |
string | False | default | Map host PCI devices into guest. |
hotplug |
string | False | default | Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default network,disk,usb . USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. |
hugepages |
string | False | default | Enable/disable hugepages memory. |
ide_list |
string | False | default | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
ipconfig_list |
string | False | default | _cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. _ |
ivshmem |
string | False | default | Inter-VM shared memory. Useful for direct communication between VMs, or to the host. |
keephugepages |
boolean | False | default | Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. |
keyboard |
string | False | default | Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. |
kvm |
boolean | False | default | Enable/disable KVM hardware virtualization. |
live_restore |
boolean | False | default | Start the VM immediately from the backup and restore in background. PBS only. |
localtime |
boolean | False | default | Set the real time clock (RTC) to local time. This is enabled by default if the ostype indicates a Microsoft Windows OS. |
lock |
string | False | default | Lock/unlock the VM. |
machine |
string | False | default | Specifies the QEMU machine type. |
memory |
integer | False | default | Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. |
migrate_downtime |
number | False | default | Set maximum tolerated downtime (in seconds) for migrations. |
migrate_speed |
integer | False | default | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. |
name |
string | False | default | Set a name for the VM. Only used on the configuration web interface. |
nameserver |
string | False | default | cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
net_list |
string | False | default | Specify network devices. |
node |
string | True | default | The cluster node name. |
numa |
boolean | False | default | Enable/disable NUMA. |
numa_list |
string | False | default | NUMA topology. |
onboot |
boolean | False | default | Specifies whether a VM will be started during system bootup. |
ostype |
string | False | default | Specify guest operating system. |
parallel_list |
string | False | default | Map host parallel devices (n is 0 to 2). |
pool |
string | False | default | Add the VM to the specified pool. |
protection |
boolean | False | default | Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. |
reboot |
boolean | False | default | Allow reboot. If set to '0' the VM exit on reboot. |
rng0 |
string | False | default | Configure a VirtIO-based Random Number Generator. |
sata_list |
string | False | default | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
scsi_list |
string | False | default | Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
scsihw |
string | False | default | SCSI controller model |
searchdomain |
string | False | default | cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
serial_list |
string | False | default | Create a serial device inside the VM (n is 0 to 3) |
shares |
integer | False | default | Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. |
smbios1 |
string | False | default | Specify SMBIOS type 1 fields. |
smp |
integer | False | default | The number of CPUs. Please use option -sockets instead. |
sockets |
integer | False | default | The number of CPU sockets. |
spice_enhancements |
string | False | default | Configure additional enhancements for SPICE. |
sshkeys |
string | False | default | cloud-init: Setup public SSH keys (one key per line, OpenSSH format). |
start |
boolean | False | default | Start VM after it was created successfully. |
startdate |
string | False | default | Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. |
startup |
string | False | default | Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. |
storage |
string | False | default | Default storage. |
tablet |
boolean | False | default | Enable/disable the USB tablet device. |
tags |
string | False | default | Tags of the VM. This is only meta information. |
tdf |
boolean | False | default | Enable/disable time drift fix. |
template |
boolean | False | default | Enable/disable Template. |
tpmstate0 |
string | False | default | Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
unique |
boolean | False | default | Assign a unique random ethernet address. |
unused_list |
string | False | default | Reference to unused volumes. This is used internally, and should not be modified manually. |
usb_list |
string | False | default | Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). |
vcpus |
integer | False | default | Number of hotplugged vcpus. |
vga |
string | False | default | Configure the VGA hardware. |
virtio_list |
string | False | default | Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
vmgenid |
string | False | default | Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. |
vmid |
integer | True | default | The (unique) ID of the VM. |
vmstatestorage |
string | False | default | Default storage for VM state volumes/files. |
watchdog |
string | False | default | Create a virtual hardware watchdog device. |
profile_name |
string | False | default | The profile to use to run the action. |
Destroy Ceph Metadata Server
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | The name (ID) of the mds |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete group.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
groupid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
PVE Managed Directory storages.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Update ha group configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description. |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
group |
string | True | default | The HA group identifier. |
nodes |
string | False | default | List of cluster node names with optional priority. |
nofailback |
boolean | False | default | The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior. |
restricted |
boolean | False | default | Resources bound to restricted groups may only run on nodes defined by the group. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute QEMU monitor commands.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
command |
string | True | default | The monitor command. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read IP or Network settings from IPSet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete network device configuration
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
iface |
string | True | default | Network interface name. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
List rules.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index for apt (Advanced Package Tool).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Node capabilities index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Update user configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
append |
boolean | False | default | Description unavailable. |
comment |
string | False | default | Description unavailable. |
email |
string | False | default | Description unavailable. |
enable |
boolean | False | default | Enable the account (default). You can set this to '0' to disable the account |
expire |
integer | False | default | Account expiration date (seconds since epoch). '0' means no expiration date. |
firstname |
string | False | default | Description unavailable. |
groups |
string | False | default | Description unavailable. |
keys |
string | False | default | Keys for two factor auth (yubico). |
lastname |
string | False | default | Description unavailable. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Renew existing certificate from CA.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | Force renewal even if expiry is more than 30 days away. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get VM firewall options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Show the current pool status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | The name of the pool. It must be unique. |
node |
string | True | default | The cluster node name. |
verbose |
boolean | False | default | If enabled, will display additional data(eg. statistics). |
profile_name |
string | False | default | The profile to use to run the action. |
Create IP or Network Alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
name |
string | True | default | Alias name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
MDS directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get Access Control List (ACLs).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Get details about a zpool.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | True | default | The storage identifier. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get virtual machine status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new group.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
groupid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Create Ceph pool
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
add_storages |
boolean | False | default | Configure VM and CT storage using the new pool. |
application |
string | False | default | The application of the pool. |
crush_rule |
string | False | default | The rule to use for mapping object placement in the cluster. |
erasure_coding |
string | False | default | 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. |
min_size |
integer | False | default | Minimum number of replicas per object |
name |
string | True | default | The name of the pool. It must be unique. |
node |
string | True | default | The cluster node name. |
pg_autoscale_mode |
string | False | default | The automatic PG scaling mode of the pool. |
pg_num |
integer | False | default | Number of placement groups. |
pg_num_min |
integer | False | default | Minimal number of placement groups. |
size |
integer | False | default | Number of replicas per object |
target_size |
string | False | default | The estimated target size of the pool for the PG autoscaler. |
target_size_ratio |
number | False | default | The estimated target ratio of the pool for the PG autoscaler. |
profile_name |
string | False | default | The profile to use to run the action. |
Rollback VM state to specified snapshot.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
start |
boolean | False | default | Whether the VM should get started after rolling back successfully. (Note: VMs will be automatically started if the snapshot includes RAM.) |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Allocate disk images.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
filename |
string | True | default | The name of the file to create. |
prox_format |
string | False | default | Description unavailable. |
node |
string | True | default | The cluster node name. |
size |
string | True | default | Size in kilobyte (1024 bytes). Optional suffixes 'M' (megabyte, 1024K) and 'G' (gigabyte, 1024M) |
storage |
string | True | default | The storage identifier. |
vmid |
integer | True | default | Specify owner VM |
profile_name |
string | False | default | The profile to use to run the action. |
Create a container clone/copy
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bwlimit |
number | False | default | Override I/O bandwidth limit (in KiB/s). |
description |
string | False | default | Description for the new CT. |
full |
boolean | False | default | Create a full copy of all disks. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default. |
hostname |
string | False | default | Set a hostname for the new CT. |
newid |
integer | True | default | VMID for the clone. |
node |
string | True | default | The cluster node name. |
pool |
string | False | default | Add the new CT to the specified pool. |
snapname |
string | False | default | The name of the snapshot. |
storage |
string | False | default | Target storage for full clone. |
target |
string | False | default | Target node. Only allowed if the original VM is on shared storage. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get APT repository information.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get specific API token information.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
tokenid |
string | True | default | User-specific token identifier. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
acpi |
boolean | False | default | Enable/disable ACPI. |
affinity |
string | False | default | List of host cores used to execute guest processes, for example: 0,5,8-11 |
agent |
string | False | default | Enable/disable communication with the QEMU Guest Agent and its properties. |
arch |
string | False | default | Virtual processor architecture. Defaults to the host. |
args |
string | False | default | Arbitrary arguments passed to kvm. |
audio0 |
string | False | default | Configure a audio device, useful in combination with QXL/Spice. |
autostart |
boolean | False | default | Automatic restart after crash (currently ignored). |
balloon |
integer | False | default | Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. |
bios |
string | False | default | Select BIOS implementation. |
boot |
string | False | default | Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. |
bootdisk |
string | False | default | Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. |
cdrom |
string | False | default | This is an alias for option -ide2 |
cicustom |
string | False | default | cloud-init: Specify custom files to replace the automatically generated ones at start. |
cipassword |
string | False | default | cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. |
citype |
string | False | default | Specifies the cloud-init configuration format. The default depends on the configured operating system type (ostype . We use the nocloud format for Linux, and configdrive2 for windows. |
ciupgrade |
boolean | False | default | cloud-init: do an automatic package upgrade after the first boot. |
ciuser |
string | False | default | cloud-init: User name to change ssh keys and password for instead of the image's configured default user. |
cores |
integer | False | default | The number of cores per socket. |
cpu |
string | False | default | Emulated CPU type. |
cpulimit |
number | False | default | Limit of CPU usage. |
cpuunits |
integer | False | default | CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. |
delete |
string | False | default | A list of settings you want to delete. |
description |
string | False | default | Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
efidisk0 |
string | False | default | 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. |
force |
boolean | False | default | 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. |
freeze |
boolean | False | default | Freeze CPU at startup (use 'c' monitor command to start execution). |
hookscript |
string | False | default | Script that will be executed during various steps in the vms lifetime. |
hostpci_list |
string | False | default | Map host PCI devices into guest. |
hotplug |
string | False | default | Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default network,disk,usb . USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. |
hugepages |
string | False | default | Enable/disable hugepages memory. |
ide_list |
string | False | default | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
ipconfig_list |
string | False | default | _cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. _ |
ivshmem |
string | False | default | Inter-VM shared memory. Useful for direct communication between VMs, or to the host. |
keephugepages |
boolean | False | default | Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. |
keyboard |
string | False | default | Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. |
kvm |
boolean | False | default | Enable/disable KVM hardware virtualization. |
localtime |
boolean | False | default | Set the real time clock (RTC) to local time. This is enabled by default if the ostype indicates a Microsoft Windows OS. |
lock |
string | False | default | Lock/unlock the VM. |
machine |
string | False | default | Specifies the QEMU machine type. |
memory |
integer | False | default | Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. |
migrate_downtime |
number | False | default | Set maximum tolerated downtime (in seconds) for migrations. |
migrate_speed |
integer | False | default | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. |
name |
string | False | default | Set a name for the VM. Only used on the configuration web interface. |
nameserver |
string | False | default | cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
net_list |
string | False | default | Specify network devices. |
node |
string | True | default | The cluster node name. |
numa |
boolean | False | default | Enable/disable NUMA. |
numa_list |
string | False | default | NUMA topology. |
onboot |
boolean | False | default | Specifies whether a VM will be started during system bootup. |
ostype |
string | False | default | Specify guest operating system. |
parallel_list |
string | False | default | Map host parallel devices (n is 0 to 2). |
protection |
boolean | False | default | Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. |
reboot |
boolean | False | default | Allow reboot. If set to '0' the VM exit on reboot. |
revert |
string | False | default | Revert a pending change. |
rng0 |
string | False | default | Configure a VirtIO-based Random Number Generator. |
sata_list |
string | False | default | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
scsi_list |
string | False | default | Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
scsihw |
string | False | default | SCSI controller model |
searchdomain |
string | False | default | cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
serial_list |
string | False | default | Create a serial device inside the VM (n is 0 to 3) |
shares |
integer | False | default | Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
smbios1 |
string | False | default | Specify SMBIOS type 1 fields. |
smp |
integer | False | default | The number of CPUs. Please use option -sockets instead. |
sockets |
integer | False | default | The number of CPU sockets. |
spice_enhancements |
string | False | default | Configure additional enhancements for SPICE. |
sshkeys |
string | False | default | cloud-init: Setup public SSH keys (one key per line, OpenSSH format). |
startdate |
string | False | default | Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. |
startup |
string | False | default | Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. |
tablet |
boolean | False | default | Enable/disable the USB tablet device. |
tags |
string | False | default | Tags of the VM. This is only meta information. |
tdf |
boolean | False | default | Enable/disable time drift fix. |
template |
boolean | False | default | Enable/disable Template. |
tpmstate0 |
string | False | default | Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
unused_list |
string | False | default | Reference to unused volumes. This is used internally, and should not be modified manually. |
usb_list |
string | False | default | Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). |
vcpus |
integer | False | default | Number of hotplugged vcpus. |
vga |
string | False | default | Configure the VGA hardware. |
virtio_list |
string | False | default | Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
vmgenid |
string | False | default | Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. |
vmid |
integer | True | default | The (unique) ID of the VM. |
vmstatestorage |
string | False | default | Default storage for VM state volumes/files. |
watchdog |
string | False | default | Create a virtual hardware watchdog device. |
profile_name |
string | False | default | The profile to use to run the action. |
Set Firewall options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
enable |
boolean | False | default | Enable host firewall rules. |
log_level_in |
string | False | default | Log level for incoming traffic. |
log_level_out |
string | False | default | Log level for outgoing traffic. |
log_nf_conntrack |
boolean | False | default | Enable logging of conntrack information. |
ndp |
boolean | False | default | Enable NDP (Neighbor Discovery Protocol). |
nf_conntrack_allow_invalid |
boolean | False | default | Allow invalid packets on connection tracking. |
nf_conntrack_helpers |
string | False | default | Enable conntrack helpers for specific protocols. Supported protocols: amanda, ftp, irc, netbios-ns, pptp, sane, sip, snmp, tftp |
nf_conntrack_max |
integer | False | default | Maximum number of tracked connections. |
nf_conntrack_tcp_timeout_established |
integer | False | default | Conntrack established timeout. |
nf_conntrack_tcp_timeout_syn_recv |
integer | False | default | Conntrack syn recv timeout. |
node |
string | True | default | The cluster node name. |
nosmurfs |
boolean | False | default | Enable SMURFS filter. |
protection_synflood |
boolean | False | default | Enable synflood protection |
protection_synflood_burst |
integer | False | default | Synflood protection rate burst by ip src. |
protection_synflood_rate |
integer | False | default | Synflood protection rate syn/sec by ip src. |
smurf_log_level |
string | False | default | Log level for SMURFS filter. |
tcp_flags_log_level |
string | False | default | Log level for illegal tcp flags filter. |
tcpflags |
boolean | False | default | Filter illegal combinations of TCP flags. |
profile_name |
string | False | default | The profile to use to run the action. |
List configured realm-sync-jobs.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | True | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | True | default | Rule type. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute ping.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Pool index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Scan remote Proxmox Backup Server.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
fingerprint |
string | False | default | Certificate SHA 256 fingerprint. |
node |
string | True | default | The cluster node name. |
password |
string | True | True | User password or API token secret. |
port |
integer | False | default | Optional port. |
server |
string | True | default | The server address (name or IP). |
username |
string | True | default | User-name or API token-ID. |
profile_name |
string | False | default | The profile to use to run the action. |
Get the OpenId Authorization Url for the specified realm.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
realm |
string | True | default | Authentication domain ID |
redirect_url |
string | True | default | Redirection Url. The client should set this to the used server url (location.origin). |
profile_name |
string | False | default | The profile to use to run the action. |
Get available QEMU/KVM machine types.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get the virtual machine configuration with both current and pending values.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
List rules.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Check if feature for virtual machine is available.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
feature |
string | True | default | Feature to check. |
node |
string | True | default | The cluster node name. |
snapname |
string | False | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
List files and directories for single file restore under the given path.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
filepath |
string | True | default | base64-path to the directory or file being listed, or "/". |
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage identifier. |
volume |
string | True | default | Backup volume ID or name. Currently only PBS snapshots are supported. |
profile_name |
string | False | default | The profile to use to run the action. |
__
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
zone |
string | True | default | The SDN zone object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Remove an LVM thin pool.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cleanup_config |
boolean | False | default | Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). |
cleanup_disks |
boolean | False | default | Also wipe disks so they can be repurposed afterwards. |
name |
string | True | default | The storage identifier. |
node |
string | True | default | The cluster node name. |
volume_group |
string | True | default | The storage identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
ACMEAccount index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Fetch a requested TFA entry if present.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | A TFA entry id. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
DELETE custom certificate chain and key.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
restart |
boolean | False | default | Restart pveproxy. |
profile_name |
string | False | default | The profile to use to run the action. |
Register a new ACME account with CA.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
contact |
string | True | default | Contact email addresses. |
directory |
string | False | default | URL of ACME CA directory endpoint. |
name |
string | False | default | ACME account config file name. |
tos_url |
string | False | default | URL of CA TermsOfService - setting this indicates agreement. |
profile_name |
string | False | default | The profile to use to run the action. |
Scan zfs pool list on local node.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Modify rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | False | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
delete |
string | False | default | A list of settings you want to delete. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
moveto |
integer | False | default | Move rule to new position . Other arguments are ignored. |
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | False | default | Rule type. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a ZFS pool.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
add_storage |
boolean | False | default | Configure storage using the zpool. |
ashift |
integer | False | default | Pool sector size exponent. |
compression |
string | False | default | The compression algorithm to use. |
devices |
string | True | default | The block devices you want to create the zpool on. |
draid_config |
string | False | default | Description unavailable. |
name |
string | True | default | The storage identifier. |
node |
string | True | default | The cluster node name. |
raidlevel |
string | True | default | The RAID level to use. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute get-osinfo.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create an LVM Volume Group
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
add_storage |
boolean | False | default | Configure storage using the Volume Group |
device |
string | True | default | The block device you want to create the volume group on |
name |
string | True | default | The storage identifier. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Dummy. Useful for formatters which want to provide a login page.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
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.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
dry_run |
boolean | False | default | If set, does not write anything. |
enable_new |
boolean | False | default | Enable newly synced users immediately. |
full |
boolean | False | default | 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. |
purge |
boolean | False | default | DEPRECATED: use 'remove-vanished' instead. Remove ACLs for users or groups which were removed from the config during a sync. |
realm |
string | True | default | Authentication domain ID |
remove_vanished |
string | False | default | 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). |
scope |
string | False | default | Select what to sync. |
profile_name |
string | False | default | The profile to use to run the action. |
Read VM RRD statistics (returns PNG)
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cf |
string | False | default | The RRD consolidation function |
ds |
string | True | default | The list of datasources you want to display. |
node |
string | True | default | The cluster node name. |
timeframe |
string | True | default | Specify the time frame you are interested in. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Returns a SPICE configuration to connect to the VM.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
proxy |
string | False | default | 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). |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
_ Verify OpenID authorization code and create a ticket._
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
code |
string | True | default | OpenId authorization code. |
redirect_url |
string | True | default | Redirection Url. The client should set this to the used server url (location.origin). |
state |
string | True | default | OpenId state. |
profile_name |
string | False | default | The profile to use to run the action. |
Start virtual machine.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force_cpu |
string | False | default | Override QEMU's -cpu argument with the given string. |
machine |
string | False | default | Specifies the QEMU machine type. |
migratedfrom |
string | False | default | The cluster node name. |
migration_network |
string | False | default | CIDR of the (sub) network that is used for migration. |
migration_type |
string | False | default | Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. |
node |
string | True | default | The cluster node name. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
stateuri |
string | False | default | Some command save/restore state from this location. |
targetstorage |
string | False | default | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. |
timeout |
integer | False | default | Wait maximal timeout seconds. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Extend volume size.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
disk |
string | True | default | The disk you want to resize. |
node |
string | True | default | The cluster node name. |
size |
string | True | default | The new size. With the + sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get VM firewall options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
List local PCI devices.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
pci_class_blacklist |
string | False | default | A list of blacklisted PCI classes, which will not be returned. Following are filtered by default: Memory Controller (05), Bridge (06) and Processor (0b). |
verbose |
boolean | False | default | If disabled, does only print the PCI IDs. Otherwise, additional information like vendor and device will be returned. |
profile_name |
string | False | default | The profile to use to run the action. |
Update IP or Network settings
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
nomatch |
boolean | False | default | Description unavailable. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get status for all zones.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Create initial ceph default configuration and setup symlinks.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cluster_network |
string | False | default | Declare a separate cluster network, OSDs will routeheartbeat, object replication and recovery traffic over it |
disable_cephx |
boolean | False | default | Disable cephx authentication. WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private! |
min_size |
integer | False | default | Minimum number of available replicas per object to allow I/O |
network |
string | False | default | Use specific network for all ceph related traffic |
node |
string | True | default | The cluster node name. |
pg_bits |
integer | False | default | Placement group bits, used to specify the default number of placement groups. NOTE: 'osd pool default pg num' does not work for default pools. |
size |
integer | False | default | Targeted number of replicas per object |
profile_name |
string | False | default | The profile to use to run the action. |
QEMU Guest Agent command index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Return existing ACME account information.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
name |
string | False | default | ACME account config file name. |
profile_name |
string | False | default | The profile to use to run the action. |
Virtual machine index (per node).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
full |
boolean | False | default | Determine the full status of active VMs. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get full HA manger status, including LRM status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Get named known ACME directory endpoints.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Remove an LVM Volume Group.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cleanup_config |
boolean | False | default | Marks associated storage(s) as not available on this node anymore or removes them from the configuration (if configured for this node only). |
cleanup_disks |
boolean | False | default | Also wipe disks so they can be repurposed afterwards. |
name |
string | True | default | The storage identifier. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Restart ceph services.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
service |
string | False | default | Ceph service name. |
profile_name |
string | False | default | The profile to use to run the action. |
Migrate virtual machine. Creates a new migration task.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bwlimit |
integer | False | default | Override I/O bandwidth limit (in KiB/s). |
force |
boolean | False | default | Allow to migrate VMs which use local devices. Only root may use this option. |
migration_network |
string | False | default | CIDR of the (sub) network that is used for migration. |
migration_type |
string | False | default | Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance. |
node |
string | True | default | The cluster node name. |
online |
boolean | False | default | Use online/live migration if VM is running. Ignored if VM is stopped. |
target |
string | True | default | Target node. |
targetstorage |
string | False | default | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. |
vmid |
integer | True | default | The (unique) ID of the VM. |
with_local_disks |
boolean | False | default | Enable live storage migration for local disk |
profile_name |
string | False | default | The profile to use to run the action. |
List security groups.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Lists possible IPSet/Alias reference which are allowed in source/dest properties.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
prox_type |
string | False | default | Only list references of specified type. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Authentication domain index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Cluster index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Unlink/delete disk images.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | 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. |
idlist |
string | True | default | A list of disk IDs you want to delete. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Corosync node list.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Create or verify authentication ticket.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
new_format |
boolean | False | default | This parameter is now ignored and assumed to be 1. |
otp |
string | False | default | One-time password for Two-factor authentication. |
password |
string | True | True | The secret password. This can also be a valid ticket. |
path |
string | False | default | Verify ticket, and check if user have access 'privs' on 'path' |
privs |
string | False | default | Verify ticket, and check if user have access 'privs' on 'path' |
realm |
string | False | default | You can optionally pass the realm using this parameter. Normally the realm is simply added to the username @. |
tfa_challenge |
string | False | default | The signed TFA challenge string the user wants to respond to. |
username |
string | True | default | User name |
profile_name |
string | False | default | The profile to use to run the action. |
Read node RRD statistics (returns PNG)
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cf |
string | False | default | The RRD consolidation function |
ds |
string | True | default | The list of datasources you want to display. |
node |
string | True | default | The cluster node name. |
timeframe |
string | True | default | Specify the time frame you are interested in. |
profile_name |
string | False | default | The profile to use to run the action. |
Set virtual machine options (asynchrounous API).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
acpi |
boolean | False | default | Enable/disable ACPI. |
affinity |
string | False | default | List of host cores used to execute guest processes, for example: 0,5,8-11 |
agent |
string | False | default | Enable/disable communication with the QEMU Guest Agent and its properties. |
arch |
string | False | default | Virtual processor architecture. Defaults to the host. |
args |
string | False | default | Arbitrary arguments passed to kvm. |
audio0 |
string | False | default | Configure a audio device, useful in combination with QXL/Spice. |
autostart |
boolean | False | default | Automatic restart after crash (currently ignored). |
background_delay |
integer | False | default | Time to wait for the task to finish. We return 'null' if the task finish within that time. |
balloon |
integer | False | default | Amount of target RAM for the VM in MiB. Using zero disables the ballon driver. |
bios |
string | False | default | Select BIOS implementation. |
boot |
string | False | default | Specify guest boot order. Use the 'order=' sub-property as usage with no key or 'legacy=' is deprecated. |
bootdisk |
string | False | default | Enable booting from specified disk. Deprecated: Use 'boot: order=foo;bar' instead. |
cdrom |
string | False | default | This is an alias for option -ide2 |
cicustom |
string | False | default | cloud-init: Specify custom files to replace the automatically generated ones at start. |
cipassword |
string | False | default | cloud-init: Password to assign the user. Using this is generally not recommended. Use ssh keys instead. Also note that older cloud-init versions do not support hashed passwords. |
citype |
string | False | default | Specifies the cloud-init configuration format. The default depends on the configured operating system type (ostype . We use the nocloud format for Linux, and configdrive2 for windows. |
ciupgrade |
boolean | False | default | cloud-init: do an automatic package upgrade after the first boot. |
ciuser |
string | False | default | cloud-init: User name to change ssh keys and password for instead of the image's configured default user. |
cores |
integer | False | default | The number of cores per socket. |
cpu |
string | False | default | Emulated CPU type. |
cpulimit |
number | False | default | Limit of CPU usage. |
cpuunits |
integer | False | default | CPU weight for a VM, will be clamped to [1, 10000] in cgroup v2. |
delete |
string | False | default | A list of settings you want to delete. |
description |
string | False | default | Description for the VM. Shown in the web-interface VM's summary. This is saved as comment inside the configuration file. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
efidisk0 |
string | False | default | 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. |
force |
boolean | False | default | 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. |
freeze |
boolean | False | default | Freeze CPU at startup (use 'c' monitor command to start execution). |
hookscript |
string | False | default | Script that will be executed during various steps in the vms lifetime. |
hostpci_list |
string | False | default | Map host PCI devices into guest. |
hotplug |
string | False | default | Selectively enable hotplug features. This is a comma separated list of hotplug features: 'network', 'disk', 'cpu', 'memory', 'usb' and 'cloudinit'. Use '0' to disable hotplug completely. Using '1' as value is an alias for the default network,disk,usb . USB hotplugging is possible for guests with machine version >= 7.1 and ostype l26 or windows > 7. |
hugepages |
string | False | default | Enable/disable hugepages memory. |
ide_list |
string | False | default | Use volume as IDE hard disk or CD-ROM (n is 0 to 3). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
ipconfig_list |
string | False | default | _cloud-init: Specify IP addresses and gateways for the corresponding interface. IP addresses use CIDR notation, gateways are optional but need an IP of the same type specified. The special string 'dhcp' can be used for IP addresses to use DHCP, in which case no explicit gateway should be provided. For IPv6 the special string 'auto' can be used to use stateless autoconfiguration. This requires cloud-init 19.4 or newer. If cloud-init is enabled and neither an IPv4 nor an IPv6 address is specified, it defaults to using dhcp on IPv4. _ |
ivshmem |
string | False | default | Inter-VM shared memory. Useful for direct communication between VMs, or to the host. |
keephugepages |
boolean | False | default | Use together with hugepages. If enabled, hugepages will not not be deleted after VM shutdown and can be used for subsequent starts. |
keyboard |
string | False | default | Keyboard layout for VNC server. This option is generally not required and is often better handled from within the guest OS. |
kvm |
boolean | False | default | Enable/disable KVM hardware virtualization. |
localtime |
boolean | False | default | Set the real time clock (RTC) to local time. This is enabled by default if the ostype indicates a Microsoft Windows OS. |
lock |
string | False | default | Lock/unlock the VM. |
machine |
string | False | default | Specifies the QEMU machine type. |
memory |
integer | False | default | Amount of RAM for the VM in MiB. This is the maximum available memory when you use the balloon device. |
migrate_downtime |
number | False | default | Set maximum tolerated downtime (in seconds) for migrations. |
migrate_speed |
integer | False | default | Set maximum speed (in MB/s) for migrations. Value 0 is no limit. |
name |
string | False | default | Set a name for the VM. Only used on the configuration web interface. |
nameserver |
string | False | default | cloud-init: Sets DNS server IP address for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
net_list |
string | False | default | Specify network devices. |
node |
string | True | default | The cluster node name. |
numa |
boolean | False | default | Enable/disable NUMA. |
numa_list |
string | False | default | NUMA topology. |
onboot |
boolean | False | default | Specifies whether a VM will be started during system bootup. |
ostype |
string | False | default | Specify guest operating system. |
parallel_list |
string | False | default | Map host parallel devices (n is 0 to 2). |
protection |
boolean | False | default | Sets the protection flag of the VM. This will disable the remove VM and remove disk operations. |
reboot |
boolean | False | default | Allow reboot. If set to '0' the VM exit on reboot. |
revert |
string | False | default | Revert a pending change. |
rng0 |
string | False | default | Configure a VirtIO-based Random Number Generator. |
sata_list |
string | False | default | Use volume as SATA hard disk or CD-ROM (n is 0 to 5). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
scsi_list |
string | False | default | Use volume as SCSI hard disk or CD-ROM (n is 0 to 30). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
scsihw |
string | False | default | SCSI controller model |
searchdomain |
string | False | default | cloud-init: Sets DNS search domains for a container. Create will automatically use the setting from the host if neither searchdomain nor nameserver are set. |
serial_list |
string | False | default | Create a serial device inside the VM (n is 0 to 3) |
shares |
integer | False | default | Amount of memory shares for auto-ballooning. The larger the number is, the more memory this VM gets. Number is relative to weights of all other running VMs. Using zero disables auto-ballooning. Auto-ballooning is done by pvestatd. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
smbios1 |
string | False | default | Specify SMBIOS type 1 fields. |
smp |
integer | False | default | The number of CPUs. Please use option -sockets instead. |
sockets |
integer | False | default | The number of CPU sockets. |
spice_enhancements |
string | False | default | Configure additional enhancements for SPICE. |
sshkeys |
string | False | default | cloud-init: Setup public SSH keys (one key per line, OpenSSH format). |
startdate |
string | False | default | Set the initial date of the real time clock. Valid format for date are:'now' or '2006-06-17T16:01:21' or '2006-06-17'. |
startup |
string | False | default | Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped. |
tablet |
boolean | False | default | Enable/disable the USB tablet device. |
tags |
string | False | default | Tags of the VM. This is only meta information. |
tdf |
boolean | False | default | Enable/disable time drift fix. |
template |
boolean | False | default | Enable/disable Template. |
tpmstate0 |
string | False | default | Configure a Disk for storing TPM state. The format is fixed to 'raw'. Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Note that SIZE_IN_GiB is ignored here and 4 MiB will be used instead. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
unused_list |
string | False | default | Reference to unused volumes. This is used internally, and should not be modified manually. |
usb_list |
string | False | default | Configure an USB device (n is 0 to 4, for machine version >= 7.1 and ostype l26 or windows > 7, n can be up to 14). |
vcpus |
integer | False | default | Number of hotplugged vcpus. |
vga |
string | False | default | Configure the VGA hardware. |
virtio_list |
string | False | default | Use volume as VIRTIO hard disk (n is 0 to 15). Use the special syntax STORAGE_ID:SIZE_IN_GiB to allocate a new volume. Use STORAGE_ID:0 and the 'import-from' parameter to import from an existing volume. |
vmgenid |
string | False | default | Set VM Generation ID. Use '1' to autogenerate on create or update, pass '0' to disable explicitly. |
vmid |
integer | True | default | The (unique) ID of the VM. |
vmstatestorage |
string | False | default | Default storage for VM state volumes/files. |
watchdog |
string | False | default | Create a virtual hardware watchdog device. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute fstrim.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Modify rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | False | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
delete |
string | False | default | A list of settings you want to delete. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
moveto |
integer | False | default | Move rule to new position . Other arguments are ignored. |
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | False | default | Rule type. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete sdn ipam object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
ipam |
string | True | default | The SDN ipam object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Returns included guests and the backup status of their disks. Optimized to be used in ExtJS tree views.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | The job ID. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute shutdown.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Snapshot a container.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
description |
string | False | default | A textual description or comment. |
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get group configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
groupid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new hardware mapping.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
description |
string | False | default | Description of the logical PCI device. |
prox_id |
string | True | default | The ID of the logical PCI mapping. |
prox_map |
array | True | default | A list of maps for the cluster nodes. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a Template.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Add IP or Network to IPSet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
name |
string | True | default | IP set name. |
nomatch |
boolean | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
List all pools and their settings (which are settable by the POST/PUT endpoints).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | True | default | Rule action ('ACCEPT', 'DROP', 'REJECT') or security group name. |
comment |
string | False | default | Descriptive comment. |
dest |
string | False | default | Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
dport |
string | False | default | Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
enable |
integer | False | default | Flag to enable/disable a rule. |
icmp_type |
string | False | default | Specify icmp-type. Only valid if proto equals 'icmp' or 'icmpv6'/'ipv6-icmp'. |
iface |
string | False | default | Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings. |
log |
string | False | default | Log level for firewall rule. |
macro |
string | False | default | Use predefined standard macro. |
pos |
integer | False | default | Update rule at position . |
proto |
string | False | default | IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'. |
source |
string | False | default | Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists. |
sport |
string | False | default | Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges. |
prox_type |
string | True | default | Rule type. |
profile_name |
string | False | default | The profile to use to run the action. |
List IPSets
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Directory index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
List local LVM Thin Pools.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vg |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Get HA manger status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Read tap/vm network device interface counters
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get single rule data.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
pos |
integer | False | default | Update rule at position . |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Try to wake a node via 'wake on LAN' network packet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | target node for wake on LAN packet |
profile_name |
string | False | default | The profile to use to run the action. |
Get datacenter options. Without 'Sys.Audit' on '/' not all options are returned.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Create new user.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description unavailable. |
email |
string | False | default | Description unavailable. |
enable |
boolean | False | default | Enable the account (default). You can set this to '0' to disable the account |
expire |
integer | False | default | Account expiration date (seconds since epoch). '0' means no expiration date. |
firstname |
string | False | default | Description unavailable. |
groups |
string | False | default | Description unavailable. |
keys |
string | False | default | Keys for two factor auth (yubico). |
lastname |
string | False | default | Description unavailable. |
password |
string | False | True | Initial password. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Read server time and time zone settings.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new storage.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
authsupported |
string | False | default | Authsupported. |
base |
string | False | default | Base volume. This volume is automatically activated. |
blocksize |
string | False | default | block size |
bwlimit |
string | False | default | Set I/O bandwidth limit for various operations (in KiB/s). |
comstar_hg |
string | False | default | host group for comstar views |
comstar_tg |
string | False | default | target group for comstar views |
content |
string | False | default | _Allowed content types. NOTE: the value 'rootdir' is used for Containers, and value 'images' for VMs. _ |
content_dirs |
string | False | default | Overrides for default content type directories. |
create_base_path |
boolean | False | default | Create the base directory if it doesn't exist. |
create_subdirs |
boolean | False | default | Populate the directory with the default structure. |
data_pool |
string | False | default | Data Pool (for erasure coding only) |
datastore |
string | False | default | Proxmox Backup Server datastore name. |
disable |
boolean | False | default | Flag to disable the storage. |
domain |
string | False | default | CIFS domain. |
encryption_key |
string | False | default | Encryption key. Use 'autogen' to generate one automatically without passphrase. |
export |
string | False | default | NFS export path. |
fingerprint |
string | False | default | Certificate SHA 256 fingerprint. |
prox_format |
string | False | default | Default image format. |
fs_name |
string | False | default | The Ceph filesystem name. |
fuse |
boolean | False | default | Mount CephFS through FUSE. |
is_mountpoint |
string | False | default | Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field. |
iscsiprovider |
string | False | default | iscsi provider |
keyring |
string | False | default | Client keyring contents (for external clusters). |
krbd |
boolean | False | default | Always access rbd through krbd kernel module. |
lio_tpg |
string | False | default | target portal group for Linux LIO targets |
master_pubkey |
string | False | default | Base64-encoded, PEM-formatted public RSA key. Used to encrypt a copy of the encryption-key which will be added to each encrypted backup. |
max_protected_backups |
integer | False | default | Maximal number of protected backups per guest. Use '-1' for unlimited. |
maxfiles |
integer | False | default | Deprecated: use 'prune-backups' instead. Maximal number of backup files per VM. Use '0' for unlimited. |
mkdir |
boolean | False | default | Create the directory if it doesn't exist and populate it with default sub-dirs. NOTE: Deprecated, use the 'create-base-path' and 'create-subdirs' options instead. |
monhost |
string | False | default | IP addresses of monitors (for external clusters). |
mountpoint |
string | False | default | mount point |
namespace |
string | False | default | Namespace. |
nocow |
boolean | False | default | Set the NOCOW flag on files. Disables data checksumming and causes data errors to be unrecoverable from while allowing direct I/O. Only use this if data does not need to be any more safe than on a single ext4 formatted disk with no underlying raid system. |
nodes |
string | False | default | List of cluster node names. |
nowritecache |
boolean | False | default | disable write caching on the target |
options |
string | False | default | NFS/CIFS mount options (see 'man nfs' or 'man mount.cifs') |
password |
string | False | True | Password for accessing the share/datastore. |
path |
string | False | default | File system path. |
pool |
string | False | default | Pool. |
port |
integer | False | default | For non default port. |
portal |
string | False | default | iSCSI portal (IP or DNS name with optional port). |
preallocation |
string | False | default | Preallocation mode for raw and qcow2 images. Using 'metadata' on raw images results in preallocation=off. |
prune_backups |
string | False | default | The retention options with shorter intervals are processed first with --keep-last being the very first one. Each option covers a specific period of time. We say that backups within this period are covered by this option. The next option does not take care of already covered backups and only considers older backups. |
saferemove |
boolean | False | default | Zero-out data when removing LVs. |
saferemove_throughput |
string | False | default | Wipe throughput (cstream -t parameter value). |
server |
string | False | default | Server IP or DNS name. |
server2 |
string | False | default | Backup volfile server IP or DNS name. |
share |
string | False | default | CIFS share. |
shared |
boolean | False | default | Mark storage as shared. |
smbversion |
string | False | default | SMB protocol version. 'default' if not set, negotiates the highest SMB2+ version supported by both the client and server. |
sparse |
boolean | False | default | use sparse volumes |
storage |
string | True | default | The storage identifier. |
subdir |
string | False | default | Subdir to mount. |
tagged_only |
boolean | False | default | Only use logical volumes tagged with 'pve-vm-ID'. |
target |
string | False | default | iSCSI target. |
thinpool |
string | False | default | LVM thin pool LV name. |
transport |
string | False | default | Gluster transport: tcp or rdma |
prox_type |
string | True | default | Storage type. |
username |
string | False | default | RBD Id. |
vgname |
string | False | default | Volume group name. |
volume |
string | False | default | Glusterfs Volume. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute get-vcpus.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Stop virtual machine. The qemu process will exit immediately. Thisis akin to pulling the power plug of a running computer and may damage the VM data
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
keepActive |
boolean | False | default | Do not deactivate storage volumes. |
migratedfrom |
string | False | default | The cluster node name. |
node |
string | True | default | The cluster node name. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
timeout |
integer | False | default | Wait maximal timeout seconds. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
List PCI Hardware Mapping
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
check_node |
string | False | default | If given, checks the configurations on the given node for correctness, and adds relevant diagnostics for the devices to the response. |
profile_name |
string | False | default | The profile to use to run the action. |
Index of available scan methods
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Update sdn ipam object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
ipam |
string | True | default | The SDN ipam object identifier. |
section |
integer | False | default | Description unavailable. |
token |
string | False | default | Description unavailable. |
url |
string | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Shows all guests which are not covered by any backup job.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Delete role.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
roleid |
string | True | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Migration tunnel endpoint - only for internal use by CT migration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bridges |
string | False | default | List of network bridges to check availability. Will be checked again for actually used bridges during migration. |
node |
string | True | default | The cluster node name. |
storages |
string | False | default | List of storages to check permission and availability. Will be checked again for all actually used storages during migration. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get the cloudinit configuration with both current and pending values.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute get-host-name.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Move a rootfs-/mp-volume to a different storage or to a different container.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bwlimit |
number | False | default | Override I/O bandwidth limit (in KiB/s). |
delete |
boolean | False | default | Delete the original volume after successful copy. By default the original is kept as an unused volume entry. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 " . "digest. This can be used to prevent concurrent modifications. |
node |
string | True | default | The cluster node name. |
storage |
string | False | default | Target Storage. |
target_digest |
string | False | default | Prevent changes if current configuration file of the target " . "container has a different SHA1 digest. This can be used to prevent " . "concurrent modifications. |
target_vmid |
integer | False | default | The (unique) ID of the VM. |
target_volume |
string | False | default | The config key the volume will be moved to. Default is the source volume key. |
vmid |
integer | True | default | The (unique) ID of the VM. |
volume |
string | True | default | Volume which will be moved. |
profile_name |
string | False | default | The profile to use to run the action. |
Gather various systems information about a node
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete rule.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
group |
string | True | default | Security Group name. |
pos |
integer | False | default | Update rule at position . |
profile_name |
string | False | default | The profile to use to run the action. |
Set Firewall options.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
string | False | default | A list of settings you want to delete. |
dhcp |
boolean | False | default | Enable DHCP. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
enable |
boolean | False | default | Enable/disable firewall rules. |
ipfilter |
boolean | False | default | Enable default IP filters. This is equivalent to adding an empty ipfilter-net ipset for every interface. Such ipsets implicitly contain sane default restrictions such as restricting IPv6 link local addresses to the one derived from the interface's MAC address. For containers the configured IP addresses will be implicitly added. |
log_level_in |
string | False | default | Log level for incoming traffic. |
log_level_out |
string | False | default | Log level for outgoing traffic. |
macfilter |
boolean | False | default | Enable/disable MAC address filter. |
ndp |
boolean | False | default | Enable NDP (Neighbor Discovery Protocol). |
node |
string | True | default | The cluster node name. |
policy_in |
string | False | default | Input policy. |
policy_out |
string | False | default | Output policy. |
radv |
boolean | False | default | Allow sending Router Advertisement. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Add a standard repository to the configuration
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Digest to detect modifications. |
handle |
string | True | default | Handle that identifies a repository. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
List LVM thinpools
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Creates a VNC Shell proxy.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cmd |
string | False | default | Run specific command or default to login. |
cmd_opts |
string | False | default | Add parameters to a command. Encoded as null terminated strings. |
height |
integer | False | default | sets the height of the console in pixels. |
node |
string | True | default | The cluster node name. |
websocket |
boolean | False | default | use websocket instead of standard vnc. |
width |
integer | False | default | sets the width of the console in pixels. |
profile_name |
string | False | default | The profile to use to run the action. |
Rollback LXC state to specified snapshot.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
start |
boolean | False | default | Whether the container should get started after rolling back successfully |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read replication job log.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_id |
string | True | default | Replication Job ID. The ID is composed of a Guest ID and a job number, separated by a hyphen, i.e. '-'. |
limit |
integer | False | default | Description unavailable. |
node |
string | True | default | The cluster node name. |
start |
integer | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Heuristical check if it is safe to perform an action.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
action |
string | True | default | Action to check |
prox_id |
string | True | default | ID of the service |
node |
string | True | default | The cluster node name. |
service |
string | True | default | Service type |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new sdn subnet object.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
dnszoneprefix |
string | False | default | dns domain zone prefix ex: 'adm' -> .adm.mydomain.com |
gateway |
string | False | default | Subnet Gateway: Will be assign on vnet for layer3 zones |
snat |
boolean | False | default | enable masquerade for this subnet if pve-firewall |
subnet |
string | True | default | The SDN subnet object identifier. |
prox_type |
string | True | default | Description unavailable. |
vnet |
string | True | default | associated vnet |
profile_name |
string | False | default | The profile to use to run the action. |
Get SMART Health of a disk.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
disk |
string | True | default | Block device name |
healthonly |
boolean | False | default | If true returns only the health status |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Adds a node to the cluster configuration. This call is for internal use.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
apiversion |
integer | False | default | The JOIN_API_VERSION of the new node. |
force |
boolean | False | default | Do not throw error if node already exists. |
link_list |
string | False | default | Address and priority information of a single corosync link. (up to 8 links supported; link0..link7) |
new_node_ip |
string | False | default | IP Address of node to add. Used as fallback if no links are given. |
node |
string | True | default | The cluster node name. |
nodeid |
integer | False | default | Node id for this node. |
votes |
integer | False | default | Number of votes for this node |
profile_name |
string | False | default | The profile to use to run the action. |
Write DNS settings.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
dns1 |
string | False | default | First name server IP address. |
dns2 |
string | False | default | Second name server IP address. |
dns3 |
string | False | default | Third name server IP address. |
node |
string | True | default | The cluster node name. |
search |
string | True | default | Search domain for host-name lookup. |
profile_name |
string | False | default | The profile to use to run the action. |
Get pool configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
poolid |
string | True | default | Description unavailable. |
prox_type |
string | False | default | Description unavailable. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute fsfreeze-thaw.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Query metadata of an URL: file size, file name and mime type.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
url |
string | True | default | The URL to query the metadata from. |
verify_certificates |
boolean | False | default | If false, no SSL/TLS certificates will be verified. |
profile_name |
string | False | default | The profile to use to run the action. |
Add IP or Network to IPSet.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
nomatch |
boolean | False | default | Description unavailable. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Change the properties of a repository. Currently only allows enabling/disabling.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Digest to detect modifications. |
enabled |
boolean | False | default | Whether the repository should be enabled or not. |
index |
integer | True | default | Index within the file (starting from 0). |
node |
string | True | default | The cluster node name. |
path |
string | True | default | Path to the containing file. |
profile_name |
string | False | default | The profile to use to run the action. |
List HA resources.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_type |
string | False | default | Only list resources of specific type |
profile_name |
string | False | default | The profile to use to run the action. |
Update snapshot metadata.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
description |
string | False | default | A textual description or comment. |
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Read system log
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
limit |
integer | False | default | Description unavailable. |
node |
string | True | default | The cluster node name. |
service |
string | False | default | Service ID |
since |
string | False | default | Display all log since this date-time string. |
start |
integer | False | default | Description unavailable. |
until |
string | False | default | Display all log until this date-time string. |
profile_name |
string | False | default | The profile to use to run the action. |
Destroy the container (also delete all uses files).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
destroy_unreferenced_disks |
boolean | False | default | If set, destroy additionally all disks with the VMID from all enabled storages which are not referenced in the config. |
force |
boolean | False | default | Force destroy, even if running. |
node |
string | True | default | The cluster node name. |
purge |
boolean | False | default | Remove container from all related configurations. For example, backup jobs, replication jobs or HA. Related ACLs and Firewall entries will always be removed. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
List IPSets
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete a LXC snapshot.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | For removal from config file, even if removing disk snapshots fails. |
node |
string | True | default | The cluster node name. |
snapname |
string | True | default | The name of the snapshot. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update resource configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description. |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
group |
string | False | default | The HA group identifier. |
max_relocate |
integer | False | default | Maximal number of service relocate tries when a service failes to start. |
max_restart |
integer | False | default | Maximal number of tries to restart the service on a node after its start failed. |
sid |
string | True | default | HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). |
state |
string | False | default | Requested resource state. |
profile_name |
string | False | default | The profile to use to run the action. |
Creates a TCP proxy connection.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
List resource types.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Destroy OSD
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cleanup |
boolean | False | default | If set, we remove partition table entries. |
node |
string | True | default | The cluster node name. |
osdid |
integer | True | default | OSD ID |
profile_name |
string | False | default | The profile to use to run the action. |
Move volume to different storage or to a different VM.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bwlimit |
integer | False | default | Override I/O bandwidth limit (in KiB/s). |
delete |
boolean | False | default | Delete the original disk after successful copy. By default the original disk is kept as unused disk. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1" ." digest. This can be used to prevent concurrent modifications. |
disk |
string | True | default | The disk you want to move. |
prox_format |
string | False | default | Target Format. |
node |
string | True | default | The cluster node name. |
storage |
string | False | default | Target storage. |
target_digest |
string | False | default | Prevent changes if the current config file of the target VM has a" ." different SHA1 digest. This can be used to detect concurrent modifications. |
target_disk |
string | False | default | The config key the disk will be moved to on the target VM (for example, ide0 or scsi1). Default is the source disk key. |
target_vmid |
integer | False | default | The (unique) ID of the VM. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Get OSD details
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
osdid |
integer | True | default | OSD ID |
profile_name |
string | False | default | The profile to use to run the action. |
Delete IPSet
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
force |
boolean | False | default | Delete all members of the IPSet, if there are any. |
name |
string | True | default | IP set name. |
profile_name |
string | False | default | The profile to use to run the action. |
Get ceph status.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Read task list for one node (finished tasks).
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
errors |
boolean | False | default | Only list tasks with a status of ERROR. |
limit |
integer | False | default | Only list this amount of tasks. |
node |
string | True | default | The cluster node name. |
since |
integer | False | default | Only list tasks since this UNIX epoch. |
source |
string | False | default | List archived, active or all tasks. |
start |
integer | False | default | List tasks beginning from this offset. |
statusfilter |
string | False | default | List of Task States that should be returned. |
typefilter |
string | False | default | Only list tasks of this type (e.g., vzstart, vzdump). |
until |
integer | False | default | Only list tasks until this UNIX epoch. |
userfilter |
string | False | default | Only list tasks from this user. |
vmid |
integer | False | default | Only list tasks for this VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Send key event to virtual machine.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
key |
string | True | True | The key (qemu monitor encoding). |
node |
string | True | default | The cluster node name. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
ACME index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Read node RRD statistics
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cf |
string | False | default | The RRD consolidation function |
node |
string | True | default | The cluster node name. |
timeframe |
string | True | default | Specify the time frame you are interested in. |
profile_name |
string | False | default | The profile to use to run the action. |
Node index.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Change user password.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
password |
string | True | True | The new password. |
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
List mediated device types for given PCI device.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
pciid |
string | True | default | The PCI ID to list the mdev types for. |
profile_name |
string | False | default | The profile to use to run the action. |
Get preconditions for migration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
target |
string | False | default | Target node. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
List replication jobs.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
profile_name |
string | False | default | The profile to use to run the action. |
Create a new sdn controller object.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
asn |
integer | False | default | autonomous system number |
bgp_multipath_as_path_relax |
boolean | False | default | Description unavailable. |
controller |
string | True | default | The SDN controller object identifier. |
ebgp |
boolean | False | default | Enable ebgp. (remote-as external) |
ebgp_multihop |
integer | False | default | Description unavailable. |
loopback |
string | False | default | source loopback interface. |
node |
string | False | default | The cluster node name. |
peers |
string | False | default | peers address list. |
prox_type |
string | True | default | Plugin type. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a Ceph filesystem
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
add_storage |
boolean | False | default | Configure the created CephFS as storage for this cluster. |
name |
string | False | default | The ceph filesystem name. |
node |
string | True | default | The cluster node name. |
pg_num |
integer | False | default | Number of placement groups for the backing data pool. The metadata pool will use a quarter of this. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute suspend-ram.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Directory index
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute get-time.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update a hardware mapping.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
delete |
string | False | default | A list of settings you want to delete. |
description |
string | False | default | Description of the logical PCI device. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
prox_id |
string | True | default | The ID of the logical PCI mapping. |
prox_map |
array | True | default | A list of maps for the cluster nodes. |
profile_name |
string | False | default | The profile to use to run the action. |
Update IP or Network settings
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
cidr |
string | True | default | Network/IP specification in CIDR format. |
comment |
string | False | default | Description unavailable. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | IP set name. |
node |
string | True | default | The cluster node name. |
nomatch |
boolean | False | default | Description unavailable. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Reset virtual machine.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
skiplock |
boolean | False | default | Ignore locks - only root is allowed to use this option. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Update sdn zone object configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
advertise_subnets |
boolean | False | default | Advertise evpn subnets if you have silent hosts |
bridge |
string | False | default | Description unavailable. |
bridge_disable_mac_learning |
boolean | False | default | Disable auto mac learning. |
controller |
string | False | default | Frr router name |
delete |
string | False | default | A list of settings you want to delete. |
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
disable_arp_nd_suppression |
boolean | False | default | Disable ipv4 arp && ipv6 neighbour discovery suppression |
dns |
string | False | default | dns api server |
dnszone |
string | False | default | dns domain zone ex: mydomain.com |
dp_id |
integer | False | default | Faucet dataplane id |
exitnodes |
string | False | default | List of cluster node names. |
exitnodes_local_routing |
boolean | False | default | Allow exitnodes to connect to evpn guests |
exitnodes_primary |
string | False | default | Force traffic to this exitnode first. |
ipam |
string | False | default | use a specific ipam |
mac |
string | False | default | Anycast logical router mac address |
mtu |
integer | False | default | MTU |
nodes |
string | False | default | List of cluster node names. |
peers |
string | False | default | peers address list. |
reversedns |
string | False | default | reverse dns api server |
rt_import |
string | False | default | Route-Target import |
tag |
integer | False | default | Service-VLAN Tag |
vlan_protocol |
string | False | default | Description unavailable. |
vrf_vxlan |
integer | False | default | l3vni. |
vxlan_port |
integer | False | default | Vxlan tunnel udp port (default 4789). |
zone |
string | True | default | The SDN zone object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Create network device configuration
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
address |
string | False | default | IP address. |
address6 |
string | False | default | IP address. |
autostart |
boolean | False | default | Automatically start interface on boot. |
bond_primary |
string | False | default | Specify the primary interface for active-backup bond. |
bond_mode |
string | False | default | Bonding mode. |
bond_xmit_hash_policy |
string | False | default | Selects the transmit hash policy to use for slave selection in balance-xor and 802.3ad modes. |
bridge_ports |
string | False | default | Specify the interfaces you want to add to your bridge. |
bridge_vlan_aware |
boolean | False | default | Enable bridge vlan support. |
cidr |
string | False | default | IPv4 CIDR. |
cidr6 |
string | False | default | IPv6 CIDR. |
comments |
string | False | default | Comments |
comments6 |
string | False | default | Comments |
gateway |
string | False | default | Default gateway address. |
gateway6 |
string | False | default | Default ipv6 gateway address. |
iface |
string | True | default | Network interface name. |
mtu |
integer | False | default | MTU. |
netmask |
string | False | default | Network mask. |
netmask6 |
integer | False | default | Network mask. |
node |
string | True | default | The cluster node name. |
ovs_bonds |
string | False | default | Specify the interfaces used by the bonding device. |
ovs_bridge |
string | False | default | The OVS bridge associated with a OVS port. This is required when you create an OVS port. |
ovs_options |
string | False | default | OVS interface options. |
ovs_ports |
string | False | default | Specify the interfaces you want to add to your bridge. |
ovs_tag |
integer | False | default | Specify a VLan tag (used by OVSPort, OVSIntPort, OVSBond) |
slaves |
string | False | default | Specify the interfaces used by the bonding device. |
prox_type |
string | True | default | Network interface type |
vlan_id |
integer | False | default | vlan-id for a custom named vlan interface (ifupdown2 only). |
vlan_raw_device |
string | False | default | Specify the raw interface for the vlan interface. |
profile_name |
string | False | default | The profile to use to run the action. |
Create new vzdump backup job.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
prox_all |
boolean | False | default | Backup all known guest systems on this host. |
bwlimit |
integer | False | default | Limit I/O bandwidth (in KiB/s). |
comment |
string | False | default | Description for the Job. |
compress |
string | False | default | Compress dump file. |
dow |
string | False | default | Day of week selection. |
dumpdir |
string | False | default | Store resulting files to specified directory. |
enabled |
boolean | False | default | Enable or disable the job. |
exclude |
string | False | default | Exclude specified guest systems (assumes --all) |
exclude_path |
array | False | default | Exclude certain files/directories (shell globs). Paths starting with '/' are anchored to the container's root, other paths match relative to each subdirectory. |
prox_id |
string | False | default | Job ID (will be autogenerated). |
ionice |
integer | False | default | Set IO priority when using the BFQ scheduler. For snapshot and suspend mode backups of VMs, this only affects the compressor. A value of 8 means the idle priority is used, otherwise the best-effort priority is used with the specified value. |
lockwait |
integer | False | default | Maximal time to wait for the global lock (minutes). |
mailnotification |
string | False | default | Specify when to send an email |
mailto |
string | False | default | Comma-separated list of email addresses or users that should receive email notifications. |
maxfiles |
integer | False | default | Deprecated: use 'prune-backups' instead. Maximal number of backup files per guest system. |
mode |
string | False | default | Backup mode. |
node |
string | False | default | Only run if executed on this node. |
notes_template |
string | False | default | Template string for generating notes for the backup(s). It can contain variables which will be replaced by their values. Currently supported are {{cluster}}, {{guestname}}, {{node}}, and {{vmid}}, but more might be added in the future. Needs to be a single line, newline and backslash need to be escaped as '\n' and '\' respectively. |
performance |
string | False | default | Other performance-related settings. |
pigz |
integer | False | default | Use pigz instead of gzip when N>0. N=1 uses half of cores, N>1 uses N as thread count. |
pool |
string | False | default | Backup all known guest systems included in the specified pool. |
protected |
boolean | False | default | If true, mark backup(s) as protected. |
prune_backups |
string | False | default | Use these retention options instead of those from the storage configuration. |
quiet |
boolean | False | default | Be quiet. |
remove |
boolean | False | default | Prune older backups according to 'prune-backups'. |
repeat_missed |
boolean | False | default | If true, the job will be run as soon as possible if it was missed while the scheduler was not running. |
schedule |
string | False | default | Backup schedule. The format is a subset of systemd calendar events. |
script |
string | False | default | Use specified hook script. |
starttime |
string | False | default | Job Start time. |
stdexcludes |
boolean | False | default | Exclude temporary files and logs. |
stop |
boolean | False | default | Stop running backup jobs on this host. |
stopwait |
integer | False | default | Maximal time to wait until a guest system is stopped (minutes). |
storage |
string | False | default | Store resulting file to this storage. |
tmpdir |
string | False | default | Store temporary files to specified directory. |
vmid |
string | False | default | The ID of the guest system you want to backup. |
zstd |
integer | False | default | Zstd threads. N=0 uses half of the available cores, N>0 uses N as thread count. |
profile_name |
string | False | default | The profile to use to run the action. |
Migrate virtual machine to a remote cluster. Creates a new migration task. EXPERIMENTAL feature!
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bwlimit |
integer | False | default | Override I/O bandwidth limit (in KiB/s). |
delete |
boolean | False | default | Delete the original VM and related data after successful migration. By default the original VM is kept on the source cluster in a stopped state. |
node |
string | True | default | The cluster node name. |
online |
boolean | False | default | Use online/live migration if VM is running. Ignored if VM is stopped. |
target_bridge |
string | True | default | Mapping from source to target bridges. Providing only a single bridge ID maps all source bridges to that bridge. Providing the special value '1' will map each source bridge to itself. |
target_endpoint |
string | True | default | Remote target endpoint |
target_storage |
string | True | default | Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself. |
target_vmid |
integer | False | default | The (unique) ID of the VM. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Scan remote GlusterFS server.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
node |
string | True | default | The cluster node name. |
server |
string | True | default | The server address (name or IP). |
profile_name |
string | False | default | The profile to use to run the action. |
List TFA configurations of users.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
userid |
string | True | default | Full User ID, in the name@realm format. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a new HA resource.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
comment |
string | False | default | Description. |
group |
string | False | default | The HA group identifier. |
max_relocate |
integer | False | default | Maximal number of service relocate tries when a service failes to start. |
max_restart |
integer | False | default | Maximal number of tries to restart the service on a node after its start failed. |
sid |
string | True | default | HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100). |
state |
string | False | default | Requested resource state. |
prox_type |
string | False | default | Resource type. |
profile_name |
string | False | default | The profile to use to run the action. |
Execute multiple commands in order, root only.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
commands |
string | True | default | JSON encoded array of commands. |
node |
string | True | default | The cluster node name. |
profile_name |
string | False | default | The profile to use to run the action. |
Delete storage configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
storage |
string | True | default | The storage identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Read sdn dns configuration.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
dns |
string | True | default | The SDN dns object identifier. |
profile_name |
string | False | default | The profile to use to run the action. |
Remove IP or Network alias.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
digest |
string | False | default | Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications. |
name |
string | True | default | Alias name. |
node |
string | True | default | The cluster node name. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Create a copy of virtual machine/template.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
bwlimit |
integer | False | default | Override I/O bandwidth limit (in KiB/s). |
description |
string | False | default | Description for the new VM. |
prox_format |
string | False | default | Target format for file storage. Only valid for full clone. |
full |
boolean | False | default | Create a full copy of all disks. This is always done when you clone a normal VM. For VM templates, we try to create a linked clone by default. |
name |
string | False | default | Set a name for the new VM. |
newid |
integer | True | default | VMID for the clone. |
node |
string | True | default | The cluster node name. |
pool |
string | False | default | Add the new VM to the specified pool. |
snapname |
string | False | default | The name of the snapshot. |
storage |
string | False | default | Target storage for full clone. |
target |
string | False | default | Target node. Only allowed if the original VM is on shared storage. |
vmid |
integer | True | default | The (unique) ID of the VM. |
profile_name |
string | False | default | The profile to use to run the action. |
Extract a file or directory (as zip archive) from a PBS backup.
Parameter | Type | Required | Secret | Description |
---|---|---|---|---|
filepath |
string | True | default | base64-path to the directory or file to download. |
node |
string | True | default | The cluster node name. |
storage |
string | True | default | The storage identifier. |
volume |
string | True | default | Backup volume ID or name. Currently only PBS snapshots are supported. |
profile_name |
string | False | default | The profile to use to run the action. |
There are no sensors available for this pack.
Documentation generated using pack2md