### Container State Starting

Source: https://api.truenas.com/v25.10/_sources/api_methods_app.convert_to_custom.rst.txt

Example of a 'starting' state for a container.

```json
"starting"
```

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

### Example Cloud Backup Get Instance Query Parameters

Source: https://api.truenas.com/v25.10/_sources/api_methods_cloud_backup.get_instance.rst.txt

This example demonstrates how to specify query parameters for retrieving cloud backup instance data. It includes options for sorting and filtering.

```json
[
    "-devname",
    "nulls_first:-expiretime"
    
    ]
    
```

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

### VM Start

Source: https://api.truenas.com/v25.10/api_methods_support.new_ticket.html

Starts a stopped virtual machine, booting it up.

```APIDOC
## POST /vm/start

### Description
Starts a stopped virtual machine.

### Method
POST

### Endpoint
/vm/start

### Parameters
#### Request Body
- **id** (integer) - Required - The ID of the virtual machine to start.

### Request Example
```json
{
  "id": 6
}
```

### Response
#### Success Response (200)
- **status** (boolean) - Indicates if the start command was sent successfully.

#### Response Example
```json
{
  "status": true
}
```
```

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

### VM Start

Source: https://api.truenas.com/v25.10/api_methods_app.upgrade.html

Starts a virtual machine.

```APIDOC
## POST /vm/{id}/start

### Description
Starts a virtual machine identified by its ID.

### Method
POST

### Endpoint
/vm/{id}/start

### Parameters
#### Path Parameters
- **id** (int) - Required - The ID of the VM to start.
```

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

### Example Cronjob Get Instance Parameters

Source: https://api.truenas.com/v25.10/_sources/api_methods_cronjob.get_instance.rst.txt

Demonstrates how to specify parameters for the cronjob.get_instance method, including sorting and filtering options.

```json
[
    "-devname",
    "nulls_first:-expiretime"
    
]
```

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

### Example vm.get_instance Query Options

Source: https://api.truenas.com/v25.10/api_methods_vm.get_instance.html

Demonstrates how to use various query options like select, order_by, and limit when calling vm.get_instance. These options help in filtering and paginating the results.

```python
ixapi.vm.get_instance(id=1, options={
    "select": [
        "username",
        "Authentication.status"
    ],
    "order_by": [
        "size",
        "-devname",
        "nulls_first:-expiretime"
    ],
    "limit": 10,
    "offset": 0,
    "count": True
})
```

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

### Schedule Start Time Examples

Source: https://api.truenas.com/v25.10/_sources/api_events_replication.query.rst.txt

Defines the start time for the schedule's active window in HH:MM format. Examples show midnight, early morning, and evening start times.

```text
"00:00"
```

```text
"06:30"
```

```text
"18:00"
```

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

### vm.start

Source: https://api.truenas.com/v25.10/api_methods_app.available_space.html

Starts a virtual machine.

```APIDOC
## vm.start

### Description
Starts a virtual machine.

### Method
POST

### Endpoint
/api/v2.0/vm/{id}/start

### Parameters
#### Path Parameters
- **id** (integer) - Required - The ID of the virtual machine.
```

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

### Snapshot Task Schedule Start Time Example

Source: https://api.truenas.com/v25.10/_sources/api_events_pool.snapshottask.query.rst.txt

Example of a start time for a snapshot task schedule. This value represents the beginning of the window when snapshots can be taken.

```json
"23:00"
```

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

### Version Examples

Source: https://api.truenas.com/v25.10/_sources/api_methods_app.create.rst.txt

Examples of application versions to install. The default is 'latest'.

```text
"latest"
```

```text
"1.2.3"
```

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

### Train Examples

Source: https://api.truenas.com/v25.10/_sources/api_methods_app.create.rst.txt

Examples of catalog trains to install from. The default is 'stable'.

```text
"stable"
```

```text
"enterprise"
```

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

### Snapshot Task Schedule Start Times

