tn_connect.update

Update TrueNAS Connect configuration.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: tn_connect_update

tn_connect_update

Type: object

TrueNASConnectUpdateArgs parameters.

No Additional Properties

enabled

Enabled

Type: boolean

Whether to enable the TrueNAS Connect service.

ips

Ips

Type: array of string

Array of IP addresses that TrueNAS Connect should bind to and advertise.

No Additional Items

Each item of this array must be:

Type: stringFormat: ipvanyaddress

interfaces

Interfaces

Type: array of string

Array of network interface names that TrueNAS Connect should use.

No Additional Items

Each item of this array must be:

Type: string

use_all_interfaces

Use All Interfaces

Type: boolean

Whether to automatically use all available network interfaces.

Return value

TNCEntry

Type: object

The updated TrueNAS Connect configuration.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the TrueNAS Connect configuration.

enabled Required

Enabled

Type: boolean

Whether TrueNAS Connect service is enabled.

registration_details Required

Registration Details

Type: object

Object containing registration information and credentials for TrueNAS Connect.

ips Required

Ips

Type: array of string

Array of IP addresses that TrueNAS Connect will bind to and advertise.

No Additional Items

Each item of this array must be:

Type: string

Must be at least 1 characters long

interfaces Required

Interfaces

Type: array of string

Array of network interface names that TrueNAS Connect will use.

No Additional Items

Each item of this array must be:

Type: string

interfaces_ips Required

Interfaces Ips

Type: array of string

Array of IP addresses associated with the selected interfaces.

No Additional Items

Each item of this array must be:

Type: string

use_all_interfaces Required

Use All Interfaces

Type: boolean

Whether to automatically use all available network interfaces.

status Required

Status

Type: string

Current operational status of the TrueNAS Connect service.

Must be at least 1 characters long

status_reason Required

Status Reason

Type: string

Detailed explanation of the current status, including any error conditions.

Must be at least 1 characters long

certificate Required

Certificate

ID of the SSL certificate used for TrueNAS Connect communications. null if using default.

Any of

• Option 1
• Option 2

Type: integer

Type: null

account_service_base_url Required

Account Service Base Url

Type: stringFormat: uri

Base URL for the TrueNAS Connect account service API.

Must be at least 1 characters long

Must be at most 2083 characters long

leca_service_base_url Required

Leca Service Base Url

Type: stringFormat: uri

Base URL for the Let's Encrypt Certificate Authority service used by TrueNAS Connect.

Must be at least 1 characters long

Must be at most 2083 characters long

tnc_base_url Required

Tnc Base Url

Type: stringFormat: uri

Base URL for the TrueNAS Connect service.

Must be at least 1 characters long

Must be at most 2083 characters long

heartbeat_url Required

Heartbeat Url

Type: stringFormat: uri

URL endpoint for sending heartbeat signals to maintain connection status.

Must be at least 1 characters long

Must be at most 2083 characters long

Required roles: TRUENAS_CONNECT_WRITE