Proxmox API

https://docs.rs/proxmox-api/0.1.1
Admin
Proxmox API is a Rust client library for interacting with the Proxmox virtualization platform,...
Tokens:913,997
Snippets:5,160
Trust Score:9.1
Update:6 months ago
Show doc for...
Tokens:
Raw
### Start VM

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/qemu/vmid/status/struct.StatusClient.html

Starts a QEMU virtual machine.

```APIDOC
## POST /nodes/{node}/qemu/{vmid}/start

### Description
Starts a specified QEMU virtual machine.

### Method
POST

### Endpoint
/nodes/{node}/qemu/{vmid}/start

### Parameters
#### Path Parameters
- **node** (string) - Required - The ID of the node.
- **vmid** (integer) - Required - The ID of the virtual machine.

### Request Body
(No request body parameters specified)

### Response
#### Success Response (200)
- **data** (object) - An empty object indicating success.

#### Response Example
```json
{
  "data": {}
}
```
```

--------------------------------

### Start QEMU VM Client and Parameters

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/status/start.rs.html

Defines the client for starting a virtual machine and its associated parameters. Use this to initiate a VM start operation with optional configurations.

```rust
pub struct StartClient<T> {
    client: T,
    path: String,
}
impl<T>
where
    T: crate::client::Client,
{
    pub fn new(client: T, parent_path: &str) -> Self {
        Self {
            client,
            path: format!("{}{}", parent_path, "/start"),
        }
    }
}
impl<T>
where
    T: crate::client::Client,
{
    #[doc = "Start virtual machine."]
    pub fn post(&self, params: PostParams) -> Result<String, T::Error> {
        let path = self.path.to_string();
        self.client.post(&path, &params)
    }
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize, Default)]
pub struct PostParams {
    #[serde(rename = "force-cpu")]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Override QEMU's -cpu argument with the given string."]
    pub force_cpu: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Specifies the QEMU machine type."]
    pub machine: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "The cluster node name."]
    pub migratedfrom: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "CIDR of the (sub) network that is used for migration."]
    pub migration_network: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance."]
    pub migration_type: Option<MigrationType>,
    #[serde(
        serialize_with = "crate::types::serialize_bool_optional",
        deserialize_with = "crate::types::deserialize_bool_optional"
    )]
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Ignore locks - only root is allowed to use this option."]
    pub skiplock: Option<bool>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Some command save/restore state from this location."]
    pub stateuri: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself."]
    pub targetstorage: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Wait maximal timeout seconds."]
    pub timeout: Option<()>
    ,
    #[serde(
        flatten,
        default,
        skip_serializing_if = "::std::collections::HashMap::is_empty"
    )]
    pub additional_properties: ::std::collections::HashMap<String, ::serde_json::Value>,
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize)]
pub enum MigrationType {
    #[serde(rename = "insecure")]
    Insecure,
    #[serde(rename = "secure")]
    Secure,
}

```

--------------------------------

### StartallClient Post Method

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/startall.rs.html

Initiates the start operation for all VMs and containers on a node. Optionally, force the start even if 'onboot' is not set, or specify a comma-separated list of VMIDs to start.

```rust
impl<T>
StartallClient<T>
where
    T: crate::client::Client,
{
    #[doc = "Start all VMs and containers located on this node (by default only those with onboot=1)."]
    pub fn post(&self, params: PostParams) -> Result<String, T::Error> {
        let path = self.path.to_string();
        self.client.post(&path, &params)
    }
}
```

--------------------------------

### Create Start VM Client in Rust

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/status.rs.html

Returns a client for starting a QEMU VM. Requires the client to implement `crate::client::Client`.

```rust
impl<T> StatusClient<T>
where
    T: crate::client::Client,
{
    pub fn start(&self) -> start::StartClient<T> {
        start::StartClient::<T>::new(self.client.clone(), &self.path)
    }
}
```

--------------------------------

### Start Virtual Machine

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/qemu/vmid/status/start/struct.StartClient.html

This endpoint allows you to start a virtual machine. It requires a client instance and a path to the specific node and VM.

```APIDOC
## POST /nodes/{node}/qemu/{vmid}/status/start

### Description
Start virtual machine.

### Method
POST

### Endpoint
/nodes/{node}/qemu/{vmid}/status/start

### Parameters
#### Path Parameters
- **node** (string) - Required - The node where the VM resides.
- **vmid** (string) - Required - The ID of the virtual machine.

#### Request Body
- **params** (PostParams) - Required - Parameters for starting the VM. The exact structure of PostParams is not detailed here but is expected to be provided by the `proxmox-api` library.

### Request Example
```json
{
  "params": { ... PostParams structure ... }
}
```

### Response
#### Success Response (200)
- **result** (string) - A string indicating the success of the operation, likely containing a job ID or status message.

#### Response Example
```json
{
  "result": "TASK_ID: VM.Start:100.1"
}
```
```

--------------------------------

### Start Service Client

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/services/service/start.rs.html

Defines a client for starting a service. Requires a client implementation that satisfies the `crate::client::Client` trait. The `post` method initiates the service start operation.