Source: https://api.truenas.com/v25.10/_sources/api_methods_pool.snapshottask.create.rst.txt

Examples of valid time formats for the start of a snapshot task schedule.

```string
"06:30"
```

```string
"18:00"
```

```string
"23:00"
```

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

### ftp.enable

Source: https://api.truenas.com/v25.10/api_methods_ftp.config.html

Enables the FTP service to start on boot.

```APIDOC
## ftp.enable

### Description
Enables the FTP service to start automatically when the system boots.

### Method
POST

### Endpoint
/ftp/enable

### Parameters
None

### Response
#### Success Response (200)
An empty object `{}` is returned on successful enable.

#### Error Response (400)
- **error** (string) - Description of the error.
- **errno** (int) - Error number.

### Response Example
```json
{
  "error": "FTP service is already enabled.",
  "errno": 3141
}
```
```

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

### Snapshot Schedule Begin Time Example

Source: https://api.truenas.com/v25.10/_sources/api_events_pool.snapshottask.query.rst.txt

Defines the start time for the window when snapshots can be taken. Examples show different time formats.

```text
Begin
Type: string
Default: "00:00"
Start time of the window when snapshots can be taken.
Examples:
"00:00"
"06:30"
"18:00"
```

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

### Example NVMe-oF Host Query Options

Source: https://api.truenas.com/v25.10/api_methods_nvmet.host.get_instance.html

Demonstrates how to specify order_by, select, and count options for querying NVMe-oF host instances. The order_by parameter allows sorting results, while select specifies which fields to return. Count returns the total number of matching items.

```python
[
    "size",
    "-devname",
    "nulls_first:-expiretime"
]
```

```python
[
    "username",
    "Authentication.status"
]
```

```python
{
    "count": true
}
```

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

### update.run

Source: https://api.truenas.com/v25.10/api_methods_app.delete.html

Executes a pending system update. This method starts the installation of downloaded updates.

```APIDOC
## POST /update/run

### Description
Executes a pending system update.

### Method
POST

### Endpoint
/update/run
```

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

### vm.start

Source: https://api.truenas.com/v25.10/api_methods_initshutdownscript.html

Starts a stopped virtual machine. This powers on the VM and boots its operating system.

```APIDOC
## vm.start

### Description
Starts a stopped virtual machine.

### Method
POST

### Endpoint
/vm/{vm_id}/start

### Parameters
#### Path Parameters
- **vm_id** (integer) - Required - The ID of the virtual machine to start.

### Response
#### Success Response (200)
- **success** (boolean) - True if the VM start was initiated successfully.

### Response Example
{
  "success": true
}
```

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

### vm.start

Source: https://api.truenas.com/v25.10/api_methods_vm.html

Starts a stopped virtual machine.

```APIDOC
## vm.start

### Description
Starts a virtual machine that is currently in a stopped state.

### Method
POST

### Endpoint
/vm/start

### Parameters
#### Request Body
- **vm_id** (int) - Required - The ID of the virtual machine to start.

### Request Example
{
  "vm_id": 1
}

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the start operation was successful.

### Response Example
{
  "success": true
}
```

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

### Get Single NFSv4 Client

Source: https://api.truenas.com/v25.10/api_methods_nfs.get_nfs4_clients.html

This example shows how to retrieve a single NFSv4 client record that matches the specified filters. The `get` option is set to true to return the first matching record.

```python
api.get_nfs4_clients(options={"get": True})
```

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

### Directory Services Configuration Example 2

Source: https://api.truenas.com/v25.10/_sources/api_methods_directoryservices.config.rst.txt

This example demonstrates a directory services configuration specifying the base DN and server URLs.

```json
{
    "basedn": "dc=ipadom,dc=internal",
    "server_urls": [
        "ldap.ipadom.internal"
    ]
}
```

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

### Get Jobs

Source: https://api.truenas.com/v25.10/_sources/api_events_core.get_jobs.rst.txt

Retrieves information about jobs, including their state, start time, and any extra exception details.

