Question: Apply Custom Image to RT Target

[GusMarzo]

I would like to apply a custom image to an RT target (sbRIO-9609) using the nisyscfg-python API, but I don't see a "Set System Image" method available. I did come across the format() method, but it does not seem to allow specifying a custom image.

Is there a way to apply a custom image to a remote RT target using nisyscfg-python?

[tkrebes]

The functionality is not exposed by the nisyscfg.system.Session at the moment. Access to NISysCfgSetSystemImageFromFolder2 is available via nisyscfg._library.Library. So if you want to use the API, you can extent the Session class in your code. For example,

# untested code
import nisyscfg
from nisyscfg._lib import c_string_encode

class SystemImageSession(nisyscfg.Session):
    def set_system_image_from_folder(
        self,
        folder_path: str,
        auto_restart: bool = True,
        original_system_only: bool = False,
        network_settings: nisyscfg.enums.NetworkInterfaceSettings = nisyscfg.enums.NetworkInterfaceSettings.RESET_PRIMARY_RESET_OTHERS,
    ) -> None:
        error_code = self._library.SetSystemImageFromFolder2(
            self._session,
            nisyscfg.enums.Bool(auto_restart),
            c_string_encode(folder_path),
            None,  # encryptionPassphrase (not implemented)
            0,  # numBlacklistEntries (not implemented)
            None,  # blacklistFilesDirectories (not implemented)
            nisyscfg.enums.Bool(original_system_only),
            network_settings,
        )
        nisyscfg.errors.handle_error(self, error_code)

Also, if you go down this route, feel free to contribute back to this project. Contributions are welcome.

[GusMarzo]

Your suggestion worked great; thank you. I added the unzip function to the class to use the *.lvappimg file.

import nisyscfg
from nisyscfg._lib import c_string_encode
import os
import zipfile

class SystemImageSession(nisyscfg.Session):
def _set_system_image(self, folder_path: str, auto_restart: bool, original_system_only: bool, network_settings) -> None:
error_code = self._library.SetSystemImageFromFolder2(
self._session,
nisyscfg.enums.Bool(auto_restart),
c_string_encode(folder_path),
None, # encryptionPassphrase (not implemented)
0, # numBlacklistEntries (not implemented)
None, # blacklistFilesDirectories (not implemented)
nisyscfg.enums.Bool(original_system_only),
network_settings,
)
nisyscfg.errors.handle_error(self, error_code)

def set_system_image_from_folder(
    self,
    folder_path: str,
    auto_restart: bool = True,
    original_system_only: bool = False,
    network_settings: nisyscfg.enums.NetworkInterfaceSettings = nisyscfg.enums.NetworkInterfaceSettings.PRESERVE_PRIMARY_PRESERVE_OTHERS,
) -> None:
    self._set_system_image(folder_path, auto_restart, original_system_only, network_settings)

def set_system_image_from_file(
    self,
    file_path: str,
    auto_restart: bool = True,
    original_system_only: bool = False,
    network_settings: nisyscfg.enums.NetworkInterfaceSettings = nisyscfg.enums.NetworkInterfaceSettings.PRESERVE_PRIMARY_PRESERVE_OTHERS,
) -> None:
    if not os.path.isfile(file_path):
        raise FileNotFoundError(f"The file {file_path} does not exist.")
    
    temp_folder = os.path.join(os.path.dirname(file_path), "temp")
    os.makedirs(temp_folder, exist_ok=True)

    try:
        with zipfile.ZipFile(file_path, 'r') as zip_ref:
            zip_ref.extractall(temp_folder)

        self._set_system_image(temp_folder, auto_restart, original_system_only, network_settings)
    finally:
        # Clean up the temp folder safely
        for root, dirs, files in os.walk(temp_folder, topdown=False):
            for name in files:
                os.remove(os.path.join(root, name))
            for name in dirs:
                os.rmdir(os.path.join(root, name))
        os.rmdir(temp_folder)

[tkrebes]

Thanks for the feedback. I staged changes to the API in #62. If the changes work for you, I can go through the process of getting it reviewed, merged and uploaded to pypi.

[GusMarzo]

I think this looks good to me. I will incorporate the changes and test it on my system. Thank you

…

On Mon, Mar 31, 2025 at 2:53 PM Tyler Krehbiel ***@***.***> wrote: Thanks for the feedback. I staged changes to the API in #62 <#62>. If the changes work for you, I can go through the process of getting it reviewed, merged and uploaded to pypi. — Reply to this email directly, view it on GitHub <#61 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAVKYF2FTGSH424TAXFBGPD2XGFI7AVCNFSM6AAAAABZNTZNAGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDONRXGEYTSMRUGA> . You are receiving this because you authored the thread.Message ID: ***@***.***> [image: tkrebes]*tkrebes* left a comment (tkrebes/nisyscfg-python#61) <#61 (comment)> Thanks for the feedback. I staged changes to the API in #62 <#62>. If the changes work for you, I can go through the process of getting it reviewed, merged and uploaded to pypi. — Reply to this email directly, view it on GitHub <#61 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAVKYF2FTGSH424TAXFBGPD2XGFI7AVCNFSM6AAAAABZNTZNAGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDONRXGEYTSMRUGA> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[GusMarzo]

I tested the changes on an sbRIO, and everything worked as expected. Thanks again!

[tkrebes]

The set_system_image function is now available in the nisyscfg 0.2.0 release.