```rust
pub struct StartClient<T> {
    client: T,
    path: String,
}
impl<T> StartClient<T>
where
    T: crate::client::Client,
{
    pub fn new(client: T, parent_path: &str) -> Self {
        Self {
            client,
            path: format!("{}{}", parent_path, "/start"),
        }
    }
}
impl<T> StartClient<T>
where
    T: crate::client::Client,
{
    #[doc = "Start service."]
    pub fn post(&self) -> Result<String, T::Error> {
        let path = self.path.to_string();
        self.client.post(&path, &())
    }
}
```

--------------------------------

### POST /nodes/{node}/startall

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/startall/struct.PostParams.html

Starts all virtual machines on a specified node. Supports optional parameters to force the start command and to specify a comma-separated list of VMIDs to include.

```APIDOC
## POST /nodes/{node}/startall

### Description
Starts all virtual machines on a specified node. This endpoint allows for optional parameters to force the start command and to specify a subset of VMs to start.

### Method
POST

### Endpoint
/nodes/{node}/startall

### Parameters
#### Query Parameters
- **force** (boolean) - Optional - Issue start command even if virtual guest has ‘onboot’ not set or set to off.
- **vms** (string) - Optional - Only consider guests from this comma separated list of VMIDs.

### Request Body
```json
{
  "force": true,
  "vms": "100,101"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **data** (object) - Contains details about the started VMs.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "started": [100, 101],
    "failed": []
  }
}
```
```

--------------------------------

### POST /nodes/{node}/qemu/{vmid}/status/start

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/status/start.rs.html

Starts a QEMU virtual machine. This endpoint allows for various configurations during the start process, such as overriding CPU settings, specifying migration networks, and handling locks.

```APIDOC
## POST /nodes/{node}/qemu/{vmid}/status/start

### Description
Start virtual machine.

### Method
POST

### Endpoint
/nodes/{node}/qemu/{vmid}/status/start

### Parameters
#### Query Parameters
- **node** (string) - Required - The name of the node.
- **vmid** (integer) - Required - The virtual machine ID.

#### Request Body
- **force-cpu** (string) - Optional - Override QEMU's -cpu argument with the given string.
- **machine** (string) - Optional - Specifies the QEMU machine type.
- **migratedfrom** (string) - Optional - The cluster node name.
- **migration_network** (string) - Optional - CIDR of the (sub) network that is used for migration.
- **migration_type** (MigrationType) - Optional - Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
- **skiplock** (boolean) - Optional - Ignore locks - only root is allowed to use this option.
- **stateuri** (string) - Optional - Some command save/restore state from this location.
- **targetstorage** (string) - Optional - Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value '1' will map each source storage to itself.
- **timeout** (integer) - Optional - Wait maximal timeout seconds.

### Request Example
```json
{
  "force-cpu": "host",
  "machine": "q35",
  "migratedfrom": "node1",
  "migration_network": "192.168.1.0/24",
  "migration_type": "insecure",
  "skiplock": true,
  "stateuri": "rbd:myimage",
  "targetstorage": "local-lvm",
  "timeout": 60
}
```

### Response
#### Success Response (200)
- **string** (string) - A success message or status.

#### Response Example
```json
{
  "data": {
    "status": "running"
  }
}
```

### Enum Definitions
#### MigrationType
- **insecure**
- **secure**
```

--------------------------------

### Start LXC Container

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/lxc/vmid/status.rs.html

Initializes a client to start an LXC container. Requires a client implementing the `crate::client::Client` trait.

```rust
impl<T> StatusClient<T>
where
    T: crate::client::Client,
{
    pub fn start(&self) -> start::StartClient<T> {
        start::StartClient::<T>::new(self.client.clone(), &self.path)
    }
}

```

--------------------------------

### InfoClient - Get Agent Info

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/qemu/vmid/agent/info/struct.InfoClient.html

The InfoClient provides methods to retrieve information about QEMU virtual machine agents. The `get` method executes the info command.

```APIDOC
## GET /nodes/{node}/qemu/{vmid}/agent/info

### Description
Retrieves information about the QEMU guest agent.

### Method
GET

### Endpoint
/nodes/{node}/qemu/{vmid}/agent/info

### Parameters
#### Path Parameters
- **node** (string) - Required - The ID of the node.
- **vmid** (integer) - Required - The ID of the virtual machine.

### Response
#### Success Response (200)
- **data** (object) - Information about the guest agent.
  - **state** (string) - The current state of the agent.
  - **version** (string) - The version of the agent.

#### Response Example
```json
{
  "data": {
    "state": "running",
    "version": "3.2.1"
  }
}
```
```

--------------------------------

### GET /nodes/{node}/qemu/{vmid}/agent/exec-status

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/qemu/vmid/agent/exec_status/struct.ExecStatusClient.html

Retrieves the execution status of a process started by the guest agent.

```APIDOC
## GET /nodes/{node}/qemu/{vmid}/agent/exec-status

### Description
Gets the status of a given PID that was started by the guest-agent.

### Method
GET

### Endpoint
/nodes/{node}/qemu/{vmid}/agent/exec-status

### Parameters
#### Request Body
- **params** (GetParams) - Required - Parameters containing the PID to query.

### Response
#### Success Response (200)
- **output** (GetOutput) - The status information of the requested process.
```

