TrueNAS API Clients

awalkerix · October 7, 2024, 3:38pm

You can look at some of our existing python scripts as a template for how to use the python client:

truenas/middleware/blob/master/src/middlewared/middlewared/scripts/sedhelper.py

#!/usr/bin/env python
import argparse
from concurrent.futures import ThreadPoolExecutor
import errno

from truenas_api_client import Client, ClientException

# A particular Kioxia PM6 drive has shown us that it takes longer than
# 60 seconds to unlock/setup SED. Specifically, the "sedutil-cli --initialSetup"
# command took ~135 seconds to complete. Note the other PM6 drives took < 30 secs.
# (60 secs is default websocket timeout so bump this to 300 secs (5mins) to be safe)
TIMEOUT = 300


def setup(password, disk=None):

    def sed_setup(client, disk_name, password):
        rv = client.call('disk.sed_initial_setup', disk_name, password)
        if rv == 'SUCCESS':
            print(f'{disk_name}\t\t[\033[92mOK\x1B[0m]')

This file has been truncated. show original

One of key things to realize with the python client is:

from truenas_api_client import Client

with Client() as c:
   data = c.call(<method>, <args>)

Make use of context manager. When the block indented under with Client() as c exits then resources are freed and socket is closed.