```APIDOC
## GET /api/v2.0/events/core/jobs

### Description
Retrieves a list of jobs with their current status and execution details.

### Method
GET

### Endpoint
/api/v2.0/events/core/jobs

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Number of results to return.
- **offset** (integer) - Optional - Number of results to skip.
- **count** (boolean) - Optional - If true, return a total count of items that match the query.
- **exclude_auto_generated** (boolean) - Optional - If true, exclude auto-generated jobs.
- **jobstate** (string) - Optional - Filter jobs by their state (e.g., WAITING, RUNNING, SUCCESS, FAILED, ABORTED).

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the job.
- **uuid** (string) - Universally unique identifier for the job.
- **name** (string) - Name of the job.
- **description** (string) - Description of the job.
- **logs** (string) - Path to the job's log file.
- **state** (string) - Current execution state of the job. Examples: "WAITING", "RUNNING", "SUCCESS", "FAILED", "ABORTED".
- **time_started** (float) - Timestamp when the job started.
- **time_finished** (float) - Timestamp when the job finished.
- **user** (string) - Username of the user who initiated the job.
- **created** (string) - Timestamp when the job was created.
- **modified** (string) - Timestamp when the job was last modified.
- **exc_info** (object) - Additional exception information if the job failed. May contain `errno` (integer) and `extra` (object) fields.
  - **errno** (integer) - Error number associated with the exception.
  - **extra** (object) - Additional exception details.
    - **extra** (object) - Nested object for further exception details.

#### Response Example
{
  "example": "{\"id\": 1, \"uuid\": \"a1b2c3d4-e5f6-7890-1234-567890abcdef\", \"name\": \"Example Job\", \"description\": \"This is an example job.\", \"logs\": \"/var/log/jobs/example.log\", \"state\": \"SUCCESS\", \"time_started\": 1678886400.0, \"time_finished\": 1678886460.0, \"user\": \"admin\", \"created\": \"2023-03-15T10:00:00Z\", \"modified\": \"2023-03-15T10:01:00Z\", \"exc_info\": null}"
}

ERROR HANDLING:
- **400 Bad Request**: Invalid input parameters.
- **403 Forbidden**: Insufficient permissions.
- **404 Not Found**: The requested resource was not found.
- **500 Internal Server Error**: An unexpected error occurred on the server.
```

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

### system.ready

Source: https://api.truenas.com/v25.10/api_methods_system.ready.html

Returns whether the system completed boot and is ready to use. This is a boolean value indicating the system's readiness.

```APIDOC
## system.ready

### Description
Returns whether the system completed boot and is ready to use.

### Method
N/A (This is a method call, not an HTTP endpoint)

### Endpoint
N/A

### Parameters
#### Call parameters
Type: array
No Additional Items

### Return value
#### Result
Type: boolean

Whether the system has completed startup and is ready for use.

_Required roles:_ SYSTEM_GENERAL_READ
```

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

### LDAP Server URLs Example

Source: https://api.truenas.com/v25.10/_sources/api_methods_directoryservices.update.rst.txt

Provides an example of a list of LDAP server URIs for LDAP binds. Each URI must start with 'ldap://' or 'ldaps://' and can use a DNS name or IP address.

```python
['ldaps://myldap.domain.internal']
```

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

### vm.start

Source: https://api.truenas.com/v25.10/api_methods_vm.status.html

Starts a virtual machine. This method is used to initiate the operation of a specified virtual machine.

```APIDOC
## vm.start

### Description
Starts a virtual machine.

### Method
POST

### Endpoint
/vm/start

### Parameters
#### Query Parameters
- **id** (int) - Required - The ID of the virtual machine to start.

### Response
#### Success Response (200)
- **id** (int) - The ID of the virtual machine that was started.

#### Response Example
{
  "id": 1
}
```

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

### Example Cloud Backup Get Instance Select Fields

Source: https://api.truenas.com/v25.10/_sources/api_methods_cloud_backup.get_instance.rst.txt