--------------------------------

### GET /nodes/{node}/firewall/log

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/firewall/log.rs.html

Retrieves firewall log entries for a specific node. Supports filtering by limit, since, start, and until timestamps.

```APIDOC
## GET /nodes/{node}/firewall/log

### Description
Reads firewall log entries for a specific node. This endpoint allows for filtering the log output based on various parameters.

### Method
GET

### Endpoint
/nodes/{node}/firewall/log

### Parameters
#### Query Parameters
- **limit** (u64) - Optional - Maximum number of log entries to return.
- **since** (u64) - Optional - Display log entries created since this UNIX epoch timestamp.
- **start** (u64) - Optional - The starting line number for log retrieval.
- **until** (u64) - Optional - Display log entries created until this UNIX epoch timestamp.

### Response
#### Success Response (200)
- **n** (u64) - The line number of the log entry.
- **t** (string) - The text content of the log entry.

#### Response Example
```json
[
  {
    "n": 100,
    "t": "IN=eth0 OUT= MAC=00:11:22:33:44:55:00:aa:bb:cc:dd:ee SRC=192.168.1.100 DST=192.168.1.1 LEN=60 UID=1000 GID=1000 PROTO=TCP SPT=1234 DPT=80 "
  },
  {
    "n": 101,
    "t": "..."
  }
]
```
```

--------------------------------

### GetParams Struct Definition

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/cluster/jobs/schedule_analyze/struct.GetParams.html

Defines the parameters for a GET request, including optional iterations and start time, a required schedule string, and additional properties.

```rust
pub struct GetParams {
    pub iterations: Option<u64>,
    pub schedule: String,
    pub starttime: Option<u64>,
    pub additional_properties: HashMap<String, Value>,
}
```

--------------------------------

### GET /nodes/{node}/journal

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/journal.rs.html

Retrieves journal entries for a specific node. Supports filtering by end cursor, last entries, since a specific time, or start cursor.

```APIDOC
## GET /nodes/{node}/journal

### Description
Retrieves journal entries for a specific node. This endpoint allows for flexible querying of log data using various parameters.

### Method
GET

### Endpoint
/nodes/{node}/journal

### Parameters
#### Query Parameters
- **endcursor** (string) - Optional - End before the given Cursor. Conflicts with 'until'.
- **lastentries** (u64) - Optional - Limit to the last X lines. Conflicts with a range.
- **since** (u64) - Optional - Display all log since this UNIX epoch. Conflicts with 'startcursor'.
- **startcursor** (string) - Optional - Start after the given Cursor. Conflicts with 'since'.
- **until** (u64) - Optional - Display all log until this UNIX epoch. Conflicts with 'endcursor'.

### Request Example
```json
{
  "endcursor": "some_cursor_string",
  "lastentries": 100,
  "since": 1678886400,
  "startcursor": "another_cursor_string",
  "until": 1678972800
}
```

### Response
#### Success Response (200)
- **[Array of Strings]** - A list of journal entries.

#### Response Example
```json
[
  "Log entry 1",
  "Log entry 2",
  "Log entry 3"
]
```
```

--------------------------------

### GetOutput Struct Definition

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/tasks/upid/status.rs.html

Defines the structure for the output of the 'get' method, representing task status information. Includes fields like ID, node, PID, start time, status, type, UPID, user, and exit status.

```rust
pub struct GetOutput {
    #[serde(skip_serializing_if = "Option::is_none", default)]
    pub exitstatus: Option<String>,
    pub id: String,
    pub node: String,
    #[serde( 
        serialize_with = "crate::types::serialize_int",
        deserialize_with = "crate::types::deserialize_int"
    )]
    pub pid: u64,
    #[serde(
        serialize_with = "crate::types::serialize_number",
        deserialize_with = "crate::types::deserialize_number"
    )]
    pub starttime: f64,
    pub status: Status,
    #[serde(rename = "type")]
    pub ty: String,
    pub upid: String,
    pub user: String,
    #[serde(
        flatten,
        default,
        skip_serializing_if = "::std::collections::HashMap::is_empty"
    )]
    pub additional_properties: ::std::collections::HashMap<String, ::serde_json::Value>,
}
```

--------------------------------

### Initialize QEMU Client

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/capabilities/qemu.rs.html

Creates a new QEMU client instance. Requires a generic client implementation and the parent path for the API endpoint.

```rust
pub fn new(client: T, parent_path: &str) -> Self {
        Self {
            client,
            path: format!("{}{}", parent_path, "/qemu"),
        }
    }
```

--------------------------------

### POST /nodes/{node}/startall

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/startall.rs.html

Starts all VMs and containers located on the specified node.

```APIDOC
## POST /nodes/{node}/startall

### Description
Start all VMs and containers located on this node (by default only those with onboot=1).

### Method
POST

### Endpoint
/nodes/{node}/startall

### Parameters
#### Request Body
- **force** (Option<()>) - Optional - Issue start command even if virtual guest have 'onboot' not set or set to off.
- **vms** (Option<String>) - Optional - Only consider guests from this comma separated list of VMIDs.

### Request Example
{
  "force": null,
  "vms": "100,101,102"
}

### Response
#### Success Response (200)
- **result** (String) - The result of the startall operation.
```

