Browse Source

update generated docs

stable-5
Wolfgang Bumiller 2 years ago
parent
commit
2489d6df4a

+ 336
- 58
api-viewer/apidata.js View File

@@ -2953,11 +2953,12 @@ var pveapi = [
"started",
"stopped",
"enabled",
"disabled"
"disabled",
"ignored"
],
"optional" : 1,
"type" : "string",
"verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n"
"verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n`ignored`;;\n\nThe resource gets removed from the manager status and so the CRM and the LRM do\nnot touch the resource anymore. All {pve} API calls affecting this resource\nwill be executed, directly bypassing the HA stack. CRM commands will be thrown\naway while there source is in this state. The resource will not get relocated\non node failures.\n\n"
}
},
"type" : "object"
@@ -3078,11 +3079,12 @@ var pveapi = [
"started",
"stopped",
"enabled",
"disabled"
"disabled",
"ignored"
],
"optional" : 1,
"type" : "string",
"verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n"
"verbose_description" : "Requested resource state. The CRM reads this state and acts accordingly.\nPlease note that `enabled` is just an alias for `started`.\n\n`started`;;\n\nThe CRM tries to start the resource. Service state is\nset to `started` after successful start. On node failures, or when start\nfails, it tries to recover the resource. If everything fails, service\nstate it set to `error`.\n\n`stopped`;;\n\nThe CRM tries to keep the resource in `stopped` state, but it\nstill tries to relocate the resources on node failures.\n\n`disabled`;;\n\nThe CRM tries to put the resource in `stopped` state, but does not try\nto relocate the resources on node failures. The main purpose of this\nstate is error recovery, because it is the only way to move a resource out\nof the `error` state.\n\n`ignored`;;\n\nThe resource gets removed from the manager status and so the CRM and the LRM do\nnot touch the resource anymore. All {pve} API calls affecting this resource\nwill be executed, directly bypassing the HA stack. CRM commands will be thrown\naway while there source is in this state. The resource will not get relocated\non node failures.\n\n"
},
"type" : {
"description" : "Resource type.",
@@ -5904,12 +5906,12 @@ var pveapi = [
"cpuunits" : {
"default" : 1024,
"description" : "CPU weight for a VM.",
"maximum" : 500000,
"minimum" : 0,
"maximum" : 262144,
"minimum" : 2,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (0 - 500000)",
"verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
"typetext" : "<integer> (2 - 262144)",
"verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs."
},
"delete" : {
"description" : "A list of settings you want to delete.",
@@ -7680,6 +7682,13 @@ var pveapi = [
"type" : "integer",
"typetext" : "<integer> (1 - N)"
},
"vmstatestorage" : {
"description" : "Default storage for VM state volumes/files.",
"format" : "pve-storage-id",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"watchdog" : {
"description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog",
@@ -7859,12 +7868,12 @@ var pveapi = [
"cpuunits" : {
"default" : 1024,
"description" : "CPU weight for a VM.",
"maximum" : 500000,
"minimum" : 0,
"maximum" : 262144,
"minimum" : 2,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (0 - 500000)",
"verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
"typetext" : "<integer> (2 - 262144)",
"verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs."
},
"delete" : {
"description" : "A list of settings you want to delete.",
@@ -9635,6 +9644,13 @@ var pveapi = [
"type" : "integer",
"typetext" : "<integer> (1 - N)"
},
"vmstatestorage" : {
"description" : "Default storage for VM state volumes/files.",
"format" : "pve-storage-id",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"watchdog" : {
"description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog",
@@ -11234,8 +11250,11 @@ var pveapi = [
"perm",
"/vms/{vmid}",
[
"VM.Snapshot"
]
"VM.Snapshot",
"VM.Snapshot.Rollback"
],
"any",
1
]
},
"proxyto" : "node",
@@ -11334,8 +11353,11 @@ var pveapi = [
"perm",
"/vms/{vmid}",
[
"VM.Snapshot"
]
"VM.Snapshot",
"VM.Snapshot.Rollback"
],
"any",
1
]
},
"protected" : 1,
@@ -11947,12 +11969,12 @@ var pveapi = [
"cpuunits" : {
"default" : 1024,
"description" : "CPU weight for a VM.",
"maximum" : 500000,
"minimum" : 0,
"maximum" : 262144,
"minimum" : 2,
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (0 - 500000)",
"verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs.\n\nNOTE: You can disable fair-scheduler configuration by setting this to 0."
"typetext" : "<integer> (2 - 262144)",
"verbose_description" : "CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to weights of all the other running VMs."
},
"description" : {
"description" : "Description for the VM. Only used on the configuration web interface. This is saved as comment inside the configuration file.",
@@ -13717,6 +13739,13 @@ var pveapi = [
"type" : "integer",
"typetext" : "<integer> (1 - N)"
},
"vmstatestorage" : {
"description" : "Default storage for VM state volumes/files.",
"format" : "pve-storage-id",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"watchdog" : {
"description" : "Create a virtual hardware watchdog device.",
"format" : "pve-qm-watchdog",
@@ -14007,14 +14036,14 @@ var pveapi = [
"ip" : {
"description" : "IPv4 address in CIDR format.",
"format" : "pve-ipv4-config",
"format_description" : "IPv4Format/CIDR",
"format_description" : "(IPv4/CIDR|dhcp|manual)",
"optional" : 1,
"type" : "string"
},
"ip6" : {
"description" : "IPv6 address in CIDR format.",
"format" : "pve-ipv6-config",
"format_description" : "IPv6Format/CIDR",
"format_description" : "(IPv6/CIDR|auto|dhcp|manual)",
"optional" : 1,
"type" : "string"
},
@@ -14061,7 +14090,7 @@ var pveapi = [
},
"optional" : 1,
"type" : "string",
"typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
"typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
},
"node" : {
"description" : "The cluster node name.",
@@ -14621,8 +14650,11 @@ var pveapi = [
"perm",
"/vms/{vmid}",
[
"VM.Snapshot"
]
"VM.Snapshot",
"VM.Snapshot.Rollback"
],
"any",
1
]
},
"protected" : 1,
@@ -14673,8 +14705,11 @@ var pveapi = [
"perm",
"/vms/{vmid}",
[
"VM.Snapshot"
]
"VM.Snapshot",
"VM.Snapshot.Rollback"
],
"any",
1
]
},
"proxyto" : "node",
@@ -17714,14 +17749,14 @@ var pveapi = [
"ip" : {
"description" : "IPv4 address in CIDR format.",
"format" : "pve-ipv4-config",
"format_description" : "IPv4Format/CIDR",
"format_description" : "(IPv4/CIDR|dhcp|manual)",
"optional" : 1,
"type" : "string"
},
"ip6" : {
"description" : "IPv6 address in CIDR format.",
"format" : "pve-ipv6-config",
"format_description" : "IPv6Format/CIDR",
"format_description" : "(IPv6/CIDR|auto|dhcp|manual)",
"optional" : 1,
"type" : "string"
},
@@ -17768,7 +17803,7 @@ var pveapi = [
},
"optional" : 1,
"type" : "string",
"typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
"typetext" : "name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]"
},
"node" : {
"description" : "The cluster node name.",
@@ -18168,7 +18203,7 @@ var pveapi = [
"type" : "string"
},
"journal_dev" : {
"description" : "Block device name for journal.",
"description" : "Block device name for journal (filestore) or block.db (bluestore).",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
@@ -18178,6 +18213,12 @@ var pveapi = [
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"wal_dev" : {
"description" : "Block device name for block.wal (bluestore only).",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
}
}
},
@@ -18317,16 +18358,23 @@ var pveapi = [
{
"info" : {
"DELETE" : {
"description" : "Destroy Ceph monitor.",
"description" : "Destroy Ceph Monitor and Manager.",
"method" : "DELETE",
"name" : "destroymon",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"exclude-manager" : {
"default" : 0,
"description" : "When set, removes only the monitor, not the manager",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"monid" : {
"description" : "Monitor ID",
"type" : "integer",
"typetext" : "<integer>"
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
@@ -18409,12 +18457,25 @@ var pveapi = [
}
},
"POST" : {
"description" : "Create Ceph Monitor",
"description" : "Create Ceph Monitor and Manager",
"method" : "POST",
"name" : "createmon",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"exclude-manager" : {
"default" : 0,
"description" : "When set, only a monitor will be created.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
},
"id" : {
"description" : "The ID for the monitor, when omitted the same as the nodename",
"optional" : 1,
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
@@ -18522,6 +18583,93 @@ var pveapi = [
"path" : "/nodes/{node}/ceph/init",
"text" : "init"
},
{
"children" : [
{
"info" : {
"DELETE" : {
"description" : "Destroy Ceph Manager.",
"method" : "DELETE",
"name" : "destroymgr",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"id" : {
"description" : "The ID of the manager",
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/mgr/{id}",
"text" : "{id}"
}
],
"info" : {
"POST" : {
"description" : "Create Ceph Manager",
"method" : "POST",
"name" : "createmgr",
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"id" : {
"description" : "The ID for the manager, when omitted the same as the nodename",
"optional" : 1,
"pattern" : "[a-zA-Z0-9]([a-zA-Z0-9\\-]*[a-zA-Z0-9])?",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
}
}
},
"permissions" : {
"check" : [
"perm",
"/",
[
"Sys.Modify"
]
]
},
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "string"
}
}
},
"leaf" : 0,
"path" : "/nodes/{node}/ceph/mgr",
"text" : "mgr"
},
{
"info" : {
"POST" : {
@@ -18540,7 +18688,7 @@ var pveapi = [
"service" : {
"description" : "Ceph service name.",
"optional" : 1,
"pattern" : "(mon|mds|osd)\\.[A-Za-z0-9]{1,32}",
"pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
"type" : "string"
}
}
@@ -18583,7 +18731,7 @@ var pveapi = [
"service" : {
"description" : "Ceph service name.",
"optional" : 1,
"pattern" : "(mon|mds|osd)\\.[A-Za-z0-9]{1,32}",
"pattern" : "(mon|mds|osd|mgr)\\.[A-Za-z0-9\\-]{1,32}",
"type" : "string"
}
}
@@ -18676,6 +18824,13 @@ var pveapi = [
"format" : "pve-node",
"type" : "string",
"typetext" : "<string>"
},
"remove_storages" : {
"default" : 0,
"description" : "Remove all pveceph-managed storages configured for this pool",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
}
}
},
@@ -18691,7 +18846,7 @@ var pveapi = [
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "null"
"type" : "string"
}
}
},
@@ -18761,17 +18916,30 @@ var pveapi = [
"parameters" : {
"additionalProperties" : 0,
"properties" : {
"crush_ruleset" : {
"default" : 0,
"description" : "The ruleset to use for mapping object placement in the cluster.",
"maximum" : 32768,
"minimum" : 0,
"add_storages" : {
"description" : "Configure VM and CT storages using the new pool.",
"optional" : 1,
"type" : "integer",
"typetext" : "<integer> (0 - 32768)"
"type" : "boolean",
"typetext" : "<boolean>"
},
"application" : {
"description" : "The application of the pool, 'rbd' by default.",
"enum" : [
"rbd",
"cephfs",
"rgw"
],
"optional" : 1,
"type" : "string"
},
"crush_rule" : {
"description" : "The rule to use for mapping object placement in the cluster.",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"min_size" : {
"default" : 1,
"default" : 2,
"description" : "Minimum number of replicas per object",
"maximum" : 7,
"minimum" : 1,
@@ -18800,7 +18968,7 @@ var pveapi = [
"typetext" : "<integer> (8 - 32768)"
},
"size" : {
"default" : 2,
"default" : 3,
"description" : "Number of replicas per object",
"maximum" : 7,
"minimum" : 1,
@@ -18822,7 +18990,7 @@ var pveapi = [
"protected" : 1,
"proxyto" : "node",
"returns" : {
"type" : "null"
"type" : "string"
}
}
},
@@ -19073,6 +19241,56 @@ var pveapi = [
"leaf" : 1,
"path" : "/nodes/{node}/ceph/log",
"text" : "log"
},
{
"info" : {
"GET" : {
"description" : "List ceph rules.",
"method" : "GET",
"name" : "rules",
"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" : {},
"type" : "object"
},
"links" : [
{
"href" : "{name}",
"rel" : "child"
}
],
"type" : "array"
}
}
},
"leaf" : 1,
"path" : "/nodes/{node}/ceph/rules",
"text" : "rules"
}
],
"info" : {
@@ -19857,8 +20075,9 @@ var pveapi = [
"properties" : {
"key" : {
"description" : "Proxmox VE subscription key",
"type" : "string",
"typetext" : "<string>"
"maxLength" : 32,
"pattern" : "pve([124])([cbsp])-[0-9a-f]{10}",
"type" : "string"
},
"node" : {
"description" : "The cluster node name.",
@@ -24572,10 +24791,10 @@ var pveapi = [
},
"is_mountpoint" : {
"default" : "no",
"description" : "Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.",
"description" : "Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"type" : "string",
"typetext" : "<string>"
},
"krbd" : {
"description" : "Access rbd through krbd kernel module.",
@@ -24597,6 +24816,13 @@ var pveapi = [
"type" : "boolean",
"typetext" : "<boolean>"
},
"monhost" : {
"description" : "IP addresses of monitors (for external clusters).",
"format" : "pve-storage-portal-dns-list",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"nodes" : {
"description" : "List of cluster node names.",
"format" : "pve-node-list",
@@ -24840,10 +25066,10 @@ var pveapi = [
},
"is_mountpoint" : {
"default" : "no",
"description" : "Assume the directory is an externally managed mountpoint. If nothing is mounted the storage will be considered offline.",
"description" : "Assume the given path is an externally managed mountpoint and consider the storage offline if it is not mounted. Using a boolean (yes/no) value serves as a shortcut to using the target path in this field.",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
"type" : "string",
"typetext" : "<string>"
},
"iscsiprovider" : {
"description" : "iscsi provider",
@@ -24872,7 +25098,7 @@ var pveapi = [
"typetext" : "<boolean>"
},
"monhost" : {
"description" : "Monitors daemon ips.",
"description" : "IP addresses of monitors (for external clusters).",
"format" : "pve-storage-portal-dns-list",
"optional" : 1,
"type" : "string",
@@ -25925,6 +26151,25 @@ var pveapi = [
"pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*",
"type" : "string"
},
"capath" : {
"default" : "/etc/ssl/certs",
"description" : "Path to the CA certificate store",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"cert" : {
"description" : "Path to the client certificate",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"certkey" : {
"description" : "Path to the client certificate key",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"comment" : {
"description" : "Description.",
"maxLength" : 4096,
@@ -26011,6 +26256,13 @@ var pveapi = [
"optional" : 1,
"pattern" : "\\S{2,}",
"type" : "string"
},
"verify" : {
"default" : 0,
"description" : "Verify the server's SSL certificate",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
}
},
"type" : "object"
@@ -26100,6 +26352,25 @@ var pveapi = [
"pattern" : "\\w+=[^,]+(,\\s*\\w+=[^,]+)*",
"type" : "string"
},
"capath" : {
"default" : "/etc/ssl/certs",
"description" : "Path to the CA certificate store",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"cert" : {
"description" : "Path to the client certificate",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"certkey" : {
"description" : "Path to the client certificate key",
"optional" : 1,
"type" : "string",
"typetext" : "<string>"
},
"comment" : {
"description" : "Description.",
"maxLength" : 4096,
@@ -26181,6 +26452,13 @@ var pveapi = [
"optional" : 1,
"pattern" : "\\S{2,}",
"type" : "string"
},
"verify" : {
"default" : 0,
"description" : "Verify the server's SSL certificate",
"optional" : 1,
"type" : "boolean",
"typetext" : "<boolean>"
}
},
"type" : "object"
@@ -26207,7 +26485,7 @@ var pveapi = [
{
"info" : {
"GET" : {
"description" : "Dummy. Useful for formaters which want to priovde a login page.",
"description" : "Dummy. Useful for formatters which want to provide a login page.",
"method" : "GET",
"name" : "get_ticket",
"parameters" : {

+ 28
- 28
ha-manager.1-synopsis.adoc View File

@@ -8,27 +8,27 @@ Create a new HA resource.

HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).

`-comment` `<string>` ::
`--comment` `<string>` ::

Description.

`-group` `<string>` ::
`--group` `<string>` ::

The HA group identifier.

`-max_relocate` `<integer> (0 - N)` ('default =' `1`)::
`--max_relocate` `<integer> (0 - N)` ('default =' `1`)::

Maximal number of service relocate tries when a service failes to start.

`-max_restart` `<integer> (0 - N)` ('default =' `1`)::
`--max_restart` `<integer> (0 - N)` ('default =' `1`)::

Maximal number of tries to restart the service on a node after its start failed.

`-state` `<disabled | enabled | started | stopped>` ('default =' `started`)::
`--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::

Requested resource state.

`-type` `<ct | vm>` ::
`--type` `<ct | vm>` ::

Resource type.

@@ -38,14 +38,14 @@ Resource type.

List HA resources.

`-type` `<ct | vm>` ::
`--type` `<ct | vm>` ::

Only list resources of specific type




*ha-manager groupadd* `<group> -nodes <string>` `[OPTIONS]`
*ha-manager groupadd* `<group> --nodes <string>` `[OPTIONS]`

Create a new HA group.

@@ -53,23 +53,23 @@ Create a new HA group.

The HA group identifier.

`-comment` `<string>` ::
`--comment` `<string>` ::

Description.

`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::

List of cluster node names with optional priority.

`-nofailback` `<boolean>` ('default =' `0`)::
`--nofailback` `<boolean>` ('default =' `0`)::

The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.

`-restricted` `<boolean>` ('default =' `0`)::
`--restricted` `<boolean>` ('default =' `0`)::

Resources bound to restricted groups may only run on nodes defined by the group.

`-type` `<group>` ::
`--type` `<group>` ::

Group type.

@@ -99,27 +99,27 @@ Update ha group configuration.

The HA group identifier.

`-comment` `<string>` ::
`--comment` `<string>` ::

Description.

`-delete` `<string>` ::
`--delete` `<string>` ::

A list of settings you want to delete.

`-digest` `<string>` ::
`--digest` `<string>` ::

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

`-nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::
`--nodes` `<node>[:<pri>]{,<node>[:<pri>]}*` ::

List of cluster node names with optional priority.

`-nofailback` `<boolean>` ('default =' `0`)::
`--nofailback` `<boolean>` ('default =' `0`)::

The CRM tries to run services on the node with the highest priority. If a node with higher priority comes online, the CRM migrates the service to that node. Enabling nofailback prevents that behavior.

`-restricted` `<boolean>` ('default =' `0`)::
`--restricted` `<boolean>` ('default =' `0`)::

Resources bound to restricted groups may only run on nodes defined by the group.

@@ -134,7 +134,7 @@ Get help about specified command.

Command name

`-verbose` `<boolean>` ::
`--verbose` `<boolean>` ::

Verbose output format.

@@ -188,31 +188,31 @@ Update resource configuration.

HA resource ID. This consists of a resource type followed by a resource specific name, separated with colon (example: vm:100 / ct:100). For virtual machines and containers, you can simply use the VM or CT id as a shortcut (example: 100).

`-comment` `<string>` ::
`--comment` `<string>` ::

Description.

`-delete` `<string>` ::
`--delete` `<string>` ::

A list of settings you want to delete.

`-digest` `<string>` ::
`--digest` `<string>` ::

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

`-group` `<string>` ::
`--group` `<string>` ::

The HA group identifier.

`-max_relocate` `<integer> (0 - N)` ('default =' `1`)::
`--max_relocate` `<integer> (0 - N)` ('default =' `1`)::

Maximal number of service relocate tries when a service failes to start.

`-max_restart` `<integer> (0 - N)` ('default =' `1`)::
`--max_restart` `<integer> (0 - N)` ('default =' `1`)::

Maximal number of tries to restart the service on a node after its start failed.

`-state` `<disabled | enabled | started | stopped>` ('default =' `started`)::
`--state` `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::

Requested resource state.

@@ -223,7 +223,7 @@ Requested resource state.

Display HA manger status.

`-verbose` `<boolean>` ('default =' `0`)::
`--verbose` `<boolean>` ('default =' `0`)::

Verbose output. Include complete CRM and LRM status (JSON).


+ 10
- 2
ha-resources-opts.adoc View File

@@ -8,13 +8,13 @@ The HA group identifier.

`max_relocate`: `<integer> (0 - N)` ('default =' `1`)::

Maximal number of service relocate tries when a service fails to start.
Maximal number of service relocate tries when a service failes to start.

`max_restart`: `<integer> (0 - N)` ('default =' `1`)::

Maximal number of tries to restart the service on a node after its start failed.

`state`: `<disabled | enabled | started | stopped>` ('default =' `started`)::
`state`: `<disabled | enabled | ignored | started | stopped>` ('default =' `started`)::

Requested resource state. The CRM reads this state and acts accordingly.
Please note that `enabled` is just an alias for `started`.
@@ -37,4 +37,12 @@ The CRM tries to put the resource in `stopped` state, but does not try
to relocate the resources on node failures. The main purpose of this
state is error recovery, because it is the only way to move a resource out
of the `error` state.
+
`ignored`;;
+
The resource gets removed from the manager status and so the CRM and the LRM do
not touch the resource anymore. All {pve} API calls affecting this resource
will be executed, directly bypassing the HA stack. CRM commands will be thrown
away while there source is in this state. The resource will not get relocated
on node failures.


+ 3
- 3
pct-network-opts.adoc View File

@@ -1,4 +1,4 @@
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::

Specifies network interfaces for the container.

@@ -22,11 +22,11 @@ Default gateway for IPv6 traffic.

The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)

`ip`=`<IPv4Format/CIDR>` ;;
`ip`=`<(IPv4/CIDR|dhcp|manual)>` ;;

IPv4 address in CIDR format.

`ip6`=`<IPv6Format/CIDR>` ;;
`ip6`=`<(IPv6/CIDR|auto|dhcp|manual)>` ;;

IPv6 address in CIDR format.


+ 118
- 118
pct.1-synopsis.adoc View File

@@ -1,6 +1,6 @@
*pct* `<COMMAND> [ARGS] [OPTIONS]`

*pct clone* `<vmid> <newid> -experimental <boolean>` `[OPTIONS]`
*pct clone* `<vmid> <newid> --experimental <boolean>` `[OPTIONS]`

Create a container clone/copy

@@ -12,31 +12,31 @@ The (unique) ID of the VM.

VMID for the clone.

`-description` `<string>` ::
`--description` `<string>` ::

Description for the new CT.

`-experimental` `<boolean>` ('default =' `0`)::
`--experimental` `<boolean>` ('default =' `0`)::

The clone feature is experimental, set this flag if you know what you are doing.

`-full` `<boolean>` ('default =' `0`)::
`--full` `<boolean>` ('default =' `0`)::

Create a full copy of all disk. This is always done when you clone a normal CT. For CT templates, we try to create a linked clone by default.

`-hostname` `<string>` ::
`--hostname` `<string>` ::

Set a hostname for the new CT.

`-pool` `<string>` ::
`--pool` `<string>` ::

Add the new CT to the specified pool.

`-snapname` `<string>` ::
`--snapname` `<string>` ::

The name of the snapshot.

`-storage` `<string>` ::
`--storage` `<string>` ::

Target storage for full clone.
+
@@ -85,131 +85,131 @@ The (unique) ID of the VM.

The OS template or backup file.

`-arch` `<amd64 | i386>` ('default =' `amd64`)::
`--arch` `<amd64 | i386>` ('default =' `amd64`)::

OS architecture type.

`-cmode` `<console | shell | tty>` ('default =' `tty`)::
`--cmode` `<console | shell | tty>` ('default =' `tty`)::

Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).

`-console` `<boolean>` ('default =' `1`)::
`--console` `<boolean>` ('default =' `1`)::

Attach a console device (/dev/console) to the container.

`-cores` `<integer> (1 - 128)` ::
`--cores` `<integer> (1 - 128)` ::

The number of cores assigned to the container. A container can use all available cores by default.

`-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::

Limit of CPU usage.
+
NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.

`-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
`--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::

CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.

`-description` `<string>` ::
`--description` `<string>` ::

Container description. Only used on the configuration web interface.

`-force` `<boolean>` ::
`--force` `<boolean>` ::

Allow to overwrite existing container.

`-hostname` `<string>` ::
`--hostname` `<string>` ::

Set a host name for the container.

`-ignore-unpack-errors` `<boolean>` ::
`--ignore-unpack-errors` `<boolean>` ::

Ignore errors when extracting the template.

`-lock` `<backup | migrate | rollback | snapshot>` ::
`--lock` `<backup | migrate | rollback | snapshot>` ::

Lock/unlock the VM.

`-memory` `<integer> (16 - N)` ('default =' `512`)::
`--memory` `<integer> (16 - N)` ('default =' `512`)::

Amount of RAM for the VM in MB.

`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::

Use volume as container mount point.

`-nameserver` `<string>` ::
`--nameserver` `<string>` ::

Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.

`-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::

Specifies network interfaces for the container.

`-onboot` `<boolean>` ('default =' `0`)::
`--onboot` `<boolean>` ('default =' `0`)::

Specifies whether a VM will be started during system bootup.

`-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::

OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.

`-password` ::
`--password` ::

Sets root password inside container.

`-pool` `<string>` ::
`--pool` `<string>` ::

Add the VM to the specified pool.

`-protection` `<boolean>` ('default =' `0`)::
`--protection` `<boolean>` ('default =' `0`)::

Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.

`-restore` `<boolean>` ::
`--restore` `<boolean>` ::

Mark this as restore task.

`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::

Use volume as container root.

`-searchdomain` `<string>` ::
`--searchdomain` `<string>` ::

Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.

`-ssh-public-keys` `<string>` ::
`--ssh-public-keys` `<filepath>` ::

Setup public SSH keys (one key per line, OpenSSH format).

`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::

Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.

`-storage` `<string>` ('default =' `local`)::
`--storage` `<string>` ('default =' `local`)::

Default Storage.

`-swap` `<integer> (0 - N)` ('default =' `512`)::
`--swap` `<integer> (0 - N)` ('default =' `512`)::

Amount of SWAP for the VM in MB.

`-template` `<boolean>` ('default =' `0`)::
`--template` `<boolean>` ('default =' `0`)::

Enable/disable Template.

`-tty` `<integer> (0 - 6)` ('default =' `2`)::
`--tty` `<integer> (0 - 6)` ('default =' `2`)::

Specify the number of tty available to the container

`-unprivileged` `<boolean>` ('default =' `0`)::
`--unprivileged` `<boolean>` ('default =' `0`)::

Makes the container run as unprivileged user. (Should not be modified manually.)

`-unused[n]` `<string>` ::
`--unused[n]` `<string>` ::

Reference to unused volumes. This is used internally, and should not be modified manually.

@@ -228,7 +228,7 @@ The (unique) ID of the VM.

The name of the snapshot.

`-force` `<boolean>` ::
`--force` `<boolean>` ::

For removal from config file, even if removing disk snapshots fails.

@@ -288,11 +288,11 @@ Run a filesystem check (fsck) on a container volume.

The (unique) ID of the VM.

`-device` `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::
`--device` `<mp0 | mp1 | mp2 | mp3 | mp4 | mp5 | mp6 | mp7 | mp8 | mp9 | rootfs>` ::

A volume on which to run the filesystem check

`-force` `<boolean>` ('default =' `0`)::
`--force` `<boolean>` ('default =' `0`)::

Force checking, even if the filesystem seems clean

@@ -307,7 +307,7 @@ Get help about specified command.

Command name

`-verbose` `<boolean>` ::
`--verbose` `<boolean>` ::

Verbose output format.

@@ -344,19 +344,19 @@ The (unique) ID of the VM.

Target node.

`-force` `<boolean>` ::
`--force` `<boolean>` ::

Force migration despite local bind / device mounts. NOTE: deprecated, use 'shared' property of mount point instead.

`-online` `<boolean>` ::
`--online` `<boolean>` ::

Use online/live migration.

`-restart` `<boolean>` ::
`--restart` `<boolean>` ::

Use restart migration

`-timeout` `<integer>` ('default =' `180`)::
`--timeout` `<integer>` ('default =' `180`)::

Timeout in seconds for shutdown for restart migration

@@ -391,15 +391,15 @@ Path to a file inside the container to pull.

Destination

`-group` `<string>` ::
`--group` `<string>` ::

Owner group name or id.

`-perms` `<string>` ::
`--perms` `<string>` ::

File permissions to use (octal by default, prefix with '0x' for hexadecimal).

`-user` `<string>` ::
`--user` `<string>` ::

Owner user name or id.

@@ -421,15 +421,15 @@ Path to a local file.

Destination inside the container to write to.

`-group` `<string>` ::
`--group` `<string>` ::

Owner group name or id. When using a name it must exist inside the container.

`-perms` `<string>` ::
`--perms` `<string>` ::

File permissions to use (octal by default, prefix with '0x' for hexadecimal).

`-user` `<string>` ::
`--user` `<string>` ::

Owner user name or id. When using a name it must exist inside the container.

@@ -452,7 +452,7 @@ The disk you want to resize.

The new size. With the '+' sign the value is added to the actual size of the volume and without it, the value is taken as an absolute one. Shrinking disk size is not supported.

`-digest` `<string>` ::
`--digest` `<string>` ::

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

@@ -470,127 +470,127 @@ The (unique) ID of the VM.

The OS template or backup file.

`-arch` `<amd64 | i386>` ('default =' `amd64`)::
`--arch` `<amd64 | i386>` ('default =' `amd64`)::

OS architecture type.

`-cmode` `<console | shell | tty>` ('default =' `tty`)::
`--cmode` `<console | shell | tty>` ('default =' `tty`)::

Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).

`-console` `<boolean>` ('default =' `1`)::
`--console` `<boolean>` ('default =' `1`)::

Attach a console device (/dev/console) to the container.

`-cores` `<integer> (1 - 128)` ::
`--cores` `<integer> (1 - 128)` ::

The number of cores assigned to the container. A container can use all available cores by default.

`-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::

Limit of CPU usage.
+
NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.

`-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
`--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::

CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.

`-description` `<string>` ::
`--description` `<string>` ::

Container description. Only used on the configuration web interface.

`-force` `<boolean>` ::
`--force` `<boolean>` ::

Allow to overwrite existing container.

`-hostname` `<string>` ::
`--hostname` `<string>` ::

Set a host name for the container.

`-ignore-unpack-errors` `<boolean>` ::
`--ignore-unpack-errors` `<boolean>` ::

Ignore errors when extracting the template.

`-lock` `<backup | migrate | rollback | snapshot>` ::
`--lock` `<backup | migrate | rollback | snapshot>` ::

Lock/unlock the VM.

`-memory` `<integer> (16 - N)` ('default =' `512`)::
`--memory` `<integer> (16 - N)` ('default =' `512`)::

Amount of RAM for the VM in MB.

`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::

Use volume as container mount point.

`-nameserver` `<string>` ::
`--nameserver` `<string>` ::

Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.

`-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::

Specifies network interfaces for the container.

`-onboot` `<boolean>` ('default =' `0`)::
`--onboot` `<boolean>` ('default =' `0`)::

Specifies whether a VM will be started during system bootup.

`-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::

OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.

`-password` ::
`--password` ::

Sets root password inside container.

`-pool` `<string>` ::
`--pool` `<string>` ::

Add the VM to the specified pool.

`-protection` `<boolean>` ('default =' `0`)::
`--protection` `<boolean>` ('default =' `0`)::

Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.

`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::

Use volume as container root.

`-searchdomain` `<string>` ::
`--searchdomain` `<string>` ::

Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.

`-ssh-public-keys` `<string>` ::
`--ssh-public-keys` `<filepath>` ::

Setup public SSH keys (one key per line, OpenSSH format).

`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::

Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.

`-storage` `<string>` ('default =' `local`)::
`--storage` `<string>` ('default =' `local`)::

Default Storage.

`-swap` `<integer> (0 - N)` ('default =' `512`)::
`--swap` `<integer> (0 - N)` ('default =' `512`)::

Amount of SWAP for the VM in MB.

`-template` `<boolean>` ('default =' `0`)::
`--template` `<boolean>` ('default =' `0`)::

Enable/disable Template.

`-tty` `<integer> (0 - 6)` ('default =' `2`)::
`--tty` `<integer> (0 - 6)` ('default =' `2`)::

Specify the number of tty available to the container

`-unprivileged` `<boolean>` ('default =' `0`)::
`--unprivileged` `<boolean>` ('default =' `0`)::

Makes the container run as unprivileged user. (Should not be modified manually.)

`-unused[n]` `<string>` ::
`--unused[n]` `<string>` ::

Reference to unused volumes. This is used internally, and should not be modified manually.

@@ -631,111 +631,111 @@ Set container options.

The (unique) ID of the VM.

`-arch` `<amd64 | i386>` ('default =' `amd64`)::
`--arch` `<amd64 | i386>` ('default =' `amd64`)::

OS architecture type.

`-cmode` `<console | shell | tty>` ('default =' `tty`)::
`--cmode` `<console | shell | tty>` ('default =' `tty`)::

Console mode. By default, the console command tries to open a connection to one of the available tty devices. By setting cmode to 'console' it tries to attach to /dev/console instead. If you set cmode to 'shell', it simply invokes a shell inside the container (no login).

`-console` `<boolean>` ('default =' `1`)::
`--console` `<boolean>` ('default =' `1`)::

Attach a console device (/dev/console) to the container.

`-cores` `<integer> (1 - 128)` ::
`--cores` `<integer> (1 - 128)` ::

The number of cores assigned to the container. A container can use all available cores by default.

`-cpulimit` `<number> (0 - 128)` ('default =' `0`)::
`--cpulimit` `<number> (0 - 128)` ('default =' `0`)::

Limit of CPU usage.
+
NOTE: If the computer has 2 CPUs, it has a total of '2' CPU time. Value '0' indicates no CPU limit.

`-cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::
`--cpuunits` `<integer> (0 - 500000)` ('default =' `1024`)::

CPU weight for a VM. Argument is used in the kernel fair scheduler. The larger the number is, the more CPU time this VM gets. Number is relative to the weights of all the other running VMs.
+
NOTE: You can disable fair-scheduler configuration by setting this to 0.

`-delete` `<string>` ::
`--delete` `<string>` ::

A list of settings you want to delete.

`-description` `<string>` ::
`--description` `<string>` ::

Container description. Only used on the configuration web interface.

`-digest` `<string>` ::
`--digest` `<string>` ::

Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.

`-hostname` `<string>` ::
`--hostname` `<string>` ::

Set a host name for the container.

`-lock` `<backup | migrate | rollback | snapshot>` ::
`--lock` `<backup | migrate | rollback | snapshot>` ::

Lock/unlock the VM.

`-memory` `<integer> (16 - N)` ('default =' `512`)::
`--memory` `<integer> (16 - N)` ('default =' `512`)::

Amount of RAM for the VM in MB.

`-mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
`--mp[n]` `[volume=]<volume> ,mp=<Path> [,acl=<1|0>] [,backup=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::

Use volume as container mount point.

`-nameserver` `<string>` ::
`--nameserver` `<string>` ::

Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.

`-net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`--net[n]` `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::

Specifies network interfaces for the container.

`-onboot` `<boolean>` ('default =' `0`)::
`--onboot` `<boolean>` ('default =' `0`)::

Specifies whether a VM will be started during system bootup.

`-ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::
`--ostype` `<alpine | archlinux | centos | debian | fedora | gentoo | opensuse | ubuntu | unmanaged>` ::

OS type. This is used to setup configuration inside the container, and corresponds to lxc setup scripts in /usr/share/lxc/config/<ostype>.common.conf. Value 'unmanaged' can be used to skip and OS specific setup.

`-protection` `<boolean>` ('default =' `0`)::
`--protection` `<boolean>` ('default =' `0`)::

Sets the protection flag of the container. This will prevent the CT or CT's disk remove/update operation.

`-rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::
`--rootfs` `[volume=]<volume> [,acl=<1|0>] [,quota=<1|0>] [,replicate=<1|0>] [,ro=<1|0>] [,shared=<1|0>] [,size=<DiskSize>]` ::

Use volume as container root.

`-searchdomain` `<string>` ::
`--searchdomain` `<string>` ::

Sets DNS search domains for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.

`-startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::
`--startup` `[[order=]\d+] [,up=\d+] [,down=\d+] ` ::

Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped.

`-swap` `<integer> (0 - N)` ('default =' `512`)::
`--swap` `<integer> (0 - N)` ('default =' `512`)::

Amount of SWAP for the VM in MB.

`-template` `<boolean>` ('default =' `0`)::
`--template` `<boolean>` ('default =' `0`)::

Enable/disable Template.

`-tty` `<integer> (0 - 6)` ('default =' `2`)::
`--tty` `<integer> (0 - 6)` ('default =' `2`)::

Specify the number of tty available to the container

`-unprivileged` `<boolean>` ('default =' `0`)::
`--unprivileged` `<boolean>` ('default =' `0`)::

Makes the container run as unprivileged user. (Should not be modified manually.)

`-unused[n]` `<string>` ::
`--unused[n]` `<string>` ::

Reference to unused volumes. This is used internally, and should not be modified manually.

@@ -751,11 +751,11 @@ container, see lxc-stop(1) for details.

The (unique) ID of the VM.

`-forceStop` `<boolean>` ('default =' `0`)::
`--forceStop` `<boolean>` ('default =' `0`)::

Make sure the Container stops.

`-timeout` `<integer> (0 - N)` ('default =' `60`)::
`--timeout` `<integer> (0 - N)` ('default =' `60`)::

Wait maximal timeout seconds.

@@ -774,7 +774,7 @@ The (unique) ID of the VM.

The name of the snapshot.

`-description` `<string>` ::
`--description` `<string>` ::

A textual description or comment.

@@ -789,7 +789,7 @@ Start the container.

The (unique) ID of the VM.

`-skiplock` `<boolean>` ::
`--skiplock` `<boolean>` ::

Ignore locks - only root is allowed to use this option.

@@ -804,7 +804,7 @@ Show CT status.

The (unique) ID of the VM.

`-verbose` `<boolean>` ::
`--verbose` `<boolean>` ::

Verbose output format

@@ -820,7 +820,7 @@ container.

The (unique) ID of the VM.

`-skiplock` `<boolean>` ::
`--skiplock` `<boolean>` ::

Ignore locks - only root is allowed to use this option.

@@ -837,7 +837,7 @@ The (unique) ID of the VM.



*pct template* `<vmid> -experimental <boolean>` `[OPTIONS]`
*pct template* `<vmid> --experimental <boolean>` `[OPTIONS]`

Create a Template.

@@ -845,7 +845,7 @@ Create a Template.

The (unique) ID of the VM.

`-experimental` `<boolean>` ('default =' `0`)::
`--experimental` `<boolean>` ('default =' `0`)::

The template feature is experimental, set this flag if you know what you are doing.


+ 3
- 3
pct.conf.5-opts.adoc View File

@@ -90,7 +90,7 @@ Volume, device or directory to mount into the container.

Sets DNS server IP address for a container. Create will automatically use the setting from the host if you neither set searchdomain nor nameserver.

`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<IPv4Format/CIDR>] [,ip6=<IPv6Format/CIDR>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::
`net[n]`: `name=<string> [,bridge=<bridge>] [,firewall=<1|0>] [,gw=<GatewayIPv4>] [,gw6=<GatewayIPv6>] [,hwaddr=<XX:XX:XX:XX:XX:XX>] [,ip=<(IPv4/CIDR|dhcp|manual)>] [,ip6=<(IPv6/CIDR|auto|dhcp|manual)>] [,mtu=<integer>] [,rate=<mbps>] [,tag=<integer>] [,trunks=<vlanid[;vlanid...]>] [,type=<veth>]` ::

Specifies network interfaces for the container.

@@ -114,11 +114,11 @@ Default gateway for IPv6 traffic.

The interface MAC address. This is dynamically allocated by default, but you can set that statically if needed, for example to always have the same link-local IPv6 address. (lxc.network.hwaddr)

`ip`=`<IPv4Format/CIDR>` ;;
`ip`=`<(IPv4/CIDR|dhcp|manual)>` ;;

IPv4 address in CIDR format.

`ip6`=`<IPv6Format/CIDR>` ;;
`ip6`=`<(IPv6/CIDR|auto|dhcp|manual)>` ;;

IPv6 address in CIDR format.


+ 1
- 1
pve-firewall-macros.adoc View File

@@ -56,7 +56,7 @@
|===========================================================

[horizontal]
'Ceph':: Ceph Storage Cluster traffic (Ceph Monitors, OSD & MDS Daemons)
'Ceph':: Ceph Storage Cluster traffic (Ceph Monitors, OSD & MDS Deamons)

[width="100%",options="header"]
|===========================================================

+ 6
- 6
pve-firewall-rules-opts.adoc View File

@@ -1,24 +1,24 @@
`-dest` `<string>` ::
`--dest` `<string>` ::

Restrict packet destination address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.

`-dport` `<string>` ::
`--dport` `<string>` ::

Restrict TCP/UDP destination port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.

`-iface` `<string>` ::
`--iface` `<string>` ::

Network interface name. You have to use network configuration key names for VMs and containers ('net\d+'). Host related rules can use arbitrary strings.

`-proto` `<string>` ::
`--proto` `<string>` ::

IP protocol. You can use protocol names ('tcp'/'udp') or simple numbers, as defined in '/etc/protocols'.

`-source` `<string>` ::
`--source` `<string>` ::

Restrict packet source address. This can refer to a single IP address, an IP set ('+ipsetname') or an IP alias definition. You can also specify an address range like '20.34.101.207-201.3.9.99', or a list of IP addresses and networks (entries are separated by comma). Please do not mix IPv4 and IPv6 addresses inside such lists.

`-sport` `<string>` ::
`--sport` `<string>` ::

Restrict TCP/UDP source port. You can use service names or simple numbers (0-65535), as defined in '/etc/services'. Port ranges can be specified with '\d+:\d+', for example '80:85', and you can use comma separated list to match several ports or ranges.


+ 10
- 10
pve-firewall.8-synopsis.adoc View File

@@ -15,7 +15,7 @@ Get help about specified command.

Command name

`-verbose` `<boolean>` ::
`--verbose` `<boolean>` ::

Verbose output format.

@@ -40,35 +40,35 @@ Simulate firewall rules. This does not simulate kernel 'routing' table.
Instead, this simply assumes that routing from source zone to destination
zone is possible.

`-dest` `<string>` ::
`--dest` `<string>` ::

Destination IP address.

`-dport` `<integer>` ::
`--dport` `<integer>` ::

Destination port.

`-from` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `outside`)::
`--from` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `outside`)::

Source zone.

`-protocol` `(tcp|udp)` ('default =' `tcp`)::
`--protocol` `(tcp|udp)` ('default =' `tcp`)::

Protocol.

`-source` `<string>` ::
`--source` `<string>` ::

Source IP address.

`-sport` `<integer>` ::
`--sport` `<integer>` ::

Source port.

`-to` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `host`)::
`--to` `(host|outside|vm\d+|ct\d+|vmbr\d+/\S+)` ('default =' `host`)::

Destination zone.

`-verbose` `<boolean>` ('default =' `0`)::
`--verbose` `<boolean>` ('default =' `0`)::

Verbose output.

@@ -78,7 +78,7 @@ Verbose output.

Start the Proxmox VE firewall service.

`-debug` `<boolean>` ('default =' `0`)::
`--debug` `<boolean>` ('default =' `0`)::

Debug mode - stay in foreground


+ 2
- 2
pve-ha-crm.8-synopsis.adoc View File

@@ -8,7 +8,7 @@ Get help about specified command.

Command name

`-verbose` `<boolean>` ::
`--verbose` `<boolean>` ::

Verbose output format.

@@ -19,7 +19,7 @@ Verbose output format.

Start the daemon.

`-debug` `<boolean>` ('default =' `0`)::
`--debug` `<boolean>` ('default =' `0`)::

Debug mode - stay in foreground


+ 2
- 2
pve-ha-lrm.8-synopsis.adoc View File

@@ -8,7 +8,7 @@ Get help about specified command.

Command name

`-verbose` `<boolean>` ::
`--verbose` `<boolean>` ::

Verbose output format.

@@ -19,7 +19,7 @@ Verbose output format.

Start the daemon.

`-debug` `<boolean>` ('default =' `0`)::
`--debug` `<boolean>` ('default =' `0`)::

Debug mode - stay in foreground


+ 2
- 2
pveam.1-synopsis.adoc View File

@@ -4,7 +4,7 @@

List available templates.

`-section` `<system | turnkeylinux>` ::
`--section` `<system | turnkeylinux>` ::

Restrict list to specified section.

@@ -34,7 +34,7 @@ Get help about specified command.

Command name

`-verbose` `<boolean>` ::
`--verbose` `<boolean>` ::

Verbose output format.


+ 73
- 25
pveceph.1-synopsis.adoc View File

@@ -1,8 +1,26 @@
*pveceph* `<COMMAND> [ARGS] [OPTIONS]`

*pveceph createmon*
*pveceph createmgr* `[OPTIONS]`

Create Ceph Monitor
Create Ceph Manager

`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::

The ID for the manager, when omitted the same as the nodename



*pveceph createmon* `[OPTIONS]`

Create Ceph Monitor and Manager

`--exclude-manager` `<boolean>` ('default =' `0`)::

When set, only a monitor will be created.

`--id` `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::

The ID for the monitor, when omitted the same as the nodename



@@ -15,17 +33,21 @@ Create OSD

Block device name.

`-bluestore` `<boolean>` ('default =' `0`)::
`--bluestore` `<boolean>` ('default =' `0`)::

Use bluestore instead of filestore.

`-fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::
`--fstype` `<btrfs | ext4 | xfs>` ('default =' `xfs`)::

File system type (filestore only).

`-journal_dev` `<string>` ::
`--journal_dev` `<string>` ::

Block device name for journal.
Block device name for journal (filestore) or block.db (bluestore).

`--wal_dev` `<string>` ::

Block device name for block.wal (bluestore only).



@@ -38,32 +60,54 @@ Create POOL

The name of the pool. It must be unique.

`-crush_ruleset` `<integer> (0 - 32768)` ('default =' `0`)::
`--add_storages` `<boolean>` ::

Configure VM and CT storages using the new pool.

The ruleset to use for mapping object placement in the cluster.
`--application` `<cephfs | rbd | rgw>` ::

`-min_size` `<integer> (1 - 7)` ('default =' `1`)::
The application of the pool, 'rbd' by default.

`--crush_rule` `<string>` ::

The rule to use for mapping object placement in the cluster.

`--min_size` `<integer> (1 - 7)` ('default =' `2`)::

Minimum number of replicas per object

`-pg_num` `<integer> (8 - 32768)` ('default =' `64`)::
`--pg_num` `<integer> (8 - 32768)` ('default =' `64`)::

Number of placement groups.

`-size` `<integer> (1 - 7)` ('default =' `2`)::
`--size` `<integer> (1 - 7)` ('default =' `3`)::

Number of replicas per object



*pveceph destroymon* `<monid>`
*pveceph destroymgr* `<id>`

Destroy Ceph Manager.

`<id>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::

The ID of the manager


Destroy Ceph monitor.

`<monid>`: `<integer>` ::
*pveceph destroymon* `<monid>` `[OPTIONS]`

Destroy Ceph Monitor and Manager.

`<monid>`: `[a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?` ::

Monitor ID

`--exclude-manager` `<boolean>` ('default =' `0`)::

When set, removes only the monitor, not the manager




@@ -75,7 +119,7 @@ Destroy OSD

OSD ID

`-cleanup` `<boolean>` ('default =' `0`)::
`--cleanup` `<boolean>` ('default =' `0`)::

If set, we remove partition table entries.

@@ -90,10 +134,14 @@ Destroy pool

The name of the pool. It must be unique.

`-force` `<boolean>` ('default =' `0`)::
`--force` `<boolean>` ('default =' `0`)::

If true, destroys pool even if in use

`--remove_storages` `<boolean>` ('default =' `0`)::

Remove all pveceph-managed storages configured for this pool




@@ -105,7 +153,7 @@ Get help about specified command.

Command name

`-verbose` `<boolean>` ::
`--verbose` `<boolean>` ::

Verbose output format.

@@ -116,27 +164,27 @@ Verbose output format.

Create initial ceph default configuration and setup symlinks.

`-disable_cephx` `<boolean>` ('default =' `0`)::
`--disable_cephx` `<boolean>` ('default =' `0`)::

Disable cephx authentification.
+
WARNING: cephx is a security feature protecting against man-in-the-middle attacks. Only consider disabling cephx if your network is private!

`-min_size` `<integer> (1 - 7)` ('default =' `2`)::
`--min_size` `<integer> (1 - 7)` ('default =' `2`)::

Minimum number of available replicas per object to allow I/O

`-network` `<string>` ::
`--network` `<string>` ::

Use specific network for all ceph related traffic

`-pg_bits` `<integer> (6 - 14)` ('default =' `6`)::
`--pg_bits` `<integer> (6 - 14)` ('default =' `6`)::

Placement group bits, used to specify the default number of placement groups.
+
NOTE: 'osd pool default pg num' does not work for default pools.

`-size` `<integer> (1 - 7)` ('default =' `3`)::
`--size` `<integer> (1 - 7)` ('default =' `3`)::

Targeted number of replicas per object

@@ -147,7 +195,7 @@ Targeted number of replicas per object