https://github.com/virtomize/uii-python-api

About This repository contains an implementation of a client for the Virtomize Unattended Install Images API for Python
https://github.com/virtomize/uii-python-api

Last synced: 6 months ago
JSON representation

About This repository contains an implementation of a client for the Virtomize Unattended Install Images API for Python

• Host: GitHub
• URL: https://github.com/virtomize/uii-python-api
• Owner: Virtomize
• License: mit
• Created: 2022-06-26T19:34:07.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-08-01T17:18:14.000Z (over 3 years ago)
• Last Synced: 2025-05-13T19:15:12.256Z (7 months ago)
• Language: Python
• Homepage:
• Size: 38.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: license
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VBXHBYFU44T5W&source=url)

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/virtomize/uii-python-api/blob/master/LICENSE)

[![Website](https://img.shields.io/badge/%40-Virtomize-%231e828c)](https://virtomize.com)

[![Twitter](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/virtomize)

[![LinkedIn](https://img.shields.io/badge/linkedIn-%20-blue.svg?style=social&logo=linkedin)](https://www.linkedin.com/company/virtomize/)

# UII Python API

This repository contains an implementation of a client for the [**Virtomize Unattended Install Images API**](https://uii.virtomize.com/).

## Build an ISO

Building an ISO requires two steps.

1. Create a client. 

This requires the API token created in the UI (see below). 

    ```python

    import uiipythonapi as uii

    api = uii.Client("token here")

    ```

2. Building the ISO by using `build` on the client object. 

    ```python

    err = api.build("debian10.iso", "debian", "10", "x86_64", "hostnamehere", [{

            "dhcp": True,        

            "nointernet": False,

    }])

    ```

   

   `build` requires the following parameters: 

   - A path to the output file

   - The name of the distribution

   - The version number of the distribution

   - The architecture of the distribution (`x86_64` in most cases)

   - A configuration of the network interfaces

      

## Register an API token

Before using this client library, you need to register an API token under your account.

For this, login into the [website](https://uii.virtomize.com/) and go to the "API-Token" tab.

![API-Token tab](https://github.com/Virtomize/uii-go-api/blob/master/doc/api-token.png "API-Token tab")

There, create a new API token by clicking "Create" and give it a name. Then click save.

![Create a token](https://github.com/Virtomize/uii-go-api/blob/master/doc/api-token-create.png "Create a token")

A new token will be created.

Copy this token, as it will be hidden, once you log out.

There, create a new API token by clicking "Create" and give it a name. Then click save.

![Save token](https://github.com/Virtomize/uii-go-api/blob/master/doc/api-token-created.png "Save token")