--------------------------------

### Ceph Start API

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/all.html

Endpoint for starting Ceph services on a node.

```APIDOC
## POST /nodes/{node}/ceph/start

### Description
Starts the Ceph cluster on a specific node.

### Method
POST

### Endpoint
/nodes/{node}/ceph/start

### Parameters
#### Path Parameters
- **node** (string) - Required - The node name.
```

--------------------------------

### POST /nodes/{node}/qemu/{vmid}/status/start

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/qemu/vmid/status/start/struct.PostParams.html

Starts a QEMU virtual machine. The PostParams struct defines the available options for this operation.

```APIDOC
## POST /nodes/{node}/qemu/{vmid}/status/start

### Description
Starts a QEMU virtual machine.

### Method
POST

### Endpoint
/nodes/{node}/qemu/{vmid}/status/start

### Parameters
#### Request Body
- **force_cpu** (Option<String>) - Optional - Override QEMU’s -cpu argument with the given string.
- **machine** (Option<String>) - Optional - Specifies the QEMU machine type.
- **migratedfrom** (Option<String>) - Optional - The cluster node name.
- **migration_network** (Option<String>) - Optional - CIDR of the (sub) network that is used for migration.
- **migration_type** (Option<MigrationType>) - Optional - Migration traffic is encrypted using an SSH tunnel by default. On secure, completely private networks this can be disabled to increase performance.
- **skiplock** (Option<bool>) - Optional - Ignore locks - only root is allowed to use this option.
- **stateuri** (Option<String>) - Optional - Some command save/restore state from this location.
- **targetstorage** (Option<String>) - Optional - Mapping from source to target storages. Providing only a single storage ID maps all source storages to that storage. Providing the special value ‘1’ will map each source storage to itself.
- **timeout** (Option<()>) - Optional - Wait maximal timeout seconds.
- **additional_properties** (HashMap<String, Value>) - Optional - Additional properties for the request.

### Request Example
```json
{
  "force_cpu": "host-passthrough",
  "machine": "q35",
  "migratedfrom": "node1",
  "migration_network": "192.168.1.0/24",
  "migration_type": "ssh",
  "skiplock": false,
  "stateuri": "/path/to/state",
  "targetstorage": "local-lvm",
  "timeout": null
}
```

### Response
#### Success Response (200)
- **status** (string) - The status of the operation.
- **data** (object) - Additional data related to the operation.

#### Response Example
```json
{
  "status": "success",
  "data": {
    "vmid": 100,
    "node": "pve-node1"
  }
}
```
```

--------------------------------

### Access Ceph Start Client

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/ceph/struct.CephClient.html

Returns a StartClient for starting Ceph services.

```rust
pub fn start(&self) -> StartClient<T>
```

--------------------------------

### Initialize ExecClient for QEMU VM Agent

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/agent/exec.rs.html

Creates a new `ExecClient` instance for interacting with the guest agent's exec endpoint. Requires a client implementation and the parent path to the VM's exec endpoint.

```rust
pub fn new(client: T, parent_path: &str) -> Self {
        Self {
            client,
            path: format!("{}{}", parent_path, "/exec"),
        }
    }
```

--------------------------------

### Get IP Sets

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/cluster/firewall/ipset.rs.html

Retrieves a list of all IP Sets. Requires the client to implement the `get` method.

```rust
#[doc = "List IPSets"]
pub fn get(&self) -> Result<Vec<GetOutputItems>, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
```

--------------------------------

### Fsfreeze Freeze Client Initialization

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/agent.rs.html

Initializes a client for the `fsfreeze-freeze` QEMU Guest Agent command. Requires a client implementation and the parent path.

```rust
pub fn fsfreeze_freeze(&self) -> fsfreeze_freeze::FsfreezeFreezeClient<T> {
        fsfreeze_freeze::FsfreezeFreezeClient::<T>::new(self.client.clone(), &self.path)
    }
```

--------------------------------

### POST /nodes/{node}/ceph/start

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/ceph/start.rs.html

Starts Ceph services on a specified node. You can optionally specify which service to start.

