{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Mark replication job for removal.",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read replication job configuration.",
"method" : "GET",
"name" : "read",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update replication job configuration.",
"method" : "PUT",
"name" : "update",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List replication jobs.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a new replication job",
"method" : "POST",
"name" : "create",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Removes a node from the cluster configuration.",
"method" : "DELETE",
"name" : "delnode",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Adds a node to the cluster configuration. This call is for internal use.",
"method" : "POST",
"name" : "addnode",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Corosync node list.",
"method" : "GET",
"name" : "nodes",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get information needed to join this cluster over the connected node.",
"method" : "GET",
"name" : "join_info",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Joins this node into an existing cluster.",
"method" : "POST",
"name" : "join",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get corosync totem protocol settings.",
"method" : "GET",
"name" : "totem",
"leaf" : 1,
"path" : "/cluster/config/totem",
"text" : "totem"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get QDevice status",
+ "method" : "GET",
+ "name" : "status",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit"
+ ]
+ ]
+ },
+ "returns" : {
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/config/qdevice",
+ "text" : "qdevice"
}
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Generate new cluster configuration.",
"method" : "POST",
"name" : "create",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete rule.",
"method" : "DELETE",
"name" : "delete_rule",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get single rule data.",
"method" : "GET",
"name" : "get_rule",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Modify rule data.",
"method" : "PUT",
"name" : "update_rule",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete security group.",
"method" : "DELETE",
"name" : "delete_security_group",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "List rules.",
"method" : "GET",
"name" : "get_rules",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new rule.",
"method" : "POST",
"name" : "create_rule",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List security groups.",
"method" : "GET",
"name" : "list_security_groups",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new security group.",
"method" : "POST",
"name" : "create_security_group",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete rule.",
"method" : "DELETE",
"name" : "delete_rule",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get single rule data.",
"method" : "GET",
"name" : "get_rule",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Modify rule data.",
"method" : "PUT",
"name" : "update_rule",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List rules.",
"method" : "GET",
"name" : "get_rules",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new rule.",
"method" : "POST",
"name" : "create_rule",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove IP or Network from IPSet.",
"method" : "DELETE",
"name" : "remove_ip",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read IP or Network settings from IPSet.",
"method" : "GET",
"name" : "read_ip",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update IP or Network settings",
"method" : "PUT",
"name" : "update_ip",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete IPSet",
"method" : "DELETE",
"name" : "delete_ipset",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "List IPSet content",
"method" : "GET",
"name" : "get_ipset",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add IP or Network to IPSet.",
"method" : "POST",
"name" : "create_ip",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List IPSets",
"method" : "GET",
"name" : "ipset_index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new IPSet",
"method" : "POST",
"name" : "create_ipset",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove IP or Network alias.",
"method" : "DELETE",
"name" : "remove_alias",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read alias.",
"method" : "GET",
"name" : "read_alias",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update IP or Network alias.",
"method" : "PUT",
"name" : "update_alias",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List aliases",
"method" : "GET",
"name" : "get_aliases",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create IP or Network Alias.",
"method" : "POST",
"name" : "create_alias",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Firewall options.",
"method" : "GET",
"name" : "get_options",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set Firewall options.",
"method" : "PUT",
"name" : "set_options",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List available macros",
"method" : "GET",
"name" : "get_macros",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties.",
"method" : "GET",
"name" : "refs",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete vzdump backup job definition.",
"method" : "DELETE",
"name" : "delete_job",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read vzdump backup job definition.",
"method" : "GET",
"name" : "read_job",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update vzdump backup job definition.",
"method" : "PUT",
"name" : "update_job",
"type" : "integer",
"typetext" : "<integer>"
},
+ "pool" : {
+ "description" : "Backup all known guest systems included in the specified pool.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"quiet" : {
"default" : 0,
"description" : "Be quiet.",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List vzdump backup schedule.",
"method" : "GET",
"name" : "index",
"items" : {
"properties" : {
"id" : {
+ "description" : "The job ID.",
+ "maxLength" : 50,
"type" : "string"
}
},
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new vzdump backup job.",
"method" : "POST",
"name" : "create_job",
"type" : "integer",
"typetext" : "<integer>"
},
+ "pool" : {
+ "description" : "Backup all known guest systems included in the specified pool.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"quiet" : {
"default" : 0,
"description" : "Be quiet.",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Request resource migration (online) to another node.",
"method" : "POST",
"name" : "migrate",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Request resource relocatzion to another node. This stops the service on the old node, and restarts it on the target node.",
"method" : "POST",
"name" : "relocate",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete resource configuration.",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read resource configuration.",
"method" : "GET",
"name" : "read",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update resource configuration.",
"method" : "PUT",
"name" : "update",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List HA resources.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a new HA resource.",
"method" : "POST",
"name" : "create",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete ha group configuration.",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read ha group configuration.",
"method" : "GET",
"name" : "read",
"returns" : {}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update ha group configuration.",
"method" : "PUT",
"name" : "update",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get HA groups.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a new HA group.",
"method" : "POST",
"name" : "create",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get HA manger status.",
"method" : "GET",
"name" : "status",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get full HA manger status, including LRM status.",
"method" : "GET",
"name" : "manager_status",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Deactivate existing ACME account at CA.",
"method" : "DELETE",
"name" : "deactivate_account",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Return existing ACME account information.",
"method" : "GET",
"name" : "get_account",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update existing ACME account information with CA. Note: not specifying any new account information triggers a refresh.",
"method" : "PUT",
"name" : "update_account",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "ACMEAccount index.",
"method" : "GET",
"name" : "account_index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Register a new ACME account with CA.",
"method" : "POST",
"name" : "register_account",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Retrieve ACME TermsOfService URL from CA.",
"method" : "GET",
"name" : "get_tos",
},
"returns" : {
"description" : "ACME TermsOfService URL.",
+ "optional" : 1,
"type" : "string"
}
}
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get named known ACME directory endpoints.",
"method" : "GET",
"name" : "get_directories",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "ACMEAccount index.",
"method" : "GET",
"name" : "index",
"path" : "/cluster/acme",
"text" : "acme"
},
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get ceph metadata.",
+ "method" : "GET",
+ "name" : "metadata",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit",
+ "Datastore.Audit"
+ ],
+ "any",
+ 1
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/ceph/metadata",
+ "text" : "metadata"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get ceph status.",
+ "method" : "GET",
+ "name" : "status",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit",
+ "Datastore.Audit"
+ ],
+ "any",
+ 1
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/ceph/status",
+ "text" : "status"
+ },
+ {
+ "children" : [
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get the status of a specific ceph flag.",
+ "method" : "GET",
+ "name" : "get_flag",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "flag" : {
+ "description" : "The name of the flag name to get.",
+ "enum" : [
+ "nobackfill",
+ "nodeep-scrub",
+ "nodown",
+ "noin",
+ "noout",
+ "norebalance",
+ "norecover",
+ "noscrub",
+ "notieragent",
+ "noup",
+ "pause"
+ ],
+ "type" : "string"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "boolean"
+ }
+ },
+ "PUT" : {
+ "allowtoken" : 1,
+ "description" : "Set or clear (unset) a specific ceph flag",
+ "method" : "PUT",
+ "name" : "update_flag",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "flag" : {
+ "description" : "The ceph flag to update",
+ "enum" : [
+ "nobackfill",
+ "nodeep-scrub",
+ "nodown",
+ "noin",
+ "noout",
+ "norebalance",
+ "norecover",
+ "noscrub",
+ "notieragent",
+ "noup",
+ "pause"
+ ],
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "The new value of the flag",
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/cluster/ceph/flags/{flag}",
+ "text" : "{flag}"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "get the status of all ceph flags",
+ "method" : "GET",
+ "name" : "get_all_flags",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "items" : {
+ "additionalProperties" : 1,
+ "properties" : {
+ "name" : {
+ "description" : "Flag name.",
+ "enum" : [
+ "nobackfill",
+ "nodeep-scrub",
+ "nodown",
+ "noin",
+ "noout",
+ "norebalance",
+ "norecover",
+ "noscrub",
+ "notieragent",
+ "noup",
+ "pause"
+ ],
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{name}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ },
+ "PUT" : {
+ "allowtoken" : 1,
+ "description" : "Set/Unset multiple ceph flags at once.",
+ "method" : "PUT",
+ "name" : "set_flags",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "nobackfill" : {
+ "description" : "Backfilling of PGs is suspended.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "nodeep-scrub" : {
+ "description" : "Deep Scrubbing is disabled.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "nodown" : {
+ "description" : "OSD failure reports are being ignored, such that the monitors will not mark OSDs down.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "noin" : {
+ "description" : "OSDs that were previously marked out will not be marked back in when they start.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "noout" : {
+ "description" : "OSDs will not automatically be marked out after the configured interval.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "norebalance" : {
+ "description" : "Rebalancing of PGs is suspended.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "norecover" : {
+ "description" : "Recovery of PGs is suspended.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "noscrub" : {
+ "description" : "Scrubbing is disabled.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "notieragent" : {
+ "description" : "Cache tiering activity is suspended.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "noup" : {
+ "description" : "OSDs are not allowed to start.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "pause" : {
+ "description" : "Pauses read and writes.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/cluster/ceph/flags",
+ "text" : "flags"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Cluster ceph index.",
+ "method" : "GET",
+ "name" : "cephindex",
+ "parameters" : {
+ "additionalProperties" : 0
+ },
+ "permissions" : {
+ "user" : "all"
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {},
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{name}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/cluster/ceph",
+ "text" : "ceph"
+ },
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read cluster log",
"method" : "GET",
"name" : "log",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Resources index (cluster wide).",
"method" : "GET",
"name" : "resources",
"enum" : [
"vm",
"storage",
- "node"
+ "node",
+ "sdn"
],
"optional" : 1,
"type" : "string"
"pool",
"qemu",
"lxc",
- "openvz"
+ "openvz",
+ "sdn"
],
"type" : "string"
},
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List recent tasks (cluster wide).",
"method" : "GET",
"name" : "tasks",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get datacenter options.",
"method" : "GET",
"name" : "get_options",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set datacenter options.",
"method" : "PUT",
"name" : "set_options",
"format" : {
"shutdown_policy" : {
"default" : "conditional",
- "description" : "The policy for HA services on node shutdown. 'freeze' disables auto-recovery, 'failover' ensures recovery, 'conditional' recovers on poweroff and freezes on reboot. Running HA Services will always get stopped first on shutdown.",
+ "description" : "The policy for HA services on node shutdown. 'freeze' disables auto-recovery, 'failover' ensures recovery, 'conditional' recovers on poweroff and freezes on reboot. 'migrate' will migrate running services to other nodes, if possible. With 'freeze' or 'failover', HA Services will always get stopped first on shutdown.",
"enum" : [
"freeze",
"failover",
- "conditional"
+ "conditional",
+ "migrate"
],
"type" : "string",
- "verbose_description" : "Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes."
+ "verbose_description" : "Describes the policy for handling HA services on poweroff or reboot of a node. Freeze will always freeze services which are still located on the node on shutdown, those services won't be recovered by the HA manager. Failover will not mark the services as frozen and thus the services will get recovered to other nodes, if the shutdown node does not come up again quickly (< 1min). 'conditional' chooses automatically depending on the type of shutdown, i.e., on a reboot the service will be frozen but on a poweroff the service will stay as is, and thus get recovered after about 2 minutes. Migrate will try to move all running services to another node when a reboot or shutdown was triggered. The poweroff process will only continue once no running services are located on the node anymore. If the node comes up again, the service will be moved back to the previously powered-off node, at least if no other migration, reloaction or recovery took place."
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "shutdown_policy=<freeze|failover|conditional>"
+ "typetext" : "shutdown_policy=<enum>"
},
"http_proxy" : {
"description" : "Specify external http proxy which is used for downloads (example: 'http://username:password@host:port/')",
"language" : {
"description" : "Default GUI language.",
"enum" : [
- "zh_CN",
- "zh_TW",
"ca",
+ "da",
+ "de",
"en",
+ "es",
"eu",
+ "fa",
"fr",
- "de",
+ "he",
"it",
- "es",
"ja",
"nb",
"nn",
- "fa",
"pl",
"pt_BR",
"ru",
"sl",
"sv",
- "tr"
+ "tr",
+ "zh_CN",
+ "zh_TW"
],
"optional" : 1,
"type" : "string"
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get cluster status information.",
"method" : "GET",
"name" : "get_status",
"returns" : {
"items" : {
"properties" : {
+ "id" : {
+ "type" : "string"
+ },
+ "ip" : {
+ "description" : "[node] IP of the resolved nodename.",
+ "optional" : 1,
+ "type" : "string"
+ },
+ "level" : {
+ "description" : "[node] Proxmox VE Subscription level, indicates if eligible for enterprise support as well as access to the stable Proxmox VE Enterprise Repository.",
+ "optional" : 1,
+ "type" : "string"
+ },
+ "local" : {
+ "description" : "[node] Indicates if this is the responding node.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "nodeid" : {
+ "description" : "[node] ID of the node from the corosync configuration.",
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "nodes" : {
+ "description" : "[cluster] Nodes count, including offline nodes.",
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "online" : {
+ "description" : "[node] Indicates if the node is online or offline.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "quorate" : {
+ "description" : "[cluster] Indicates if there is a majority of nodes online to make decisions",
+ "optional" : 1,
+ "type" : "boolean"
+ },
"type" : {
+ "description" : "Indicates the type, either cluster or node. The type defines the object properties e.g. quorate available for type cluster.",
+ "enum" : [
+ "cluster",
+ "node"
+ ],
"type" : "string"
+ },
+ "version" : {
+ "description" : "[cluster] Current version of the corosync configuration file.",
+ "optional" : 1,
+ "type" : "integer"
}
},
"type" : "object"
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get next free VMID. If you pass an VMID it will raise an error if the ID is already used.",
"method" : "GET",
"name" : "nextid",
"leaf" : 1,
"path" : "/cluster/nextid",
"text" : "nextid"
- },
- {
- "children" : [
- {
- "info" : {
- "GET" : {
- "description" : "Get ceph metadata.",
- "method" : "GET",
- "name" : "ceph_metadata",
- "parameters" : {
- "additionalProperties" : 0
- },
- "permissions" : {
- "check" : [
- "perm",
- "/",
- [
- "Sys.Audit",
- "Datastore.Audit"
- ],
- "any",
- 1
- ]
- },
- "protected" : 1,
- "returns" : {
- "type" : "object"
- }
- }
- },
- "leaf" : 1,
- "path" : "/cluster/ceph/metadata",
- "text" : "metadata"
- },
- {
- "info" : {
- "GET" : {
- "description" : "Get ceph status.",
- "method" : "GET",
- "name" : "cephstatus",
- "parameters" : {
- "additionalProperties" : 0
- },
- "permissions" : {
- "check" : [
- "perm",
- "/",
- [
- "Sys.Audit",
- "Datastore.Audit"
- ],
- "any",
- 1
- ]
- },
- "protected" : 1,
- "returns" : {
- "type" : "object"
- }
- }
- },
- "leaf" : 1,
- "path" : "/cluster/ceph/status",
- "text" : "status"
- }
- ],
- "info" : {
- "GET" : {
- "description" : "Cluster ceph index.",
- "method" : "GET",
- "name" : "cephindex",
- "parameters" : {
- "additionalProperties" : 0
- },
- "permissions" : {
- "user" : "all"
- },
- "returns" : {
- "items" : {
- "properties" : {},
- "type" : "object"
- },
- "links" : [
- {
- "href" : "{name}",
- "rel" : "child"
- }
- ],
- "type" : "array"
- }
- }
- },
- "leaf" : 0,
- "path" : "/cluster/ceph",
- "text" : "ceph"
}
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Cluster index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete rule.",
"method" : "DELETE",
"name" : "delete_rule",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get single rule data.",
"method" : "GET",
"name" : "get_rule",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Modify rule data.",
"method" : "PUT",
"name" : "update_rule",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List rules.",
"method" : "GET",
"name" : "get_rules",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new rule.",
"method" : "POST",
"name" : "create_rule",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove IP or Network alias.",
"method" : "DELETE",
"name" : "remove_alias",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read alias.",
"method" : "GET",
"name" : "read_alias",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update IP or Network alias.",
"method" : "PUT",
"name" : "update_alias",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List aliases",
"method" : "GET",
"name" : "get_aliases",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create IP or Network Alias.",
"method" : "POST",
"name" : "create_alias",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove IP or Network from IPSet.",
"method" : "DELETE",
"name" : "remove_ip",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read IP or Network settings from IPSet.",
"method" : "GET",
"name" : "read_ip",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update IP or Network settings",
"method" : "PUT",
"name" : "update_ip",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete IPSet",
"method" : "DELETE",
"name" : "delete_ipset",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "List IPSet content",
"method" : "GET",
"name" : "get_ipset",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add IP or Network to IPSet.",
"method" : "POST",
"name" : "create_ip",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List IPSets",
"method" : "GET",
"name" : "ipset_index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new IPSet",
"method" : "POST",
"name" : "create_ipset",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get VM firewall options.",
"method" : "GET",
"name" : "get_options",
"returns" : {
"properties" : {
"dhcp" : {
+ "default" : 0,
"description" : "Enable DHCP.",
"optional" : 1,
"type" : "boolean"
},
"enable" : {
+ "default" : 0,
"description" : "Enable/disable firewall rules.",
"optional" : 1,
"type" : "boolean"
"type" : "string"
},
"macfilter" : {
+ "default" : 0,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean"
},
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set Firewall options.",
"method" : "PUT",
"name" : "set_options",
"typetext" : "<string>"
},
"dhcp" : {
+ "default" : 0,
"description" : "Enable DHCP.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<string>"
},
"enable" : {
+ "default" : 0,
"description" : "Enable/disable firewall rules.",
"optional" : 1,
"type" : "boolean",
"type" : "string"
},
"macfilter" : {
+ "default" : 0,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read firewall log",
"method" : "GET",
"name" : "log",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties.",
"method" : "GET",
"name" : "refs",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute fsfreeze-freeze.",
"method" : "POST",
"name" : "fsfreeze-freeze",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute fsfreeze-status.",
"method" : "POST",
"name" : "fsfreeze-status",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute fsfreeze-thaw.",
"method" : "POST",
"name" : "fsfreeze-thaw",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute fstrim.",
"method" : "POST",
"name" : "fstrim",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute get-fsinfo.",
"method" : "GET",
"name" : "get-fsinfo",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute get-host-name.",
"method" : "GET",
"name" : "get-host-name",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute get-memory-block-info.",
"method" : "GET",
"name" : "get-memory-block-info",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute get-memory-blocks.",
"method" : "GET",
"name" : "get-memory-blocks",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute get-osinfo.",
"method" : "GET",
"name" : "get-osinfo",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute get-time.",
"method" : "GET",
"name" : "get-time",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute get-timezone.",
"method" : "GET",
"name" : "get-timezone",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute get-users.",
"method" : "GET",
"name" : "get-users",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute get-vcpus.",
"method" : "GET",
"name" : "get-vcpus",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute info.",
"method" : "GET",
"name" : "info",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Execute network-get-interfaces.",
"method" : "GET",
"name" : "network-get-interfaces",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute ping.",
"method" : "POST",
"name" : "ping",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute shutdown.",
"method" : "POST",
"name" : "shutdown",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute suspend-disk.",
"method" : "POST",
"name" : "suspend-disk",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute suspend-hybrid.",
"method" : "POST",
"name" : "suspend-hybrid",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute suspend-ram.",
"method" : "POST",
"name" : "suspend-ram",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Sets the password for the given user to the given password",
"method" : "POST",
"name" : "set-user-password",
},
"password" : {
"description" : "The new password.",
- "maxLength" : 64,
+ "maxLength" : 1024,
"minLength" : 5,
"type" : "string",
"typetext" : "<string>"
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Executes the given command in the vm via the guest-agent and returns an object with the pid.",
"method" : "POST",
"name" : "exec",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Gets the status of the given pid started by the guest-agent",
"method" : "GET",
"name" : "exec-status",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Reads the given file via guest agent. Is limited to 16777216 bytes.",
"method" : "GET",
"name" : "file-read",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Writes the given file via guest agent.",
"method" : "POST",
"name" : "file-write",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Qemu Agent command index.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute Qemu Guest Agent commands.",
"method" : "POST",
"name" : "agent",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read VM RRD statistics (returns PNG)",
"method" : "GET",
"name" : "rrd",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read VM RRD statistics",
"method" : "GET",
"name" : "rrddata",
{
"info" : {
"GET" : {
- "description" : "Get current virtual machine configuration. This does not include pending configuration changes (see 'pending' API).",
+ "allowtoken" : 1,
+ "description" : "Get the virtual machine configuration with pending configuration changes applied. Set the 'current' parameter to get the current configuration instead.",
"method" : "GET",
"name" : "vm_config",
"parameters" : {
},
"proxyto" : "node",
"returns" : {
- "description" : "The current VM configuration.",
+ "description" : "The VM configuration.",
"properties" : {
"acpi" : {
"default" : 1,
"description" : "Run fstrim after cloning/moving a disk.",
"optional" : 1,
"type" : "boolean"
+ },
+ "type" : {
+ "default" : "virtio",
+ "description" : "Select the agent type",
+ "enum" : [
+ "virtio",
+ "isa"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
+ "audio0" : {
+ "description" : "Configure a audio device, useful in combination with QXL/Spice.",
+ "format" : {
+ "device" : {
+ "description" : "Configure an audio device.",
+ "enum" : [
+ "ich9-intel-hda",
+ "intel-hda",
+ "AC97"
+ ],
+ "type" : "string"
+ },
+ "driver" : {
+ "default" : "spice",
+ "description" : "Driver backend for the audio device.",
+ "enum" : [
+ "spice"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string"
+ },
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"Broadwell-IBRS",
"Broadwell-noTSX",
"Broadwell-noTSX-IBRS",
+ "Cascadelake-Server",
"Conroe",
"core2duo",
"coreduo",
"host",
"IvyBridge",
"IvyBridge-IBRS",
+ "KnightsMill",
"kvm32",
"kvm64",
"max",
"type" : "string"
},
"flags" : {
- "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.",
+ "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.",
"format_description" : "+FLAG[;-FLAG...]",
"optional" : 1,
- "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)",
+ "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)",
"type" : "string"
},
"hidden" : {
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"memory" : {
],
"optional" : 1,
"type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
+ "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
"description" : "Map host parallel devices (n is 0 to 2).",
"type" : "string"
},
"scsi[n]" : {
- "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
+ "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).",
"format" : {
"aio" : {
"description" : "AIO type to use.",
"optional" : 1,
"type" : "integer"
},
+ "spice_enhancements" : {
+ "description" : "Configure additional enhancements for SPICE.",
+ "format" : {
+ "foldersharing" : {
+ "default" : "0",
+ "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "videostreaming" : {
+ "default" : "off",
+ "description" : "Enable video streaming. Uses compression for detected video streams.",
+ "enum" : [
+ "off",
+ "all",
+ "filter"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string"
+ },
"sshkeys" : {
"description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
"format" : "urlencoded",
"type" : "boolean",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
+ "tags" : {
+ "description" : "Tags of the VM. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string"
+ },
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
},
"usb3" : {
"default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
+ "description" : "Specifies whether if given host option is a USB3 device or port.",
"optional" : 1,
"type" : "boolean"
}
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Set virtual machine options (asynchrounous API).",
"method" : "POST",
"name" : "update_vm_async",
"description" : "Run fstrim after cloning/moving a disk.",
"optional" : 1,
"type" : "boolean"
+ },
+ "type" : {
+ "default" : "virtio",
+ "description" : "Select the agent type",
+ "enum" : [
+ "virtio",
+ "isa"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]"
+ "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]"
},
"arch" : {
"description" : "Virtual processor architecture. Defaults to the host.",
"typetext" : "<string>",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
+ "audio0" : {
+ "description" : "Configure a audio device, useful in combination with QXL/Spice.",
+ "format" : {
+ "device" : {
+ "description" : "Configure an audio device.",
+ "enum" : [
+ "ich9-intel-hda",
+ "intel-hda",
+ "AC97"
+ ],
+ "type" : "string"
+ },
+ "driver" : {
+ "default" : "spice",
+ "description" : "Driver backend for the audio device.",
+ "enum" : [
+ "spice"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]"
+ },
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"Broadwell-IBRS",
"Broadwell-noTSX",
"Broadwell-noTSX-IBRS",
+ "Cascadelake-Server",
"Conroe",
"core2duo",
"coreduo",
"host",
"IvyBridge",
"IvyBridge-IBRS",
+ "KnightsMill",
"kvm32",
"kvm64",
"max",
"type" : "string"
},
"flags" : {
- "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.",
+ "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.",
"format_description" : "+FLAG[;-FLAG...]",
"optional" : 1,
- "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)",
+ "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)",
"type" : "string"
},
"hidden" : {
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"memory" : {
],
"optional" : 1,
"type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
+ "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
"description" : "Map host parallel devices (n is 0 to 2).",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsi[n]" : {
- "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
+ "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).",
"format" : {
"aio" : {
"description" : "AIO type to use.",
"type" : "integer",
"typetext" : "<integer> (1 - N)"
},
+ "spice_enhancements" : {
+ "description" : "Configure additional enhancements for SPICE.",
+ "format" : {
+ "foldersharing" : {
+ "default" : "0",
+ "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "videostreaming" : {
+ "default" : "off",
+ "description" : "Enable video streaming. Uses compression for detected video streams.",
+ "enum" : [
+ "off",
+ "all",
+ "filter"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]"
+ },
"sshkeys" : {
"description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
"format" : "urlencoded",
"typetext" : "<boolean>",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
+ "tags" : {
+ "description" : "Tags of the VM. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
},
"usb3" : {
"default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
+ "description" : "Specifies whether if given host option is a USB3 device or port.",
"optional" : 1,
"type" : "boolean"
}
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set virtual machine options (synchrounous API) - You should consider using the POST method instead for any actions involving hotplug or storage allocation.",
"method" : "PUT",
"name" : "update_vm",
"description" : "Run fstrim after cloning/moving a disk.",
"optional" : 1,
"type" : "boolean"
+ },
+ "type" : {
+ "default" : "virtio",
+ "description" : "Select the agent type",
+ "enum" : [
+ "virtio",
+ "isa"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]"
+ "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]"
},
"arch" : {
"description" : "Virtual processor architecture. Defaults to the host.",
"typetext" : "<string>",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
+ "audio0" : {
+ "description" : "Configure a audio device, useful in combination with QXL/Spice.",
+ "format" : {
+ "device" : {
+ "description" : "Configure an audio device.",
+ "enum" : [
+ "ich9-intel-hda",
+ "intel-hda",
+ "AC97"
+ ],
+ "type" : "string"
+ },
+ "driver" : {
+ "default" : "spice",
+ "description" : "Driver backend for the audio device.",
+ "enum" : [
+ "spice"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]"
+ },
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"Broadwell-IBRS",
"Broadwell-noTSX",
"Broadwell-noTSX-IBRS",
+ "Cascadelake-Server",
"Conroe",
"core2duo",
"coreduo",
"host",
"IvyBridge",
"IvyBridge-IBRS",
+ "KnightsMill",
"kvm32",
"kvm64",
"max",
"type" : "string"
},
"flags" : {
- "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.",
+ "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.",
"format_description" : "+FLAG[;-FLAG...]",
"optional" : 1,
- "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)",
+ "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)",
"type" : "string"
},
"hidden" : {
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"memory" : {
],
"optional" : 1,
"type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
+ "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
"description" : "Map host parallel devices (n is 0 to 2).",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsi[n]" : {
- "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
+ "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).",
"format" : {
"aio" : {
"description" : "AIO type to use.",
"type" : "integer",
"typetext" : "<integer> (1 - N)"
},
+ "spice_enhancements" : {
+ "description" : "Configure additional enhancements for SPICE.",
+ "format" : {
+ "foldersharing" : {
+ "default" : "0",
+ "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "videostreaming" : {
+ "default" : "off",
+ "description" : "Enable video streaming. Uses compression for detected video streams.",
+ "enum" : [
+ "off",
+ "all",
+ "filter"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]"
+ },
"sshkeys" : {
"description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
"format" : "urlencoded",
"typetext" : "<boolean>",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
+ "tags" : {
+ "description" : "Tags of the VM. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
},
"usb3" : {
"default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
+ "description" : "Specifies whether if given host option is a USB3 device or port.",
"optional" : 1,
"type" : "boolean"
}
{
"info" : {
"GET" : {
- "description" : "Get virtual machine configuration, including pending changes.",
+ "allowtoken" : 1,
+ "description" : "Get the virtual machine configuration with both current and pending values.",
"method" : "GET",
"name" : "vm_pending",
"parameters" : {
{
"info" : {
"PUT" : {
+ "allowtoken" : 1,
"description" : "Unlink/delete disk images.",
"method" : "PUT",
"name" : "unlink",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Creates a TCP VNC proxy connections.",
"method" : "POST",
"name" : "vncproxy",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Creates a TCP proxy connections.",
"method" : "POST",
"name" : "termproxy",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Opens a weksocket for VNC traffic.",
"method" : "GET",
"name" : "vncwebsocket",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Returns a SPICE configuration to connect to the VM.",
"method" : "POST",
"name" : "spiceproxy",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get virtual machine status.",
"method" : "GET",
"name" : "vm_status",
],
"type" : "string"
},
+ "tags" : {
+ "description" : "The current configured tags, if any",
+ "optional" : 1,
+ "type" : "string"
+ },
"uptime" : {
"description" : "Uptime.",
"optional" : 1,
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Start virtual machine.",
"method" : "POST",
"name" : "vm_start",
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"migratedfrom" : {
"type" : "string",
"typetext" : "<string>"
},
+ "timeout" : {
+ "default" : "max(30, vm memory in GiB)",
+ "description" : "Wait maximal timeout seconds.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "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",
"method" : "POST",
"name" : "vm_stop",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Reset virtual machine.",
"method" : "POST",
"name" : "vm_reset",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "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.",
"method" : "POST",
"name" : "vm_shutdown",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
+ "description" : "Reboot the VM by shutting it down, and starting it again. Applies pending changes.",
+ "method" : "POST",
+ "name" : "vm_reboot",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "timeout" : {
+ "description" : "Wait maximal timeout seconds for the shutdown.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
+ "vmid" : {
+ "description" : "The (unique) ID of the VM.",
+ "format" : "pve-vmid",
+ "minimum" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - N)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/vms/{vmid}",
+ [
+ "VM.PowerMgmt"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/qemu/{vmid}/status/reboot",
+ "text" : "reboot"
+ },
+ {
+ "info" : {
+ "POST" : {
+ "allowtoken" : 1,
"description" : "Suspend virtual machine.",
"method" : "POST",
"name" : "vm_suspend",
[
"VM.PowerMgmt"
]
- ]
+ ],
+ "description" : "You need 'VM.PowerMgmt' on /vms/{vmid}, and if you have set 'todisk', you need also 'VM.Config.Disk' on /vms/{vmid} and 'Datastore.AllocateSpace' on the storage for the vmstate."
},
"protected" : 1,
"proxyto" : "node",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Resume virtual machine.",
"method" : "POST",
"name" : "vm_resume",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index",
"method" : "GET",
"name" : "vmcmdidx",
{
"info" : {
"PUT" : {
+ "allowtoken" : 1,
"description" : "Send key event to virtual machine.",
"method" : "PUT",
"name" : "vm_sendkey",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Check if feature for virtual machine is available.",
"method" : "GET",
"name" : "vm_feature",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a copy of virtual machine/template.",
"method" : "POST",
"name" : "clone_vm",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Move volume to different storage.",
"method" : "POST",
"name" : "move_vm_disk",
"scsi11",
"scsi12",
"scsi13",
+ "scsi14",
+ "scsi15",
+ "scsi16",
+ "scsi17",
+ "scsi18",
+ "scsi19",
+ "scsi20",
+ "scsi21",
+ "scsi22",
+ "scsi23",
+ "scsi24",
+ "scsi25",
+ "scsi26",
+ "scsi27",
+ "scsi28",
+ "scsi29",
+ "scsi30",
"virtio0",
"virtio1",
"virtio2",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get preconditions for migration.",
"method" : "GET",
"name" : "migrate_vm_precondition",
"returns" : {
"properties" : {
"allowed_nodes" : {
- "description" : "List nodes allowed for offline migration with same local storage as source node, only passed if VM is offline",
+ "description" : "List nodes allowed for offline migration, only passed if VM is offline",
"optional" : 1,
"type" : "array"
},
"description" : "List local resources e.g. pci, usb",
"type" : "array"
},
+ "not_allowed_nodes" : {
+ "description" : "List not allowed nodes with additional informations, only passed if VM is offline",
+ "optional" : 1,
+ "type" : "object"
+ },
"running" : {
"type" : "boolean"
}
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Migrate virtual machine. Creates a new migration task.",
"method" : "POST",
"name" : "migrate_vm",
"typetext" : "<string>"
},
"online" : {
- "description" : "Use online/live migration.",
+ "description" : "Use online/live migration if VM is running. Ignored if VM is stopped.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute Qemu monitor commands.",
"method" : "POST",
"name" : "monitor",
{
"info" : {
"PUT" : {
+ "allowtoken" : 1,
"description" : "Extend volume size.",
"method" : "PUT",
"name" : "resize_vm",
"scsi11",
"scsi12",
"scsi13",
+ "scsi14",
+ "scsi15",
+ "scsi16",
+ "scsi17",
+ "scsi18",
+ "scsi19",
+ "scsi20",
+ "scsi21",
+ "scsi22",
+ "scsi23",
+ "scsi24",
+ "scsi25",
+ "scsi26",
+ "scsi27",
+ "scsi28",
+ "scsi29",
+ "scsi30",
"virtio0",
"virtio1",
"virtio2",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get snapshot configuration",
"method" : "GET",
"name" : "get_snapshot_config",
"/vms/{vmid}",
[
"VM.Snapshot",
- "VM.Snapshot.Rollback"
+ "VM.Snapshot.Rollback",
+ "VM.Audit"
],
"any",
1
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update snapshot metadata.",
"method" : "PUT",
"name" : "update_snapshot_config",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Rollback VM state to specified snapshot.",
"method" : "POST",
"name" : "rollback",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a VM snapshot.",
"method" : "DELETE",
"name" : "delsnapshot",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "",
"method" : "GET",
"name" : "snapshot_cmd_idx",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List all snapshots.",
"method" : "GET",
"name" : "snapshot_list",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Snapshot a VM.",
"method" : "POST",
"name" : "snapshot",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a Template.",
"method" : "POST",
"name" : "template",
"scsi11",
"scsi12",
"scsi13",
+ "scsi14",
+ "scsi15",
+ "scsi16",
+ "scsi17",
+ "scsi18",
+ "scsi19",
+ "scsi20",
+ "scsi21",
+ "scsi22",
+ "scsi23",
+ "scsi24",
+ "scsi25",
+ "scsi26",
+ "scsi27",
+ "scsi28",
+ "scsi29",
+ "scsi30",
"virtio0",
"virtio1",
"virtio2",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get automatically generated cloudinit config.",
"method" : "GET",
"name" : "cloudinit_generated_config_dump",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Destroy the vm (also delete all used/owned volumes).",
"method" : "DELETE",
"name" : "destroy_vm",
"type" : "string",
"typetext" : "<string>"
},
+ "purge" : {
+ "description" : "Remove vmid from backup cron jobs.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"skiplock" : {
"description" : "Ignore locks - only root is allowed to use this option.",
"optional" : 1,
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index",
"method" : "GET",
"name" : "vmdiridx",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Virtual machine index (per node).",
"method" : "GET",
"name" : "vmlist",
],
"type" : "string"
},
+ "tags" : {
+ "description" : "The current configured tags, if any",
+ "optional" : 1,
+ "type" : "string"
+ },
"uptime" : {
"description" : "Uptime.",
"optional" : 1,
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create or restore a virtual machine.",
"method" : "POST",
"name" : "create_vm",
"description" : "Run fstrim after cloning/moving a disk.",
"optional" : 1,
"type" : "boolean"
+ },
+ "type" : {
+ "default" : "virtio",
+ "description" : "Select the agent type",
+ "enum" : [
+ "virtio",
+ "isa"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
},
"optional" : 1,
"type" : "string",
- "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>]"
+ "typetext" : "[enabled=]<1|0> [,fstrim_cloned_disks=<1|0>] [,type=<virtio|isa>]"
},
"arch" : {
"description" : "Virtual processor architecture. Defaults to the host.",
"typetext" : "<string>",
"verbose_description" : "Arbitrary arguments passed to kvm, for example:\n\nargs: -no-reboot -no-hpet\n\nNOTE: this option is for experts only.\n"
},
+ "audio0" : {
+ "description" : "Configure a audio device, useful in combination with QXL/Spice.",
+ "format" : {
+ "device" : {
+ "description" : "Configure an audio device.",
+ "enum" : [
+ "ich9-intel-hda",
+ "intel-hda",
+ "AC97"
+ ],
+ "type" : "string"
+ },
+ "driver" : {
+ "default" : "spice",
+ "description" : "Driver backend for the audio device.",
+ "enum" : [
+ "spice"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "device=<ich9-intel-hda|intel-hda|AC97> [,driver=<spice>]"
+ },
"autostart" : {
"default" : 0,
"description" : "Automatic restart after crash (currently ignored).",
"Broadwell-IBRS",
"Broadwell-noTSX",
"Broadwell-noTSX-IBRS",
+ "Cascadelake-Server",
"Conroe",
"core2duo",
"coreduo",
"host",
"IvyBridge",
"IvyBridge-IBRS",
+ "KnightsMill",
"kvm32",
"kvm64",
"max",
"type" : "string"
},
"flags" : {
- "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: 'pcid', 'spec-ctrl', 'ibpb', 'ssbd', 'virt-ssbd', 'amd-ssbd', 'amd-no-ssb', 'pdpe1gb', 'md-clear'.",
+ "description" : "List of additional CPU flags separated by ';'. Use '+FLAG' to enable, '-FLAG' to disable a flag. Currently supported flags: pcid, spec-ctrl, ibpb, ssbd, virt-ssbd, amd-ssbd, amd-no-ssb, pdpe1gb, md-clear, hv-tlbflush, hv-evmcs, aes.",
"format_description" : "+FLAG[;-FLAG...]",
"optional" : 1,
- "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear)))*)",
+ "pattern" : "(?^:(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes))(;(?^:[+-](pcid|spec-ctrl|ibpb|ssbd|virt-ssbd|amd-ssbd|amd-no-ssb|pdpe1gb|md-clear|hv-tlbflush|hv-evmcs|aes)))*)",
"type" : "string"
},
"hidden" : {
"description" : "Specifies the Qemu machine type.",
"maxLength" : 40,
"optional" : 1,
- "pattern" : "(pc|pc(-i440fx)?-\\d+\\.\\d+(\\.pxe)?|q35|pc-q35-\\d+\\.\\d+(\\.pxe)?|virt(?:-\\d+\\.\\d+)?)",
+ "pattern" : "(pc|pc(-i440fx)?-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|q35|pc-q35-\\d+(\\.\\d+)+(\\+pve\\d+)?(\\.pxe)?|virt(?:-\\d+(\\.\\d+)+)?(\\+pve\\d+)?)",
"type" : "string"
},
"memory" : {
],
"optional" : 1,
"type" : "string",
- "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6/3.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
+ "verbose_description" : "Specify guest operating system. This is used to enable special\noptimization/features for specific operating systems:\n\n[horizontal]\nother;; unspecified OS\nwxp;; Microsoft Windows XP\nw2k;; Microsoft Windows 2000\nw2k3;; Microsoft Windows 2003\nw2k8;; Microsoft Windows 2008\nwvista;; Microsoft Windows Vista\nwin7;; Microsoft Windows 7\nwin8;; Microsoft Windows 8/2012/2012r2\nwin10;; Microsoft Windows 10/2016\nl24;; Linux 2.4 Kernel\nl26;; Linux 2.6 - 5.X Kernel\nsolaris;; Solaris/OpenSolaris/OpenIndiania kernel\n"
},
"parallel[n]" : {
"description" : "Map host parallel devices (n is 0 to 2).",
"typetext" : "[file=]<volume> [,aio=<native|threads>] [,backup=<1|0>] [,bps=<bps>] [,bps_max_length=<seconds>] [,bps_rd=<bps>] [,bps_rd_max_length=<seconds>] [,bps_wr=<bps>] [,bps_wr_max_length=<seconds>] [,cache=<enum>] [,cyls=<integer>] [,detect_zeroes=<1|0>] [,discard=<ignore|on>] [,format=<enum>] [,heads=<integer>] [,iops=<iops>] [,iops_max=<iops>] [,iops_max_length=<seconds>] [,iops_rd=<iops>] [,iops_rd_max=<iops>] [,iops_rd_max_length=<seconds>] [,iops_wr=<iops>] [,iops_wr_max=<iops>] [,iops_wr_max_length=<seconds>] [,mbps=<mbps>] [,mbps_max=<mbps>] [,mbps_rd=<mbps>] [,mbps_rd_max=<mbps>] [,mbps_wr=<mbps>] [,mbps_wr_max=<mbps>] [,media=<cdrom|disk>] [,replicate=<1|0>] [,rerror=<ignore|report|stop>] [,secs=<integer>] [,serial=<serial>] [,shared=<1|0>] [,size=<DiskSize>] [,snapshot=<1|0>] [,ssd=<1|0>] [,trans=<none|lba|auto>] [,werror=<enum>] [,wwn=<wwn>]"
},
"scsi[n]" : {
- "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 13).",
+ "description" : "Use volume as SCSI hard disk or CD-ROM (n is 0 to 30).",
"format" : {
"aio" : {
"description" : "AIO type to use.",
"type" : "integer",
"typetext" : "<integer> (1 - N)"
},
+ "spice_enhancements" : {
+ "description" : "Configure additional enhancements for SPICE.",
+ "format" : {
+ "foldersharing" : {
+ "default" : "0",
+ "description" : "Enable folder sharing via SPICE. Needs Spice-WebDAV daemon installed in the VM.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "videostreaming" : {
+ "default" : "off",
+ "description" : "Enable video streaming. Uses compression for detected video streams.",
+ "enum" : [
+ "off",
+ "all",
+ "filter"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "[foldersharing=<1|0>] [,videostreaming=<off|all|filter>]"
+ },
"sshkeys" : {
"description" : "cloud-init: Setup public SSH keys (one key per line, OpenSSH format).",
"format" : "urlencoded",
"typetext" : "<boolean>",
"verbose_description" : "Enable/disable the USB tablet device. This device is usually needed to allow absolute mouse positioning with VNC. Else the mouse runs out of sync with normal VNC clients. If you're running lots of console-only guests on one host, you may consider disabling this to save some context switches. This is turned off by default if you use spice (-vga=qxl)."
},
+ "tags" : {
+ "description" : "Tags of the VM. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"tdf" : {
"default" : 0,
"description" : "Enable/disable time drift fix.",
},
"usb3" : {
"default" : 0,
- "description" : "Specifies whether if given host option is a USB3 device or port (this does currently not work reliably with spice redirection and is then ignored).",
+ "description" : "Specifies whether if given host option is a USB3 device or port.",
"optional" : 1,
"type" : "boolean"
}
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get container configuration.",
"method" : "GET",
"name" : "vm_config",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "current" : {
+ "default" : 0,
+ "description" : "Get current values (instead of pending values).",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"enum" : [
"backup",
"create",
+ "destroyed",
"disk",
"fstrim",
"migrate",
"type" : "boolean",
"verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)."
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"mp" : {
"description" : "Path to the mount point as seen from inside the container (must not contain symlinks).",
"format" : "pve-lxc-mp-string",
"optional" : 1,
"type" : "boolean"
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
"optional" : 1,
"type" : "integer"
},
+ "tags" : {
+ "description" : "Tags of the Container. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string"
+ },
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set container options.",
"method" : "PUT",
"name" : "update_vm",
"enum" : [
"backup",
"create",
+ "destroyed",
"disk",
"fstrim",
"migrate",
"type" : "boolean",
"verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)."
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"mp" : {
"description" : "Path to the mount point as seen from inside the container (must not contain symlinks).",
"format" : "pve-lxc-mp-string",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
+ "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
},
"nameserver" : {
"description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "revert" : {
+ "description" : "Revert a pending change.",
+ "format" : "pve-configid-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"rootfs" : {
"description" : "Use volume as container root.",
"format" : {
"optional" : 1,
"type" : "boolean"
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
},
"optional" : 1,
"type" : "string",
- "typetext" : "[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
+ "typetext" : "[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
},
"searchdomain" : {
"description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
+ "tags" : {
+ "description" : "Tags of the Container. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get virtual machine status.",
"method" : "GET",
"name" : "vm_status",
],
"type" : "string"
},
+ "tags" : {
+ "description" : "The current configured tags, if any.",
+ "optional" : 1,
+ "type" : "string"
+ },
"uptime" : {
"description" : "Uptime.",
"optional" : 1,
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Start the container.",
"method" : "POST",
"name" : "vm_start",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Stop the container. This will abruptly stop all processes running in the container.",
"method" : "POST",
"name" : "vm_stop",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Shutdown the container. This will trigger a clean shutdown of the container, see lxc-stop(1) for details.",
"method" : "POST",
"name" : "vm_shutdown",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Suspend the container.",
"method" : "POST",
"name" : "vm_suspend",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Resume the container.",
"method" : "POST",
"name" : "vm_resume",
"leaf" : 1,
"path" : "/nodes/{node}/lxc/{vmid}/status/resume",
"text" : "resume"
+ },
+ {
+ "info" : {
+ "POST" : {
+ "allowtoken" : 1,
+ "description" : "Reboot the container by shutting it down, and starting it again. Applies pending changes.",
+ "method" : "POST",
+ "name" : "vm_reboot",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "timeout" : {
+ "description" : "Wait maximal timeout seconds for the shutdown.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
+ "vmid" : {
+ "description" : "The (unique) ID of the VM.",
+ "format" : "pve-vmid",
+ "minimum" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - N)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/vms/{vmid}",
+ [
+ "VM.PowerMgmt"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/lxc/{vmid}/status/reboot",
+ "text" : "reboot"
}
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index",
"method" : "GET",
"name" : "vmcmdidx",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Rollback LXC state to specified snapshot.",
"method" : "POST",
"name" : "rollback",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get snapshot configuration",
"method" : "GET",
"name" : "get_snapshot_config",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update snapshot metadata.",
"method" : "PUT",
"name" : "update_snapshot_config",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete a LXC snapshot.",
"method" : "DELETE",
"name" : "delsnapshot",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "",
"method" : "GET",
"name" : "snapshot_cmd_idx",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List all snapshots.",
"method" : "GET",
"name" : "list",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Snapshot a container.",
"method" : "POST",
"name" : "snapshot",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete rule.",
"method" : "DELETE",
"name" : "delete_rule",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get single rule data.",
"method" : "GET",
"name" : "get_rule",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Modify rule data.",
"method" : "PUT",
"name" : "update_rule",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List rules.",
"method" : "GET",
"name" : "get_rules",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new rule.",
"method" : "POST",
"name" : "create_rule",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove IP or Network alias.",
"method" : "DELETE",
"name" : "remove_alias",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read alias.",
"method" : "GET",
"name" : "read_alias",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update IP or Network alias.",
"method" : "PUT",
"name" : "update_alias",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List aliases",
"method" : "GET",
"name" : "get_aliases",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create IP or Network Alias.",
"method" : "POST",
"name" : "create_alias",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Remove IP or Network from IPSet.",
"method" : "DELETE",
"name" : "remove_ip",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read IP or Network settings from IPSet.",
"method" : "GET",
"name" : "read_ip",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update IP or Network settings",
"method" : "PUT",
"name" : "update_ip",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete IPSet",
"method" : "DELETE",
"name" : "delete_ipset",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "List IPSet content",
"method" : "GET",
"name" : "get_ipset",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add IP or Network to IPSet.",
"method" : "POST",
"name" : "create_ip",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List IPSets",
"method" : "GET",
"name" : "ipset_index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new IPSet",
"method" : "POST",
"name" : "create_ipset",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get VM firewall options.",
"method" : "GET",
"name" : "get_options",
"returns" : {
"properties" : {
"dhcp" : {
+ "default" : 0,
"description" : "Enable DHCP.",
"optional" : 1,
"type" : "boolean"
},
"enable" : {
+ "default" : 0,
"description" : "Enable/disable firewall rules.",
"optional" : 1,
"type" : "boolean"
"type" : "string"
},
"macfilter" : {
+ "default" : 0,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean"
},
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set Firewall options.",
"method" : "PUT",
"name" : "set_options",
"typetext" : "<string>"
},
"dhcp" : {
+ "default" : 0,
"description" : "Enable DHCP.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<string>"
},
"enable" : {
+ "default" : 0,
"description" : "Enable/disable firewall rules.",
"optional" : 1,
"type" : "boolean",
"type" : "string"
},
"macfilter" : {
+ "default" : 0,
"description" : "Enable/disable MAC address filter.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read firewall log",
"method" : "GET",
"name" : "log",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Lists possible IPSet/Alias reference which are allowed in source/dest properties.",
"method" : "GET",
"name" : "refs",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read VM RRD statistics (returns PNG)",
"method" : "GET",
"name" : "rrd",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read VM RRD statistics",
"method" : "GET",
"name" : "rrddata",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Creates a TCP VNC proxy connections.",
"method" : "POST",
"name" : "vncproxy",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Creates a TCP proxy connection.",
"method" : "POST",
"name" : "termproxy",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Opens a weksocket for VNC traffic.",
"method" : "GET",
"name" : "vncwebsocket",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Returns a SPICE configuration to connect to the CT.",
"method" : "POST",
"name" : "spiceproxy",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Migrate the container to another node. Creates a new migration task.",
"method" : "POST",
"name" : "migrate_vm",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Check if feature for virtual machine is available.",
"method" : "GET",
"name" : "vm_feature",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a Template.",
"method" : "POST",
"name" : "template",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a container clone/copy",
"method" : "POST",
"name" : "clone_vm",
{
"info" : {
"PUT" : {
+ "allowtoken" : 1,
"description" : "Resize a container mount point.",
"method" : "PUT",
"name" : "resize_vm",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Move a rootfs-/mp-volume to a different storage",
"method" : "POST",
"name" : "move_volume",
"leaf" : 1,
"path" : "/nodes/{node}/lxc/{vmid}/move_volume",
"text" : "move_volume"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get container configuration, including pending changes.",
+ "method" : "GET",
+ "name" : "vm_pending",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "vmid" : {
+ "description" : "The (unique) ID of the VM.",
+ "format" : "pve-vmid",
+ "minimum" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - N)"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/vms/{vmid}",
+ [
+ "VM.Audit"
+ ]
+ ]
+ },
+ "proxyto" : "node",
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "delete" : {
+ "description" : "Indicates a pending delete request if present and not 0.",
+ "maximum" : 2,
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "key" : {
+ "description" : "Configuration option name.",
+ "type" : "string"
+ },
+ "pending" : {
+ "description" : "Pending value.",
+ "optional" : 1,
+ "type" : "string"
+ },
+ "value" : {
+ "description" : "Current value.",
+ "optional" : 1,
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/lxc/{vmid}/pending",
+ "text" : "pending"
}
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Destroy the container (also delete all uses files).",
"method" : "DELETE",
"name" : "destroy_vm",
"type" : "string",
"typetext" : "<string>"
},
+ "purge" : {
+ "description" : "Remove vmid from backup cron jobs.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
"vmid" : {
"description" : "The (unique) ID of the VM.",
"format" : "pve-vmid",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index",
"method" : "GET",
"name" : "vmdiridx",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "LXC container index (per node).",
"method" : "GET",
"name" : "vmlist",
],
"type" : "string"
},
+ "tags" : {
+ "description" : "The current configured tags, if any.",
+ "optional" : 1,
+ "type" : "string"
+ },
"uptime" : {
"description" : "Uptime.",
"optional" : 1,
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create or restore a container.",
"method" : "POST",
"name" : "create_vm",
"enum" : [
"backup",
"create",
+ "destroyed",
"disk",
"fstrim",
"migrate",
"type" : "boolean",
"verbose_description" : "Whether to include the mount point in backups (only used for volume mount points)."
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"mp" : {
"description" : "Path to the mount point as seen from inside the container (must not contain symlinks).",
"format" : "pve-lxc-mp-string",
},
"optional" : 1,
"type" : "string",
- "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
+ "typetext" : "[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
},
"nameserver" : {
"description" : "Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"optional" : 1,
"type" : "boolean"
},
+ "mountoptions" : {
+ "description" : "Extra mount options for rootfs/mps.",
+ "format_description" : "opt[;opt...]",
+ "optional" : 1,
+ "pattern" : "(?^:(?^:(noatime|nodev|nosuid|noexec))(;(?^:(noatime|nodev|nosuid|noexec)))*)",
+ "type" : "string"
+ },
"quota" : {
"description" : "Enable user quotas inside the container (not supported with zfs subvolumes)",
"optional" : 1,
},
"optional" : 1,
"type" : "string",
- "typetext" : "[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
+ "typetext" : "[volume=]<volume> [,acl=<1|0>] [,mountoptions=<opt[;opt...]>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]"
},
"searchdomain" : {
"description" : "Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.",
"type" : "integer",
"typetext" : "<integer> (0 - N)"
},
+ "tags" : {
+ "description" : "Tags of the Container. This is only meta information.",
+ "format" : "pve-tag-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"template" : {
"default" : 0,
"description" : "Enable/disable Template.",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "ceph osd in",
"method" : "POST",
"name" : "in",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "ceph osd out",
"method" : "POST",
"name" : "out",
"leaf" : 1,
"path" : "/nodes/{node}/ceph/osd/{osdid}/out",
"text" : "out"
+ },
+ {
+ "info" : {
+ "POST" : {
+ "allowtoken" : 1,
+ "description" : "Instruct the OSD to scrub.",
+ "method" : "POST",
+ "name" : "scrub",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "deep" : {
+ "default" : 0,
+ "description" : "If set, instructs a deep scrub instead of a normal one.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "osdid" : {
+ "description" : "OSD ID",
+ "type" : "integer",
+ "typetext" : "<integer>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Modify"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "null"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/ceph/osd/{osdid}/scrub",
+ "text" : "scrub"
}
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Destroy OSD",
"method" : "DELETE",
"name" : "destroyosd",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Ceph osd list/tree.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create OSD",
"method" : "POST",
"name" : "createosd",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Destroy Ceph Metadata Server",
"method" : "DELETE",
"name" : "destroymds",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create Ceph Metadata Server (MDS)",
"method" : "POST",
"name" : "createmds",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "MDS directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Destroy Ceph Manager.",
"method" : "DELETE",
"name" : "destroymgr",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create Ceph Manager",
"method" : "POST",
"name" : "createmgr",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "MGR directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Destroy Ceph Monitor and Manager.",
"method" : "DELETE",
"name" : "destroymon",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create Ceph Monitor and Manager",
"method" : "POST",
"name" : "createmon",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Ceph monitor list.",
"method" : "GET",
"name" : "listmon",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a Ceph filesystem",
"method" : "POST",
"name" : "createfs",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List local disks.",
"method" : "GET",
"name" : "disks",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Ceph configuration.",
"method" : "GET",
"name" : "config",
"path" : "/nodes/{node}/ceph/config",
"text" : "config"
},
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get Ceph configuration database.",
+ "method" : "GET",
+ "name" : "configdb",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "Sys.Audit",
+ "Datastore.Audit"
+ ],
+ "any",
+ 1
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "can_update_at_runtime" : {
+ "type" : "boolean"
+ },
+ "level" : {
+ "type" : "string"
+ },
+ "mask" : {
+ "type" : "string"
+ },
+ "name" : {
+ "type" : "string"
+ },
+ "section" : {
+ "type" : "string"
+ },
+ "value" : {
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/ceph/configdb",
+ "text" : "configdb"
+ },
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create initial ceph default configuration and setup symlinks.",
"method" : "POST",
"name" : "init",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Stop ceph services.",
"method" : "POST",
"name" : "stop",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Start ceph services.",
"method" : "POST",
"name" : "start",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Restart ceph services.",
"method" : "POST",
"name" : "restart",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get ceph status.",
"method" : "GET",
"name" : "status",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Destroy pool",
"method" : "DELETE",
"name" : "destroypool",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List all pools.",
"method" : "GET",
"name" : "lspools",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create POOL",
"method" : "POST",
"name" : "createpool",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Unset a ceph flag",
"method" : "DELETE",
"name" : "unset_flag",
"additionalProperties" : 0,
"properties" : {
"flag" : {
- "description" : "The ceph flag to set/unset",
+ "description" : "The ceph flag to unset",
"enum" : [
- "full",
- "pause",
- "noup",
+ "nobackfill",
+ "nodeep-scrub",
"nodown",
- "noout",
"noin",
- "nobackfill",
+ "noout",
"norebalance",
"norecover",
"noscrub",
- "nodeep-scrub",
- "notieragent"
+ "notieragent",
+ "noup",
+ "pause"
],
"type" : "string"
},
}
},
"POST" : {
- "description" : "Set a ceph flag",
+ "allowtoken" : 1,
+ "description" : "Set a specific ceph flag",
"method" : "POST",
"name" : "set_flag",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"flag" : {
- "description" : "The ceph flag to set/unset",
+ "description" : "The ceph flag to set",
"enum" : [
- "full",
- "pause",
- "noup",
+ "nobackfill",
+ "nodeep-scrub",
"nodown",
- "noout",
"noin",
- "nobackfill",
+ "noout",
"norebalance",
"norecover",
"noscrub",
- "nodeep-scrub",
- "notieragent"
+ "notieragent",
+ "noup",
+ "pause"
],
"type" : "string"
},
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "get all set ceph flags",
"method" : "GET",
"name" : "get_flags",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get OSD crush map",
"method" : "GET",
"name" : "crush",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read ceph log",
"method" : "GET",
"name" : "log",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List ceph rules.",
"method" : "GET",
"name" : "rules",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Extract configuration from vzdump backup archive.",
"method" : "GET",
"name" : "extractconfig",
],
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Create backup.",
"method" : "POST",
"name" : "vzdump",
"type" : "integer",
"typetext" : "<integer>"
},
+ "pool" : {
+ "description" : "Backup all known guest systems included in the specified pool.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"quiet" : {
"default" : 0,
"description" : "Be quiet.",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read service properties",
"method" : "GET",
"name" : "service_state",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Start service.",
"method" : "POST",
"name" : "service_start",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Stop service.",
"method" : "POST",
"name" : "service_stop",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Restart service.",
"method" : "POST",
"name" : "service_restart",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Reload service.",
"method" : "POST",
"name" : "service_reload",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index",
"method" : "GET",
"name" : "srvcmdidx",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Service list.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read subscription info.",
"method" : "GET",
"name" : "get",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Update subscription info.",
"method" : "POST",
"name" : "update",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set subscription key.",
"method" : "PUT",
"name" : "set",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete network device configuration",
"method" : "DELETE",
"name" : "delete_network",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read network device configuration",
"method" : "GET",
"name" : "network_config",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update network device configuration",
"method" : "PUT",
"name" : "update_network",
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "bond-primary" : {
+ "description" : "Specify the primary interface for active-backup bond.",
+ "format" : "pve-iface",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"bond_mode" : {
"description" : "Bonding mode.",
"enum" : [
"type" : "string",
"typetext" : "<string>"
},
+ "mtu" : {
+ "description" : "MTU.",
+ "maximum" : 65520,
+ "minimum" : 1280,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1280 - 65520)"
+ },
"netmask" : {
"description" : "Network mask.",
"format" : "ipv4mask",
"unknown"
],
"type" : "string"
+ },
+ "vlan-id" : {
+ "description" : "vlan-id for a custom named vlan interface (ifupdown2 only).",
+ "maximum" : 4094,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 4094)"
+ },
+ "vlan-raw-device" : {
+ "description" : "Specify the raw interface for the vlan interface.",
+ "format" : "pve-iface",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Revert network configuration changes.",
"method" : "DELETE",
"name" : "revert_network_changes",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "List available networks",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create network device configuration",
"method" : "POST",
"name" : "create_network",
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "bond-primary" : {
+ "description" : "Specify the primary interface for active-backup bond.",
+ "format" : "pve-iface",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"bond_mode" : {
"description" : "Bonding mode.",
"enum" : [
"type" : "string",
"typetext" : "<string>"
},
+ "mtu" : {
+ "description" : "MTU.",
+ "maximum" : 65520,
+ "minimum" : 1280,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1280 - 65520)"
+ },
"netmask" : {
"description" : "Network mask.",
"format" : "ipv4mask",
"unknown"
],
"type" : "string"
+ },
+ "vlan-id" : {
+ "description" : "vlan-id for a custom named vlan interface (ifupdown2 only).",
+ "maximum" : 4094,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 4094)"
+ },
+ "vlan-raw-device" : {
+ "description" : "Specify the raw interface for the vlan interface.",
+ "format" : "pve-iface",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
}
}
},
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Reload network configuration",
"method" : "PUT",
"name" : "reload_network_config",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read task log.",
"method" : "GET",
"name" : "read_task_log",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read task status.",
"method" : "GET",
"name" : "read_task_status",
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Stop a task.",
"method" : "DELETE",
"name" : "stop_task",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "",
"method" : "GET",
"name" : "upid_index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read task list for one node (finished tasks).",
"method" : "GET",
"name" : "node_tasks",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Scan zfs pool list on local node.",
"method" : "GET",
"name" : "zfsscan",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Scan remote NFS server.",
"method" : "GET",
"name" : "nfsscan",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Scan remote CIFS server.",
"method" : "GET",
"name" : "cifsscan",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Scan remote GlusterFS server.",
"method" : "GET",
"name" : "glusterfsscan",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Scan remote iSCSI server.",
"method" : "GET",
"name" : "iscsiscan",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List local LVM volume groups.",
"method" : "GET",
"name" : "lvmscan",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List local LVM Thin Pools.",
"method" : "GET",
"name" : "lvmthinscan",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List local USB devices.",
"method" : "GET",
"name" : "usbscan",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Index of available scan methods",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List mediated device types for given PCI device.",
"method" : "GET",
"name" : "mdevscan",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Index of available pci methods",
"method" : "GET",
"name" : "pciindex",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List local PCI devices.",
"method" : "GET",
"name" : "pciscan",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Index of hardware types",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete volume",
"method" : "DELETE",
"name" : "delete",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
+ "delay" : {
+ "description" : "Time to wait for the task to finish. We return 'null' if the task finish within that time.",
+ "maximum" : 30,
+ "minimum" : 1,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (1 - 30)"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"protected" : 1,
"proxyto" : "node",
"returns" : {
- "type" : "null"
+ "optional" : 1,
+ "type" : "string"
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get volume attributes",
"method" : "GET",
"name" : "info",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Copy a volume. This is experimental code - do not use.",
"method" : "POST",
"name" : "copy",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List storage content.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Allocate disk images.",
"method" : "POST",
"name" : "create",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read storage status.",
"method" : "GET",
"name" : "read_status",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read storage RRD statistics (returns PNG).",
"method" : "GET",
"name" : "rrd",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read storage RRD statistics.",
"method" : "GET",
"name" : "rrddata",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Upload templates and ISO images.",
"method" : "POST",
"name" : "upload",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "",
"method" : "GET",
"name" : "diridx",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get status for all datastores.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List LVM Volume Groups",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create an LVM Volume Group",
"method" : "POST",
"name" : "create",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List LVM thinpools",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create an LVM thinpool",
"method" : "POST",
"name" : "create",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "PVE Managed Directory storages.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a Filesystem on an unused disk. Will be mounted under '/mnt/pve/NAME'.",
"method" : "POST",
"name" : "create",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get details about a zpool.",
"method" : "GET",
"name" : "detail",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List Zpools.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a ZFS pool.",
"method" : "POST",
"name" : "create",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List local disks.",
"method" : "GET",
"name" : "list",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get SMART Health of a disk.",
"method" : "GET",
"name" : "smart",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Initialize Disk with GPT",
"method" : "POST",
"name" : "initgpt",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Node index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List available updates.",
"method" : "GET",
"name" : "list_updates",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "This is used to resynchronize the package index files from their sources (apt-get update).",
"method" : "POST",
"name" : "update_database",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get package changelogs.",
"method" : "GET",
"name" : "changelog",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get package information for important Proxmox packages.",
"method" : "GET",
"name" : "versions",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index for apt (Advanced Package Tool).",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete rule.",
"method" : "DELETE",
"name" : "delete_rule",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get single rule data.",
"method" : "GET",
"name" : "get_rule",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Modify rule data.",
"method" : "PUT",
"name" : "update_rule",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List rules.",
"method" : "GET",
"name" : "get_rules",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new rule.",
"method" : "POST",
"name" : "create_rule",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get host firewall options.",
"method" : "GET",
"name" : "get_options",
"type" : "boolean"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean"
},
"type" : "boolean"
},
"nf_conntrack_max" : {
+ "default" : 262144,
"description" : "Maximum number of tracked connections.",
"minimum" : 32768,
"optional" : 1,
"type" : "integer"
},
"nf_conntrack_tcp_timeout_established" : {
+ "default" : 432000,
"description" : "Conntrack established timeout.",
"minimum" : 7875,
"optional" : 1,
"type" : "integer"
},
+ "nf_conntrack_tcp_timeout_syn_recv" : {
+ "default" : 60,
+ "description" : "Conntrack syn recv timeout.",
+ "maximum" : 60,
+ "minimum" : 30,
+ "optional" : 1,
+ "type" : "integer"
+ },
"nosmurfs" : {
"description" : "Enable SMURFS filter.",
"optional" : 1,
"type" : "boolean"
},
+ "protection_synflood" : {
+ "default" : 0,
+ "description" : "Enable synflood protection",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "protection_synflood_burst" : {
+ "default" : 1000,
+ "description" : "Synflood protection rate burst by ip src.",
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "protection_synflood_rate" : {
+ "default" : 200,
+ "description" : "Synflood protection rate syn/sec by ip src.",
+ "optional" : 1,
+ "type" : "integer"
+ },
"smurf_log_level" : {
"description" : "Log level for SMURFS filter.",
"enum" : [
"type" : "string"
},
"tcpflags" : {
+ "default" : 0,
"description" : "Filter illegal combinations of TCP flags.",
"optional" : 1,
"type" : "boolean"
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set Firewall options.",
"method" : "PUT",
"name" : "set_options",
"typetext" : "<boolean>"
},
"ndp" : {
- "description" : "Enable NDP.",
+ "default" : 0,
+ "description" : "Enable NDP (Neighbor Discovery Protocol).",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"typetext" : "<boolean>"
},
"nf_conntrack_max" : {
+ "default" : 262144,
"description" : "Maximum number of tracked connections.",
"minimum" : 32768,
"optional" : 1,
"typetext" : "<integer> (32768 - N)"
},
"nf_conntrack_tcp_timeout_established" : {
+ "default" : 432000,
"description" : "Conntrack established timeout.",
"minimum" : 7875,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (7875 - N)"
},
+ "nf_conntrack_tcp_timeout_syn_recv" : {
+ "default" : 60,
+ "description" : "Conntrack syn recv timeout.",
+ "maximum" : 60,
+ "minimum" : 30,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (30 - 60)"
+ },
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "boolean",
"typetext" : "<boolean>"
},
+ "protection_synflood" : {
+ "default" : 0,
+ "description" : "Enable synflood protection",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "protection_synflood_burst" : {
+ "default" : 1000,
+ "description" : "Synflood protection rate burst by ip src.",
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer>"
+ },
+ "protection_synflood_rate" : {
+ "default" : 200,
+ "description" : "Synflood protection rate syn/sec by ip src.",
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer>"
+ },
"smurf_log_level" : {
"description" : "Log level for SMURFS filter.",
"enum" : [
"type" : "string"
},
"tcpflags" : {
+ "default" : 0,
"description" : "Filter illegal combinations of TCP flags.",
"optional" : 1,
"type" : "boolean",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read firewall log",
"method" : "GET",
"name" : "log",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get replication job status.",
"method" : "GET",
"name" : "job_status",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read replication job log.",
"method" : "GET",
"name" : "read_job_log",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Schedule replication job to start as soon as possible.",
"method" : "POST",
"name" : "schedule_now",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "List status of all replication jobs on this node.",
"method" : "GET",
"name" : "status",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Revoke existing certificate from CA.",
"method" : "DELETE",
"name" : "revoke_certificate",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Order a new certificate from ACME-compatible CA.",
"method" : "POST",
"name" : "new_certificate",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Renew existing certificate from CA.",
"method" : "PUT",
"name" : "renew_certificate",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "ACME index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get information about node's certificates.",
"method" : "GET",
"name" : "info",
"optional" : 1,
"type" : "string"
},
+ "public-key-bits" : {
+ "description" : "Certificate's public key size",
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "public-key-type" : {
+ "description" : "Certificate's public key algorithm",
+ "optional" : 1,
+ "type" : "string"
+ },
"san" : {
"description" : "List of Certificate's SubjectAlternativeName entries.",
"items" : {
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "DELETE custom certificate chain and key.",
"method" : "DELETE",
"name" : "remove_custom_cert",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Upload or update custom certificate chain and key.",
"method" : "POST",
"name" : "upload_custom_cert",
"optional" : 1,
"type" : "string"
},
+ "public-key-bits" : {
+ "description" : "Certificate's public key size",
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "public-key-type" : {
+ "description" : "Certificate's public key algorithm",
+ "optional" : 1,
+ "type" : "string"
+ },
"san" : {
"description" : "List of Certificate's SubjectAlternativeName entries.",
"items" : {
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Node index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get node configuration options.",
"method" : "GET",
"name" : "get_config",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
+ },
+ "property" : {
+ "default" : "all",
+ "description" : "Return only a specific property from the node configuration.",
+ "enum" : [
+ "acme",
+ "description",
+ "startall-onboot-delay",
+ "wakeonlan"
+ ],
+ "optional" : 1,
+ "type" : "string"
}
}
},
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set node configuration options.",
"method" : "PUT",
"name" : "set_options",
"type" : "string",
"typetext" : "<string>"
},
+ "startall-onboot-delay" : {
+ "default" : 0,
+ "description" : "Initial delay in seconds, before starting all the Virtual Guests with on-boot enabled.",
+ "maximum" : 300,
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - 300)"
+ },
"wakeonlan" : {
"description" : "MAC address for wake on LAN",
"format" : "mac-addr",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "API version details",
"method" : "GET",
"name" : "version",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read node status",
"method" : "GET",
"name" : "status",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Reboot or shutdown a node.",
"method" : "POST",
"name" : "node_cmd",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read tap/vm network device interface counters",
"method" : "GET",
"name" : "netstat",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Execute multiple commands in order.",
"method" : "POST",
"name" : "execute",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Try to wake a node via 'wake on LAN' network packet.",
"method" : "POST",
"name" : "wakeonlan",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read node RRD statistics (returns PNG)",
"method" : "GET",
"name" : "rrd",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read node RRD statistics",
"method" : "GET",
"name" : "rrddata",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read system log",
"method" : "GET",
"name" : "syslog",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read Journal",
"method" : "GET",
"name" : "journal",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Creates a VNC Shell proxy.",
"method" : "POST",
"name" : "vncshell",
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "ceph_install",
"upgrade",
- "login"
+ "login",
+ "ceph_install"
],
"optional" : 1,
"type" : "string"
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Creates a VNC Shell proxy.",
"method" : "POST",
"name" : "termproxy",
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "ceph_install",
"upgrade",
- "login"
+ "login",
+ "ceph_install"
],
"optional" : 1,
"type" : "string"
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Opens a weksocket for VNC traffic.",
"method" : "GET",
"name" : "vncwebsocket",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Creates a SPICE shell.",
"method" : "POST",
"name" : "spiceshell",
"default" : "login",
"description" : "Run specific command or default to login.",
"enum" : [
- "ceph_install",
"upgrade",
- "login"
+ "login",
+ "ceph_install"
],
"optional" : 1,
"type" : "string"
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read DNS settings.",
"method" : "GET",
"name" : "dns",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Write DNS settings.",
"method" : "PUT",
"name" : "update_dns",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Read server time and time zone settings.",
"method" : "GET",
"name" : "time",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Set time zone.",
"method" : "PUT",
"name" : "set_timezone",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get list of appliances.",
"method" : "GET",
"name" : "aplinfo",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Download appliance templates.",
"method" : "POST",
"name" : "apl_download",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Gather various systems information about a node",
"method" : "GET",
"name" : "report",
{
"info" : {
"POST" : {
- "description" : "Start all VMs and containers (when onboot=1).",
+ "allowtoken" : 1,
+ "description" : "Start all VMs and containers located on this node (by default only those with onboot=1).",
"method" : "POST",
"name" : "startall",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"force" : {
- "description" : "force if onboot=0.",
+ "default" : "off",
+ "description" : "Issue start command even if virtual guest have 'onboot' not set or set to off.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
- "node" : {
- "description" : "The cluster node name.",
- "format" : "pve-node",
- "type" : "string",
- "typetext" : "<string>"
- },
- "vms" : {
- "description" : "Only consider Guests with these IDs.",
- "format" : "pve-vmid-list",
- "optional" : 1,
- "type" : "string",
- "typetext" : "<string>"
- }
- }
- },
- "permissions" : {
- "check" : [
- "perm",
- "/",
- [
- "VM.PowerMgmt"
- ]
- ]
- },
- "protected" : 1,
- "proxyto" : "node",
- "returns" : {
- "type" : "string"
- }
- }
- },
- "leaf" : 1,
- "path" : "/nodes/{node}/startall",
- "text" : "startall"
- },
- {
- "info" : {
- "POST" : {
- "description" : "Stop all VMs and Containers.",
- "method" : "POST",
- "name" : "stopall",
- "parameters" : {
- "additionalProperties" : 0,
- "properties" : {
+ "node" : {
+ "description" : "The cluster node name.",
+ "format" : "pve-node",
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "vms" : {
+ "description" : "Only consider guests from this comma separated list of VMIDs.",
+ "format" : "pve-vmid-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "perm",
+ "/",
+ [
+ "VM.PowerMgmt"
+ ]
+ ]
+ },
+ "protected" : 1,
+ "proxyto" : "node",
+ "returns" : {
+ "type" : "string"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/nodes/{node}/startall",
+ "text" : "startall"
+ },
+ {
+ "info" : {
+ "POST" : {
+ "allowtoken" : 1,
+ "description" : "Stop all VMs and Containers.",
+ "method" : "POST",
+ "name" : "stopall",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
{
"info" : {
"POST" : {
+ "allowtoken" : 1,
"description" : "Migrate all VMs and Containers.",
"method" : "POST",
"name" : "migrateall",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
+ },
+ "with-local-disks" : {
+ "description" : "Enable live storage migration for local disk",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get the content of /etc/hosts.",
"method" : "GET",
"name" : "get_etc_hosts",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Write /etc/hosts.",
"method" : "POST",
"name" : "write_etc_hosts",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Node index.",
"method" : "GET",
"name" : "index",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Cluster node index.",
"method" : "GET",
"name" : "index",
"description" : "Used memory in bytes.",
"optional" : 1,
"renderer" : "bytes",
- "type" : "string"
+ "type" : "integer"
},
"node" : {
"description" : "The cluster node name.",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete storage configuration.",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Read storage configuration.",
"method" : "GET",
"name" : "read",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update storage configuration.",
"method" : "PUT",
"name" : "update",
"type" : "string",
"typetext" : "<string>"
},
+ "mountpoint" : {
+ "description" : "mount point",
+ "format" : "pve-storage-path",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"nodes" : {
"description" : "List of cluster node names.",
"format" : "pve-node-list",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Storage index.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create a new storage.",
"method" : "POST",
"name" : "create",
"type" : "string",
"typetext" : "<string>"
},
+ "mountpoint" : {
+ "description" : "mount point",
+ "format" : "pve-storage-path",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"nodes" : {
"description" : "List of cluster node names.",
"format" : "pve-node-list",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get user TFA types (Personal and Realm).",
"method" : "GET",
"name" : "read_user_tfa_type",
"leaf" : 1,
"path" : "/access/users/{userid}/tfa",
"text" : "tfa"
+ },
+ {
+ "children" : [
+ {
+ "info" : {
+ "DELETE" : {
+ "allowtoken" : 1,
+ "description" : "Remove API token for a specific user.",
+ "method" : "DELETE",
+ "name" : "remove_token",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "tokenid" : {
+ "description" : "User-specific token identifier.",
+ "pattern" : "(?^:[A-Za-z][A-Za-z0-9\\.\\-_]+)",
+ "type" : "string"
+ },
+ "userid" : {
+ "description" : "User ID",
+ "format" : "pve-userid",
+ "maxLength" : 64,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "or",
+ [
+ "userid-param",
+ "self"
+ ],
+ [
+ "perm",
+ "/access/users/{userid}",
+ [
+ "User.Modify"
+ ]
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "type" : "null"
+ }
+ },
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get specific API token information.",
+ "method" : "GET",
+ "name" : "read_token",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "tokenid" : {
+ "description" : "User-specific token identifier.",
+ "pattern" : "(?^:[A-Za-z][A-Za-z0-9\\.\\-_]+)",
+ "type" : "string"
+ },
+ "userid" : {
+ "description" : "User ID",
+ "format" : "pve-userid",
+ "maxLength" : 64,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "or",
+ [
+ "userid-param",
+ "self"
+ ],
+ [
+ "perm",
+ "/access/users/{userid}",
+ [
+ "User.Modify"
+ ]
+ ]
+ ]
+ },
+ "returns" : {
+ "properties" : {
+ "comment" : {
+ "optional" : 1,
+ "type" : "string"
+ },
+ "expire" : {
+ "default" : "same as user",
+ "description" : "API token expiration date (seconds since epoch). '0' means no expiration date.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "privsep" : {
+ "default" : 1,
+ "description" : "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
+ "optional" : 1,
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "POST" : {
+ "allowtoken" : 1,
+ "description" : "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!",
+ "method" : "POST",
+ "name" : "generate_token",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "comment" : {
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "expire" : {
+ "default" : "same as user",
+ "description" : "API token expiration date (seconds since epoch). '0' means no expiration date.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
+ "privsep" : {
+ "default" : 1,
+ "description" : "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "tokenid" : {
+ "description" : "User-specific token identifier.",
+ "pattern" : "(?^:[A-Za-z][A-Za-z0-9\\.\\-_]+)",
+ "type" : "string"
+ },
+ "userid" : {
+ "description" : "User ID",
+ "format" : "pve-userid",
+ "maxLength" : 64,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "or",
+ [
+ "userid-param",
+ "self"
+ ],
+ [
+ "perm",
+ "/access/users/{userid}",
+ [
+ "User.Modify"
+ ]
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "info" : {
+ "properties" : {
+ "comment" : {
+ "optional" : 1,
+ "type" : "string"
+ },
+ "expire" : {
+ "default" : "same as user",
+ "description" : "API token expiration date (seconds since epoch). '0' means no expiration date.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "privsep" : {
+ "default" : 1,
+ "description" : "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
+ "optional" : 1,
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ },
+ "value" : {
+ "description" : "API token value used for authentication.",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ }
+ },
+ "PUT" : {
+ "allowtoken" : 1,
+ "description" : "Update API token for a specific user.",
+ "method" : "PUT",
+ "name" : "update_token_info",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "comment" : {
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "expire" : {
+ "default" : "same as user",
+ "description" : "API token expiration date (seconds since epoch). '0' means no expiration date.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer",
+ "typetext" : "<integer> (0 - N)"
+ },
+ "privsep" : {
+ "default" : 1,
+ "description" : "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
+ },
+ "tokenid" : {
+ "description" : "User-specific token identifier.",
+ "pattern" : "(?^:[A-Za-z][A-Za-z0-9\\.\\-_]+)",
+ "type" : "string"
+ },
+ "userid" : {
+ "description" : "User ID",
+ "format" : "pve-userid",
+ "maxLength" : 64,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "or",
+ [
+ "userid-param",
+ "self"
+ ],
+ [
+ "perm",
+ "/access/users/{userid}",
+ [
+ "User.Modify"
+ ]
+ ]
+ ]
+ },
+ "protected" : 1,
+ "returns" : {
+ "description" : "Updated token information.",
+ "properties" : {
+ "comment" : {
+ "optional" : 1,
+ "type" : "string"
+ },
+ "expire" : {
+ "default" : "same as user",
+ "description" : "API token expiration date (seconds since epoch). '0' means no expiration date.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "privsep" : {
+ "default" : 1,
+ "description" : "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
+ "optional" : 1,
+ "type" : "boolean"
+ }
+ },
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/access/users/{userid}/token/{tokenid}",
+ "text" : "{tokenid}"
+ }
+ ],
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Get user API tokens.",
+ "method" : "GET",
+ "name" : "token_index",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "userid" : {
+ "description" : "User ID",
+ "format" : "pve-userid",
+ "maxLength" : 64,
+ "type" : "string",
+ "typetext" : "<string>"
+ }
+ }
+ },
+ "permissions" : {
+ "check" : [
+ "or",
+ [
+ "userid-param",
+ "self"
+ ],
+ [
+ "perm",
+ "/access/users/{userid}",
+ [
+ "User.Modify"
+ ]
+ ]
+ ]
+ },
+ "returns" : {
+ "items" : {
+ "properties" : {
+ "comment" : {
+ "optional" : 1,
+ "type" : "string"
+ },
+ "expire" : {
+ "default" : "same as user",
+ "description" : "API token expiration date (seconds since epoch). '0' means no expiration date.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "privsep" : {
+ "default" : 1,
+ "description" : "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "tokenid" : {
+ "description" : "User-specific token identifier.",
+ "pattern" : "(?^:[A-Za-z][A-Za-z0-9\\.\\-_]+)",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "links" : [
+ {
+ "href" : "{tokenid}",
+ "rel" : "child"
+ }
+ ],
+ "type" : "array"
+ }
+ }
+ },
+ "leaf" : 0,
+ "path" : "/access/users/{userid}/token",
+ "text" : "token"
}
],
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete user.",
"method" : "DELETE",
"name" : "delete_user",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get user configuration.",
"method" : "GET",
"name" : "read_user",
"type" : "string"
},
"groups" : {
+ "items" : {
+ "format" : "pve-groupid",
+ "type" : "string"
+ },
+ "optional" : 1,
"type" : "array"
},
"keys" : {
"lastname" : {
"optional" : 1,
"type" : "string"
+ },
+ "tokens" : {
+ "optional" : 1,
+ "type" : "object"
}
},
"type" : "object"
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update user configuration.",
"method" : "PUT",
"name" : "update_user",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "User index.",
"method" : "GET",
"name" : "index",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
+ },
+ "full" : {
+ "default" : 0,
+ "description" : "Include group and token information.",
+ "optional" : 1,
+ "type" : "boolean",
+ "typetext" : "<boolean>"
}
}
},
"optional" : 1,
"type" : "string"
},
+ "groups" : {
+ "format" : "pve-groupid-list",
+ "optional" : 1,
+ "type" : "string"
+ },
"keys" : {
"description" : "Keys for two factor auth (yubico).",
"optional" : 1,
"optional" : 1,
"type" : "string"
},
+ "tokens" : {
+ "items" : {
+ "properties" : {
+ "comment" : {
+ "optional" : 1,
+ "type" : "string"
+ },
+ "expire" : {
+ "default" : "same as user",
+ "description" : "API token expiration date (seconds since epoch). '0' means no expiration date.",
+ "minimum" : 0,
+ "optional" : 1,
+ "type" : "integer"
+ },
+ "privsep" : {
+ "default" : 1,
+ "description" : "Restrict API token privileges with separate ACLs (default), or give full privileges of corresponding user.",
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "tokenid" : {
+ "description" : "User-specific token identifier.",
+ "pattern" : "(?^:[A-Za-z][A-Za-z0-9\\.\\-_]+)",
+ "type" : "string"
+ }
+ },
+ "type" : "object"
+ },
+ "optional" : 1,
+ "type" : "array"
+ },
"userid" : {
"description" : "User ID",
"format" : "pve-userid",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new user.",
"method" : "POST",
"name" : "create_user",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete group.",
"method" : "DELETE",
"name" : "delete_group",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get group configuration.",
"method" : "GET",
"name" : "read_group",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update group data.",
"method" : "PUT",
"name" : "update_group",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Group index.",
"method" : "GET",
"name" : "index",
"groupid" : {
"format" : "pve-groupid",
"type" : "string"
+ },
+ "users" : {
+ "description" : "list of users which form this group",
+ "format" : "pve-userid-list",
+ "optional" : 1,
+ "type" : "string"
}
},
"type" : "object"
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new group.",
"method" : "POST",
"name" : "create_group",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete role.",
"method" : "DELETE",
"name" : "delete_role",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get role configuration.",
"method" : "GET",
"name" : "read_role",
"optional" : 1,
"type" : "boolean"
},
+ "SDN.Allocate" : {
+ "optional" : 1,
+ "type" : "boolean"
+ },
+ "SDN.Audit" : {
+ "optional" : 1,
+ "type" : "boolean"
+ },
"Sys.Audit" : {
"optional" : 1,
"type" : "boolean"
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update an existing role.",
"method" : "PUT",
"name" : "update_role",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Role index.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new role.",
"method" : "POST",
"name" : "create_role",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Get Access Control List (ACLs).",
"method" : "GET",
"name" : "read_acl",
"type" : {
"enum" : [
"user",
- "group"
+ "group",
+ "token"
],
"type" : "string"
},
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update Access Control List (add or remove permissions).",
"method" : "PUT",
"name" : "update_acl",
"type" : "string",
"typetext" : "<string>"
},
+ "tokens" : {
+ "description" : "List of API tokens.",
+ "format" : "pve-tokenid-list",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
"users" : {
"description" : "List of users.",
"format" : "pve-userid-list",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete an authentication server.",
"method" : "DELETE",
"name" : "delete",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get auth server configuration.",
"method" : "GET",
"name" : "read",
"returns" : {}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update authentication server settings.",
"method" : "PUT",
"name" : "update",
"type" : "string",
"typetext" : "<string>"
},
+ "sslversion" : {
+ "description" : "LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!",
+ "enum" : [
+ "tlsv1",
+ "tlsv1_1",
+ "tlsv1_2",
+ "tlsv1_3"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"tfa" : {
"description" : "Use Two-factor authentication.",
"format" : "pve-tfa-config",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Authentication domain index.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Add an authentication server.",
"method" : "POST",
"name" : "create",
"type" : "string",
"typetext" : "<string>"
},
+ "sslversion" : {
+ "description" : "LDAPS TLS/SSL version. It's not recommended to use version older than 1.2!",
+ "enum" : [
+ "tlsv1",
+ "tlsv1_1",
+ "tlsv1_2",
+ "tlsv1_3"
+ ],
+ "optional" : 1,
+ "type" : "string"
+ },
"tfa" : {
"description" : "Use Two-factor authentication.",
"format" : "pve-tfa-config",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Dummy. Useful for formatters which want to provide a login page.",
"method" : "GET",
"name" : "get_ticket",
}
},
"POST" : {
+ "allowtoken" : 0,
"description" : "Create or verify authentication ticket.",
"method" : "POST",
"name" : "create_ticket",
{
"info" : {
"PUT" : {
+ "allowtoken" : 0,
"description" : "Change user password.",
"method" : "PUT",
"name" : "change_password",
{
"info" : {
"POST" : {
+ "allowtoken" : 0,
"description" : "Finish a u2f challenge.",
"method" : "POST",
"name" : "verify_tfa",
}
},
"PUT" : {
+ "allowtoken" : 0,
"description" : "Change user u2f authentication.",
"method" : "PUT",
"name" : "change_tfa",
},
"key" : {
"description" : "When adding TOTP, the shared secret value.",
+ "format" : "pve-tfa-secret",
"optional" : 1,
- "pattern" : "(?^:[A-Z2-7=]{16}|[A-Fa-f0-9]{40})",
- "type" : "string"
+ "type" : "string",
+ "typetext" : "<string>"
},
"password" : {
"description" : "The current password.",
"leaf" : 1,
"path" : "/access/tfa",
"text" : "tfa"
+ },
+ {
+ "info" : {
+ "GET" : {
+ "allowtoken" : 1,
+ "description" : "Retrieve effective permissions of given user/token.",
+ "method" : "GET",
+ "name" : "permissions",
+ "parameters" : {
+ "additionalProperties" : 0,
+ "properties" : {
+ "path" : {
+ "description" : "Only dump this specific path, not the whole tree.",
+ "optional" : 1,
+ "type" : "string",
+ "typetext" : "<string>"
+ },
+ "userid" : {
+ "description" : "User ID or full API token ID",
+ "optional" : 1,
+ "pattern" : "(?^:^(?^:[^\\s:/]+)\\@(?^:[A-Za-z][A-Za-z0-9\\.\\-_]+)(?:!(?^:[A-Za-z][A-Za-z0-9\\.\\-_]+))?$)",
+ "type" : "string"
+ }
+ }
+ },
+ "permissions" : {
+ "description" : "Each user/token is allowed to dump their own permissions. A user can dump the permissions of another user if they have 'Sys.Audit' permission on /access.",
+ "user" : "all"
+ },
+ "returns" : {
+ "description" : "Map of \"path\" => (Map of \"privilege\" => \"propagate boolean\").",
+ "type" : "object"
+ }
+ }
+ },
+ "leaf" : 1,
+ "path" : "/access/permissions",
+ "text" : "permissions"
}
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Directory index.",
"method" : "GET",
"name" : "index",
{
"info" : {
"DELETE" : {
+ "allowtoken" : 1,
"description" : "Delete pool.",
"method" : "DELETE",
"name" : "delete_pool",
}
},
"GET" : {
+ "allowtoken" : 1,
"description" : "Get pool configuration.",
"method" : "GET",
"name" : "read_pool",
}
},
"PUT" : {
+ "allowtoken" : 1,
"description" : "Update pool data.",
"method" : "PUT",
"name" : "update_pool",
],
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "Pool index.",
"method" : "GET",
"name" : "index",
}
},
"POST" : {
+ "allowtoken" : 1,
"description" : "Create new pool.",
"method" : "POST",
"name" : "create_pool",
{
"info" : {
"GET" : {
+ "allowtoken" : 1,
"description" : "API version details. The result also includes the global datacenter confguration.",
"method" : "GET",
"name" : "version",
projects / pve-docs.git / blobdiff