This example shows how to use the 'select' parameter to specify which fields to include in the response when retrieving cloud backup instance data. You can select top-level fields or nested fields.

```json
[
    "username",
    "Authentication.status"
    
    ]
    
```

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

### Directory Services Configuration Example 1

Source: https://api.truenas.com/v25.10/_sources/api_methods_directoryservices.config.rst.txt

This example shows a typical configuration for directory services, including base DN, domain, hostname, and target server.

```json
{
    "basedn": "dc=ipadom,dc=internal",
    "domain": "ipadom.internal",
    "hostname": "TRUENASZ345",
    "target_server": "ipasrv5.ipadom.internal"
}
```

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

### VM Status Example: STOPPED

Source: https://api.truenas.com/v25.10/api_methods_vm.create.html

Indicates that the virtual machine is currently stopped or powered off. This state is typical after a shutdown or before a start.

```text
"STOPPED"
```

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

### autostart

Source: https://api.truenas.com/v25.10/_sources/api_events_vm.query.rst.txt

Determines whether the virtual machine should automatically start when the host system boots up. This is useful for ensuring critical services are always available.

```APIDOC
## autostart

### Description
Whether to automatically start the VM when the host system boots.

### Type
boolean

### Default
true
```

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

### boot.environment.create

Source: https://api.truenas.com/v25.10/api_methods_boot.environment.keep.html

Creates a new boot environment.

```APIDOC
## boot.environment.create

### Description
Creates a new boot environment.

### Method
POST

### Endpoint
/boot/environment/create

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new boot environment.
- **source** (string) - Optional - The name of the boot environment to clone from. If not provided, a new environment will be created from the current active one.

### Request Example
{
  "example": "{\"name\": \"new_env\", \"source\": \"current_env\"}"
}

### Response
#### Success Response (200)
- **id** (string) - The ID of the newly created boot environment.
- **name** (string) - The name of the newly created boot environment.

#### Response Example
{
  "example": "{\"id\": \"123e4567-e89b-12d3-a456-426614174000\", \"name\": \"new_env\"}"
}
```

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

### Get Device Info

Source: https://api.truenas.com/v25.10/_sources/api_methods_device.get_info.rst.txt

Retrieves general information about serial devices, including driver name, start address, size, and a description.

```APIDOC
## GET /device/info

### Description
Retrieves general information about serial devices.

### Method
GET

### Endpoint
/device/info

### Parameters
#### Query Parameters
- **type** (string) - Optional - Type of device to query (e.g., "serial").

### Response
#### Success Response (200)
- **drivername** (string) - Required - Name of the kernel driver handling this serial device.
- **start** (string) - Required - Starting address or identifier for the serial device.
- **size** (integer) - Required - Size or capacity information for the serial device.
- **description** (string) - Required - Human-readable description of the serial device.

#### Response Example
{
  "drivername": "uart",
  "start": "0x1000",
  "size": 1024,
  "description": "Primary UART Controller"
}
```

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

### Example Select Fields for Cronjob Get Instance

Source: https://api.truenas.com/v25.10/_sources/api_methods_cronjob.get_instance.rst.txt

Shows how to use the 'select' parameter to specify which fields to retrieve in the cronjob.get_instance query.

```json
[
    "username",
    "Authentication.status"
    
]
```

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

### Order By Example for VMware Instances

Source: https://api.truenas.com/v25.10/_sources/api_methods_vmware.get_instance.rst.txt

Demonstrates how to specify sorting criteria for VMware instance queries. Results can be ordered by fields like 'size' or 'name', with options for reverse sorting.

```json
[
    "size",
    "-name"
]
```

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

### Get CloudSync Credentials Instance

Source: https://api.truenas.com/v25.10/api_methods_cloudsync.credentials.get_instance.html

Retrieves information about a specific CloudSync credentials instance. This is useful for inspecting the configuration and status of a CloudSync setup.