```APIDOC
## POST /nodes/{node}/ceph/start

### Description
Starts Ceph services on a specified node. You can optionally specify which service to start.

### Method
POST

### Endpoint
/nodes/{node}/ceph/start

### Parameters
#### Query Parameters
- **node** (string) - Required - The name of the node where Ceph services should be started.

#### Request Body
- **service** (string) - Optional - The name of the Ceph service to start. If not provided, all services may be started.

### Request Example
```json
{
  "service": "mon"
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the Ceph service has been started.

#### Response Example
```json
{
  "message": "Ceph service 'mon' started successfully."
}
```
```

--------------------------------

### Create Resume VM Client in Rust

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/status.rs.html

Returns a client for resuming a suspended QEMU VM. Requires the client to implement `crate::client::Client`.

```rust
impl<T> StatusClient<T>
where
    T: crate::client::Client,
{
    pub fn resume(&self) -> resume::ResumeClient<T> {
        resume::ResumeClient::<T>::new(self.client.clone(), &self.path)
    }
}
```

--------------------------------

### Fsfreeze Thaw Client Initialization

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/agent.rs.html

Initializes a client for the `fsfreeze-thaw` QEMU Guest Agent command. Requires a client implementation and the parent path.

```rust
pub fn fsfreeze_thaw(&self) -> fsfreeze_thaw::FsfreezeThawClient<T> {
        fsfreeze_thaw::FsfreezeThawClient::<T>::new(self.client.clone(), &self.path)
    }
```

--------------------------------

### Get Ceph Status

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/cluster/ceph/status.rs.html

Retrieves the Ceph cluster status. This method makes a GET request to the /status endpoint.

```rust
impl<T>
where
    T: crate::client::Client,
{
    #[doc = "Get ceph status."]
    pub fn get(&self) -> Result<GetOutput, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
}
```

--------------------------------

### Get Authentication Server Configuration

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/access/domains/realm.rs.html

Retrieves the configuration of an authentication server. This method sends a GET request to the server.

```rust
pub fn get(&self) -> Result<(), T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
```

--------------------------------

### POST /nodes/{node}/disks/initgpt

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/disks/initgpt/struct.InitgptClient.html

Initializes a disk with a GPT partition table.

```APIDOC
## POST /nodes/{node}/disks/initgpt

### Description
Initializes a disk with a GPT partition table.

### Method
POST

### Endpoint
/nodes/{node}/disks/initgpt

### Parameters
#### Request Body
- **params** (PostParams) - Required - The parameters required to initialize the disk with GPT.

### Response
#### Success Response (200)
- **result** (String) - Returns a string confirmation of the initialization process.
```

--------------------------------

### VM Get Output Items

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid.rs.html

Represents an item in the output of the VM get operation, typically indicating a subdirectory or resource.

```rust
pub struct GetOutputItems {
    pub subdir: String,
    #[serde(
        flatten,
        default,
        skip_serializing_if = "::std::collections::HashMap::is_empty"
    )]
    pub additional_properties: ::std::collections::HashMap<String, ::serde_json::Value>,
}
```

--------------------------------

### POST /nodes/{node}/qemu

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/qemu/struct.QemuClient.html

Creates or restores a virtual machine on the specified node.

```APIDOC
## POST /nodes/{node}/qemu

### Description
Creates a new virtual machine or restores an existing one from a backup.

### Method
POST

### Endpoint
/nodes/{node}/qemu

### Parameters
#### Request Body
- **params** (PostParams) - Required - Configuration parameters for creating or restoring the VM.

### Response
#### Success Response (200)
- **result** (String) - The result of the creation or restoration process.
```

--------------------------------

### Cloudinit Get Parameters

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/cloudinit/dump.rs.html

Defines the parameters for fetching cloud-init configurations. Use `GetParams::new` to create an instance, specifying the desired `Type`.

```rust
impl GetParams {
    pub fn new(ty: Type) -> Self {
        Self {
            ty,
            additional_properties: Default::default(),
        }
    }
}
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize)]
pub struct GetParams {
    #[serde(rename = "type")]
    #[doc = "Config type."]
    pub ty: Type,
    #[serde(
        flatten,
        default,
        skip_serializing_if = "::std::collections::HashMap::is_empty"
    )]
    pub additional_properties: ::std::collections::HashMap<String, ::serde_json::Value>,
}
```

--------------------------------

### Get SDN Directory Index

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/cluster/sdn.rs.html

Retrieves a list of SDN resources. This method corresponds to a GET request on the SDN endpoint.

```rust
impl<T>
where
    T: crate::client::Client,
{
    #[doc = "Directory index."]
    pub fn get(&self) -> Result<Vec<GetOutputItems>, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
}
```

--------------------------------

### POST /nodes/{node}/qemu

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu.rs.html

Creates a new QEMU virtual machine on the specified node.

```APIDOC
## POST /nodes/{node}/qemu

### Description
Creates a new QEMU virtual machine on the specified node. This can also be used to restore a VM from a snapshot.

### Method
POST

### Endpoint
/nodes/{node}/qemu

### Parameters
#### Query Parameters
- **params** (PostParams) - Required - Parameters for creating or restoring the VM.

### Request Example
```json
{
  "example": "{ \"name\": \"new-vm\", \"vmid\": 101, \"clone\": 100, \"memory\": 2048, \"cores\": 2 }"
}
```

### Response
#### Success Response (200)
- **vmid** (string) - The ID of the newly created or restored virtual machine.

