nodes / services
7 operations.
GET /nodes/{node}/services
ts
proxmox.nodes.$(node).services.$get()Service list.
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
GET /nodes/{node}/services/{service}
ts
proxmox.nodes.$(node).services.$(service).$get()Directory index
Returns an array of object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
service | chrony | corosync | cron | ksmtuned | lxcfs | postfix | proxmox-firewall | pve-cluster | … (15 more) | yes | Service ID |
POST /nodes/{node}/services/{service}/reload
ts
proxmox.nodes.$(node).services.$(service).reload.$post()Reload service. Falls back to restart if service cannot be reloaded.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
service | chrony | corosync | cron | ksmtuned | lxcfs | postfix | proxmox-firewall | pve-cluster | … (15 more) | yes | Service ID |
POST /nodes/{node}/services/{service}/restart
ts
proxmox.nodes.$(node).services.$(service).restart.$post()Hard restart service. Use reload if you want to reduce interruptions.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
service | chrony | corosync | cron | ksmtuned | lxcfs | postfix | proxmox-firewall | pve-cluster | … (15 more) | yes | Service ID |
POST /nodes/{node}/services/{service}/start
ts
proxmox.nodes.$(node).services.$(service).start.$post()Start service.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
service | chrony | corosync | cron | ksmtuned | lxcfs | postfix | proxmox-firewall | pve-cluster | … (15 more) | yes | Service ID |
GET /nodes/{node}/services/{service}/state
ts
proxmox.nodes.$(node).services.$(service).state.$get()Read service properties
Returns object.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
service | chrony | corosync | cron | ksmtuned | lxcfs | postfix | proxmox-firewall | pve-cluster | … (15 more) | yes | Service ID |
POST /nodes/{node}/services/{service}/stop
ts
proxmox.nodes.$(node).services.$(service).stop.$post()Stop service.
Returns string.
| Parameter | Type | Required | Notes |
|---|---|---|---|
node | string | yes | The cluster node name. — format pve-node |
service | chrony | corosync | cron | ksmtuned | lxcfs | postfix | proxmox-firewall | pve-cluster | … (15 more) | yes | Service ID |