```APIDOC
## GET /cloudsync/credentials/{id}

### Description
Retrieves details of a specific CloudSync credentials instance.

### Method
GET

### Endpoint
/cloudsync/credentials/{id}

### Parameters
#### Path Parameters
- **id** (int) - Required - The unique identifier of the CloudSync credentials instance.

### Response
#### Success Response (200)
- **id** (int) - The unique identifier of the CloudSync credentials instance.
- **provider** (str) - The cloud provider (e.g., "AWS", "Google", "Azure").
- **attributes** (dict) - A dictionary containing provider-specific attributes and credentials.

#### Response Example
{
  "id": 1,
  "provider": "AWS",
  "attributes": {
    "access_key_id": "AKIA...",
    "secret_access_key": "..."
  }
}
```

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

### vm.device.create

Source: https://api.truenas.com/v25.10/_sources/api_methods_vm.device.create.rst.txt

Creates and starts a virtual machine device with specified configuration.

```APIDOC
## POST /vm/device/create

### Description
Creates and starts a virtual machine device with specified configuration. This method allows for detailed customization of the VM's network binding, display server settings, and authentication.

### Method
POST

### Endpoint
/vm/device/create

### Parameters
#### Request Body
- **bind** (string) - Optional - IP address to bind the display server to. Defaults to "127.0.0.1". Must be at least 1 character long.
- **wait** (boolean) - Optional - Whether to wait for a client connection before starting the VM. Defaults to false.
- **password** (string) - Optional - Password for display server authentication. Defaults to null.

### Request Example
{
  "bind": "192.168.1.100",
  "wait": true,
  "password": "mysecretpassword"
}

### Response
#### Success Response (200)
- **web_port** (integer) - The port number for the web interface.

#### Response Example
{
  "web_port": 8080
}
```

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

### app.start

Source: https://api.truenas.com/v25.10/api_events_docker.html

Starts an application.

```APIDOC
## app.start

### Description
Starts an application.

### Method
POST

### Endpoint
/api/v2.0/app/start

### Parameters
#### Request Body
- **id** (str) - Required - The ID of the application to start.
```

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

### Count NFSv4 Clients

Source: https://api.truenas.com/v25.10/api_methods_nfs.get_nfs4_clients.html

This example demonstrates how to get the total count of NFSv4 clients matching the specified filters. The `count` option is set to true to return only the count.

```python
api.get_nfs4_clients(options={"count": True})
```

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

### app.start

Source: https://api.truenas.com/v25.10/api_methods_vm.start.html

Starts a virtual machine application. This method is used to initiate the operation of a previously configured VM.

```APIDOC
## app.start

### Description
Starts a virtual machine application. This method is used to initiate the operation of a previously configured VM.

### Method
POST

### Endpoint
/app/start

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **id** (int) - Required - The ID of the application to start.

### Request Example
{
  "id": 123
}

### Response
#### Success Response (200)
- **result** (bool) - Indicates if the operation was successful.
- **error** (string) - Contains error details if the operation failed.

#### Response Example
{
  "result": true,
  "error": null
}
```

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

### Get NFSv4 Clients with OR Logic Filters

Source: https://api.truenas.com/v25.10/api_methods_nfs.get_nfs4_clients.html

This example shows how to apply an OR condition to filter NFSv4 clients by name. Multiple filter conditions can be combined using logical operators.

```python
api.get_nfs4_clients(filters=["OR", [["name", "=", "bob"]], [["name", "=", "larry"]]])
```

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

### Get NFSv4 Clients with Filters

Source: https://api.truenas.com/v25.10/api_methods_nfs.get_nfs4_clients.html

This example demonstrates how to filter NFSv4 clients by name using a simple equality filter. The `filters` parameter accepts a list of filter conditions.

```python
api.get_nfs4_clients(filters=[["name", "=", "bob"]])
```

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

### vm.start

Source: https://api.truenas.com/v25.10/_sources/api_methods_vm.start.rst.txt