#### Response Example
```json
{
  "example": "101"
}
```
```

--------------------------------

### PostParams for Startall

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/startall.rs.html

Parameters for the startall post request. Use 'force' to start even if 'onboot' is not set, or 'vms' to specify a list of VMIDs.

```rust
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize, Default)]
pub struct PostParams {
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Issue start command even if virtual guest have 'onboot' not set or set to off."]
    pub force: Option<()>,
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Only consider guests from this comma separated list of VMIDs."]
    pub vms: Option<String>,
    #[serde(
        flatten,
        default,
        skip_serializing_if = "::std::collections::HashMap::is_empty"
    )]
    pub additional_properties: ::std::collections::HashMap<String, ::serde_json::Value>,
}
```

--------------------------------

### Initialize AptClient

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/apt.rs.html

Creates a new instance of AptClient. Requires a client implementation and the parent path for the APT endpoint.

```rust
pub fn new(client: T, parent_path: &str) -> Self {
    Self {
        client,
        path: format!("{}{}", parent_path, "/apt"),
    }
}
```

--------------------------------

### Start Ceph Services

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/ceph/start/struct.StartClient.html

This endpoint allows for starting Ceph services. It requires a Client and a parent path, and accepts PostParams for configuration.

```APIDOC
## POST /nodes/{node}/ceph/start

### Description
Start ceph services.

### Method
POST

### Endpoint
/nodes/{node}/ceph/start

### Parameters
#### Path Parameters
- **node** (string) - Required - The node identifier.

#### Request Body
- **params** (PostParams) - Required - Parameters for starting Ceph services.

### Request Example
```json
{
  "params": {
    "param1": "value1",
    "param2": "value2"
  }
}
```

### Response
#### Success Response (200)
- **result** (string) - A confirmation message indicating the services have started.

#### Response Example
```json
{
  "result": "Ceph services started successfully."
}
```
```

--------------------------------

### OsdidClient Initialization

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/ceph/osd/osdid/struct.OsdidClient.html

Demonstrates how to create a new instance of the OsdidClient.

```APIDOC
## OsdidClient::new

### Description
Initializes a new OsdidClient.

### Method
`new`

### Parameters
- `client` (T): A generic client implementing the `Client` trait.
- `parent_path` (&str): The path to the parent resource.
- `osdid` (&str): The identifier for the OSD.

### Returns
- `Self`: An instance of `OsdidClient`.
```

--------------------------------

### LVM Get Output Structure

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/disks/lvm.rs.html

The output structure for the `get` operation, containing a list of LVM volume groups and a leaf indicator.

```rust
pub struct GetOutput {
    #[serde(skip_serializing_if = "::std::vec::Vec::is_empty", default)]
    pub children: Vec<ChildrenGetOutputChildrenItems>,
    #[serde(
        serialize_with = "::crate::types::serialize_bool",
        deserialize_with = "::crate::types::deserialize_bool"
    )]
    pub leaf: bool,
    #[serde(
        flatten,
        default,
        skip_serializing_if = "::std::collections::HashMap::is_empty"
    )]
    pub additional_properties: ::std::collections::HashMap<String, ::serde_json::Value>,
}
```

--------------------------------

### Get Ceph Rules

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/ceph/rules.rs.html

Retrieves a list of Ceph rules. Ensure the client implementation supports the GET method and error handling.

```rust
impl<T> RulesClient<T>
where
    T: crate::client::Client,
{
    #[doc = "List ceph rules."]
    pub fn get(&self) -> Result<Vec<GetOutputItems>, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
}
```

--------------------------------

### QEMU Module Overview

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/capabilities/qemu/index.html

Overview of the QEMU module structure and available client interfaces.

```APIDOC
## QEMU Module

### Description
The `proxmox_api::nodes::node::capabilities` module provides access to QEMU-specific configurations and capabilities for nodes.

### Modules
- **cpu**: Manages CPU-related configurations.
- **machines**: Manages machine-related configurations.

### Structs
- **GetOutputItems**: Represents the output structure for retrieval operations.
- **QemuClient**: The primary client interface for interacting with QEMU services.
```

--------------------------------

### Fsfreeze Status Client Initialization

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/agent.rs.html

Initializes a client for the `fsfreeze-status` QEMU Guest Agent command. Requires a client implementation and the parent path.

```rust
pub fn fsfreeze_status(&self) -> fsfreeze_status::FsfreezeStatusClient<T> {
        fsfreeze_status::FsfreezeStatusClient::<T>::new(self.client.clone(), &self.path)
    }
```

--------------------------------

### Get SMTP Endpoints

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/cluster/notifications/endpoints/smtp.rs.html

Retrieves a list of all configured SMTP notification endpoints. This method uses the `get` function of the underlying client.

```rust
impl<T> SmtpClient<T>
where
    T: crate::client::Client,
{
    #[doc = "Returns a list of all smtp endpoints"]
    pub fn get(&self) -> Result<Vec<GetOutputItems>, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
}
```

--------------------------------

### RealmClient Initialization

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/access/domains/realm/struct.RealmClient.html

Provides information on how to create a new instance of RealmClient.

```APIDOC
## RealmClient::new

### Description
Creates a new instance of `RealmClient`.

### Method
`new`

### Parameters
- **client** (T) - Required - An authenticated client implementing the `Client` trait.
- **parent_path** (str) - Required - The parent path for the realm.
- **realm** (str) - Required - The name of the realm.

### Request Example
```rust
let client = proxmox_api::client::Client::new(...);
let realm_client = proxmox_api::access::domains::realm::RealmClient::new(client, "/some/path", "my_realm");
```