Starts a Virtual Machine. It can optionally allow memory overcommitment if set to true.

```APIDOC
## vm.start

### Description
Starts a Virtual Machine. This operation can be configured to allow memory overcommitment.

### Method
(Not specified, likely a method call in an SDK or RPC)

### Parameters
#### Path Parameters
(None specified)

#### Query Parameters
(None specified)

#### Request Body
(Not specified, parameters are likely passed directly to a method)

### Parameters
#### Call parameters
- **id** (integer) - Required - ID of the virtual machine to start.
- **options** (object) - Optional - Options controlling the VM start process. Defaults to `{"overcommit": false}`.
  - **overcommit** (boolean) - Optional - Whether to allow memory overcommitment when starting the VM. Defaults to `false`.

### Request Example
(No explicit request example provided in source)

### Response
#### Success Response
- **Result** (null) - Returns `null` on successful VM start initiation.

#### Response Example
(No explicit response example provided in source)

### Error Codes
- **ENOMEM(12)**: Not enough free memory to run the VM without overcommit.
```

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

### Get Specific Fields of NFSv4 Clients

Source: https://api.truenas.com/v25.10/api_methods_nfs.get_nfs4_clients.html

This example shows how to select only specific fields (e.g., 'username' and 'Authentication.status') from the NFSv4 clients query results. The `select` option is used for this purpose.

```python
api.get_nfs4_clients(options={"select": ["username", "Authentication.status"]})
```

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

### boot.attach

Source: https://api.truenas.com/v25.10/api_events_docker.html

Attaches a boot environment.

```APIDOC
## boot.attach

### Description
Attaches a boot environment.

### Method
POST

### Endpoint
/api/v2.0/boot/attach

### Parameters
#### Request Body
- **environment** (str) - Required - The name of the boot environment to attach.
```

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

### Example Select Fields

Source: https://api.truenas.com/v25.10/_sources/api_methods_acme.dns.authenticator.get_instance.rst.txt

Demonstrates how to specify fields to include in the query return. Supports dot notation for subkeys.

```json
[
    "username",
    "Authentication.status"
]
```

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

### Get NFSv4 Clients with Ordering

Source: https://api.truenas.com/v25.10/api_methods_nfs.get_nfs4_clients.html

This example demonstrates how to sort the results of NFSv4 clients by a specific field in descending order. The `order_by` option allows specifying sort fields and direction.

```python
api.get_nfs4_clients(options={"order_by": ["-devname"]})
```

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

### Example SMB Audit Configuration

Source: https://api.truenas.com/v25.10/api_events_sharing.smb.query.html

Shows how to configure SMB share auditing, including enabling it and specifying watch/ignore lists for group accounts.

```json
{
    "enable": true,
    "ignore_list": [],
    "watch_list": [
        "interns"
    ]
}
```

```json
{
    "enable": true,
    "ignore_list": [
        "automation"
    ],
    "watch_list": []
}
```

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

### SMB Share Path Examples

Source: https://api.truenas.com/v25.10/api_methods_sharing.smb.get_instance.html

Illustrates valid configurations for the SMB share path. The path must start with /mnt/ and be within a ZFS pool, or be the string 'EXTERNAL' for DFS proxy shares.

```text
"/mnt/dozer/SHARE"
```

```text
"EXTERNAL"
```

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

### VM Creation Parameters

Source: https://api.truenas.com/v25.10/_sources/api_methods_vm.create.rst.txt

This section details the parameters that can be configured when creating a virtual machine. These include settings for autostart behavior, display device provisioning, and time synchronization.

```APIDOC
## VM Creation Parameters

### Description
This details the parameters available for VM creation.

### Parameters
#### Request Body
- **autostart** (boolean) - Optional - Whether to automatically start the VM when the host system boots. Default: true
- **hide_from_msr** (boolean) - Optional - Whether to hide hypervisor signatures from guest OS MSR access. Default: false
- **ensure_display_device** (boolean) - Optional - Whether to ensure at least one display device is configured for the VM. Default: true
- **time** (enum) - Optional - Guest OS time zone reference. `LOCAL` uses host timezone, `UTC` uses coordinated universal time. Must be one of: "LOCAL", "UTC". Default: "LOCAL"
- **shutdown_timeout** (integer) - Optional - Timeout in seconds for VM shutdown.
```

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