### Response
- **Self** (RealmClient<T>) - A new `RealmClient` instance.
```

--------------------------------

### Get VM Firewall Options

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/lxc/vmid/firewall/options.rs.html

Retrieves the current firewall options for an LXC VM. This method sends a GET request to the Proxmox API.

```rust
#[doc = "Get VM firewall options."]
pub fn get(&self) -> Result<GetOutput, T::Error> {
    let path = self.path.to_string();
    self.client.get(&path, &())
}
```

--------------------------------

### GET /nodes/{node}/qemu/{vmid}/cloudinit/dump

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/qemu/vmid/cloudinit/dump/struct.GetParams.html

Retrieves the Cloud-Init configuration dump for a specific QEMU virtual machine.

```APIDOC
## GET /nodes/{node}/qemu/{vmid}/cloudinit/dump

### Description
Retrieves the Cloud-Init configuration dump for a specific QEMU virtual machine on a given node.

### Method
GET

### Endpoint
/nodes/{node}/qemu/{vmid}/cloudinit/dump

### Parameters
#### Path Parameters
- **node** (string) - Required - The name of the Proxmox node.
- **vmid** (integer) - Required - The ID of the QEMU virtual machine.

#### Request Body
- **ty** (Type) - Required - The configuration type.
- **additional_properties** (HashMap<String, Value>) - Optional - Additional configuration properties.
```

--------------------------------

### GET /nodes/{node}/qemu/{vmid}/cloudinit

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/cloudinit.rs.html

Retrieves the Cloud-Init configuration for a specific QEMU virtual machine, including both current and pending values.

```APIDOC
## GET /nodes/{node}/qemu/{vmid}/cloudinit

### Description
Get the cloudinit configuration with both current and pending values.

### Method
GET

### Endpoint
/nodes/{node}/qemu/{vmid}/cloudinit

### Response
#### Success Response (200)
- **delete** (u64) - Indicates a pending delete request if present and not 0.
- **key** (String) - Configuration option name.
- **pending** (String) - The new pending value.
- **value** (String) - Value as it was used to generate the current cloudinit image.
```

--------------------------------

### List Available Updates (GET)

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/apt/update.rs.html

Retrieves a list of available APT updates for the Proxmox node. Uses the GET method on the /update endpoint.

```rust
impl<T>
UpdateClient<T>
where
    T: crate::client::Client,
{
    #[doc = "List available updates."]
    pub fn get(&self) -> Result<Vec<GetOutputItems>, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
}
```

--------------------------------

### PostParams for Starting Ceph Services

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/ceph/start.rs.html

Defines the parameters for the POST request to start Ceph services. Supports an optional service name and any additional properties.

```rust
#[derive(Clone, Debug, :: serde :: Serialize, :: serde :: Deserialize, Default)]
pub struct PostParams {
    #[serde(skip_serializing_if = "Option::is_none", default)]
    #[doc = "Ceph service name."]
    pub service: Option<String>,
    #[serde(
        flatten,
        default,
        skip_serializing_if = "::std::collections::HashMap::is_empty"
    )]
    pub additional_properties: ::std::collections::HashMap<String, ::serde_json::Value>,
}
```

--------------------------------

### AgentClient Methods

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/qemu/vmid/agent/struct.AgentClient.html

This section covers the primary methods available on the AgentClient for interacting with the QEMU Guest Agent.

```APIDOC
## AgentClient

### Description
Provides an interface for interacting with the QEMU Guest Agent.

### Methods

- **new(client: T, parent_path: &str)**: Creates a new instance of AgentClient.
- **get() -> Result<Vec<GetOutputItems>, T::Error>**
  QEMU Guest Agent command index.
- **post(params: PostParams) -> Result<PostOutput, T::Error>**
  Execute QEMU Guest Agent commands.
- **fsfreeze_freeze() -> FsfreezeFreezeClient<T>**
- **fsfreeze_status() -> FsfreezeStatusClient<T>**
- **fsfreeze_thaw() -> FsfreezeThawClient<T>**
- **fstrim() -> FstrimClient<T>**
- **get_fsinfo() -> GetFsinfoClient<T>**
- **get_host_name() -> GetHostNameClient<T>**
- **get_memory_block_info() -> GetMemoryBlockInfoClient<T>**
- **get_memory_blocks() -> GetMemoryBlocksClient<T>**
- **get_osinfo() -> GetOsinfoClient<T>**
- **get_time() -> GetTimeClient<T>**
- **get_timezone() -> GetTimezoneClient<T>**
- **get_users() -> GetUsersClient<T>**
- **get_vcpus() -> GetVcpusClient<T>**
- **info() -> InfoClient<T>**
- **network_get_interfaces() -> NetworkGetInterfacesClient<T>**
- **ping() -> PingClient<T>**
- **shutdown() -> ShutdownClient<T>**
- **suspend_disk() -> SuspendDiskClient<T>**
- **suspend_hybrid() -> SuspendHybridClient<T>**
- **suspend_ram() -> SuspendRamClient<T>**
- **set_user_password() -> SetUserPasswordClient<T>**
- **exec() -> ExecClient<T>**
- **exec_status() -> ExecStatusClient<T>**
- **file_read() -> FileReadClient<T>**
- **file_write() -> FileWriteClient<T>**

### Type Parameters
- `T`: The type of the client, must implement the `Client` trait.
```

--------------------------------

### Get Role Configuration

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/access/roles/roleid.rs.html

Retrieves the configuration of a role using its ID. This method uses the `get` function of the underlying client and expects a `GetOutput` struct.

```rust
impl<T> RoleidClient<T>
where
    T: crate::client::Client,
{
    #[doc = "Get role configuration."]
    pub fn get(&self) -> Result<GetOutput, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
}
```

--------------------------------

### POST /nodes/{node}/services/{service}/start

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/services/service/start/struct.StartClient.html

Initiates a service on a specific Proxmox node.

```APIDOC
## POST /nodes/{node}/services/{service}/start

### Description
Starts a specified service on a Proxmox node.

### Method
POST

### Endpoint
/nodes/{node}/services/{service}/start

### Response
#### Success Response (200)
- **result** (String) - Returns a success message or status string.
```

--------------------------------

### POST /nodes/{node}/ceph/start

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/ceph/start/struct.PostParams.html

This endpoint is used to start a Ceph service on a Proxmox node. It accepts parameters to specify the service to start and any additional properties.

```APIDOC
## POST /nodes/{node}/ceph/start

### Description
Starts a Ceph service on a specified Proxmox node.

### Method
POST

### Endpoint
/nodes/{node}/ceph/start

### Parameters
#### Request Body
- **service** (Option<String>) - Optional - The name of the Ceph service to start.
- **additional_properties** (HashMap<String, Value>) - Optional - Additional properties for the request.

### Request Example
```json
{
  "service": "ceph.mon.0",
  "additional_properties": {
    "key": "value"
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the service has started.

#### Response Example
```json
{
  "message": "Ceph service ceph.mon.0 started successfully."
}
```
```

--------------------------------

### VersionClient Get Method

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/version.rs.html

Implements the `get` method for VersionClient, which retrieves API version details. Requires a client that implements the `crate::client::Client` trait.

```rust
impl<T> VersionClient<T>
where
    T: crate::client::Client,
{
    #[doc = "API version details, including some parts of the global datacenter config."]
    pub fn get(&self) -> Result<GetOutput, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
}
```

--------------------------------

### Create Reset VM Client in Rust

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/status.rs.html

Returns a client for resetting a QEMU VM. Requires the client to implement `crate::client::Client`.

```rust
impl<T> StatusClient<T>
where
    T: crate::client::Client,
{
    pub fn reset(&self) -> reset::ResetClient<T> {
        reset::ResetClient::<T>::new(self.client.clone(), &self.path)
    }
}
```

--------------------------------

### VncproxyClient::new

Source: https://docs.rs/proxmox-api/0.1.1/proxmox_api/nodes/node/lxc/vmid/vncproxy/struct.VncproxyClient.html

Initializes a new VncproxyClient instance.

```APIDOC
## VncproxyClient::new

### Description
Initializes a new VncproxyClient instance.

### Method
`new`

### Parameters
- `client` (T) - Required - The client to use for API requests.
- `parent_path` (&str) - Required - The parent path for the VNC proxy connection.
```

--------------------------------

### VNCWebSocketClient Get Method

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/qemu/vmid/vncwebsocket.rs.html

Implements the `get` method for the VNCWebSocketClient, which opens a WebSocket for VNC traffic. It requires `GetParams` and returns a `Result` with `GetOutput` or a client error.

```rust
impl<T> VncwebsocketClient<T>
where
    T: crate::client::Client,
{
    #[doc = "Opens a weksocket for VNC traffic."]
    pub fn get(&self, params: GetParams) -> Result<GetOutput, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &params)
    }
}
```

--------------------------------

### Initialize Storage Client

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/storage.rs.html

Creates a new `StorageClient` instance. Requires a client implementation and the parent path for the storage endpoint.

```rust
pub fn new(client: T, parent_path: &str) -> Self {
    Self {
        client,
        path: format!("{}{}", parent_path, "/storage"),
    }
}
```

--------------------------------

### Get LXC Snapshot Configuration

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/nodes/node/lxc/vmid/snapshot/snapname/config.rs.html

Retrieves the configuration of an LXC snapshot. This method uses the client's GET functionality with the snapshot's configuration path.

```rust
#[doc = "Get snapshot configuration"]
    pub fn get(&self) -> Result<GetOutput, T::Error> {
        let path = self.path.to_string();
        self.client.get(&path, &())
    }
```

--------------------------------

### Get ACME Account Information

Source: https://docs.rs/proxmox-api/0.1.1/src/proxmox_api/generated/cluster/acme/account/name.rs.html

Retrieves information about an existing ACME account. This method requires a client that implements the get operation and returns a GetOutput struct.

```rust
pub fn get(&self) -> Result<GetOutput, T::Error> {
    let path = self.path.to_string();
    self.client.get(&path, &())
}
```
Tokens:
Raw