### Get Scan Object Example

Source: https://api.truenas.com/v25.10/_sources/api_methods_boot.get_state.rst.txt

This JSON object represents the structure of scan information when an operation is active. It includes details like bytes processed, errors, and progress percentage. It is used when the 'scan' property is not null.

```json
{
    "bytes_issued": null,
    "bytes_processed": null,
    "bytes_to_process": null,
    "end_time": null,
    "errors": null,
    "function": null,
    "pause": null,
    "percentage": null,
    "start_time": null,
    "state": null,
    "total_secs_left": null
}
```

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

### system.ready

Source: https://api.truenas.com/v25.10/_sources/api_methods_system.ready.rst.txt

Returns whether the system completed boot and is ready to use. This method requires the SYSTEM_GENERAL_READ role.

```APIDOC
## system.ready

### Description
Returns whether the system completed boot and is is ready to use.

### Method
N/A (This is an RPC-style method, not HTTP)

### Endpoint
N/A

### Parameters
#### Call parameters
This method does not accept any call parameters.

### Return value
#### Result (boolean)
- **Result** (boolean) - Whether the system has completed startup and is ready for use.

### Response Example
```json
{
  "result": true
}
```

### Required roles
SYSTEM_GENERAL_READ
```

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

### Get GPU Information

Source: https://api.truenas.com/v25.10/_sources/api_methods_device.get_info.rst.txt

This method retrieves detailed information about the GPUs installed in the system. It returns an array of GPU objects, each containing details about its PCI slot, a human-readable description, and an array of associated PCI devices.

```APIDOC
## GET /gpu

### Description
Retrieves detailed information about the GPUs installed in the system. This includes PCI slot numbers, human-readable descriptions, and associated PCI devices for each GPU.

### Method
GET

### Endpoint
/gpu

### Parameters
None

### Request Body
None

### Response
#### Success Response (200)
- **slot** (string) - Required - PCI slot number.
- **description** (string) - Required - Human-readable description of the GPU.
- **devices** (array of object) - Required - Array of PCI devices associated with this GPU.
  - Each item in the `devices` array is an object with the following properties:
    - **pci_id** (string) - Required - PCI device identifier.
    - **pci_slot** (string) - Required - PCI slot number for the device.

#### Response Example
```json
{
  "slot": "0000:01:00.0",
  "description": "NVIDIA GeForce RTX 3090",
  "devices": [
    {
      "pci_id": "10DE:2204",
      "pci_slot": "0000:01:00.0"
    }
  ]
}
```
```

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

### Snapshot Task Get Instance Parameters

Source: https://api.truenas.com/v25.10/_sources/api_methods_pool.snapshottask.get_instance.rst.txt

This section details the parameters used to retrieve a specific snapshot task instance. It includes the day of the week, start and end times for the snapshot window, and a required unique identifier.

```APIDOC
## Snapshot Task Get Instance Parameters

### Description
This section details the parameters used to retrieve a specific snapshot task instance. It includes the day of the week, start and end times for the snapshot window, and a unique identifier.

### Parameters
#### Query Parameters
- **dow** (string) - Optional - Day of the week, "1" (Monday) - "7" (Sunday). Defaults to "*".
- **begin** (string) - Optional - Start time of the window when snapshots can be taken. Defaults to "00:00". Examples: "00:00", "06:30", "18:00", "23:00".
- **end** (string) - Optional - End time of the window when snapshots can be taken. Defaults to "23:59". Examples: "00:00", "06:30", "18:00", "23:00".
- **id** (string) - Required - Unique identifier for the snapshot task instance.
```