ISOsClient

class IsosClient(client: Client)[source]
get_all(name: str | None = None, architecture: list[str] | None = None, include_wildcard_architecture: bool | None = None, include_architecture_wildcard: bool | None = None) list[BoundIso][source]

Get all ISOs

Parameters:
  • name – str (optional) Can be used to filter ISOs by their name.

  • architecture – List[str] (optional) Can be used to filter ISOs by their architecture. Choices: x86 arm

  • include_wildcard_architecture – bool (optional) Deprecated, please use include_architecture_wildcard instead.

  • include_architecture_wildcard – bool (optional) Custom ISOs do not have an architecture set. You must also set this flag to True if you are filtering by architecture and also want custom ISOs.

Returns:

List[BoundIso]

get_by_id(id: int) BoundIso[source]

Get a specific ISO by its id

Parameters:

id – int

Returns:

BoundIso

get_by_name(name: str) BoundIso | None[source]

Get iso by name

Parameters:

name – str Used to get iso by name.

Returns:

BoundIso

get_list(name: str | None = None, architecture: list[str] | None = None, include_wildcard_architecture: bool | None = None, include_architecture_wildcard: bool | None = None, page: int | None = None, per_page: int | None = None) IsosPageResult[source]

Get a list of ISOs

Parameters:
  • name – str (optional) Can be used to filter ISOs by their name.

  • architecture – List[str] (optional) Can be used to filter ISOs by their architecture. Choices: x86 arm

  • include_wildcard_architecture – bool (optional) Deprecated, please use include_architecture_wildcard instead.

  • include_architecture_wildcard – bool (optional) Custom ISOs do not have an architecture set. You must also set this flag to True if you are filtering by architecture and also want custom ISOs.

  • page – int (optional) Specifies the page to fetch

  • per_page – int (optional) Specifies how many results are returned by page

Returns:

(List[BoundIso], Meta)

class BoundIso(client: ClientEntityBase, data: dict, complete: bool = True)[source]
model

alias of Iso

class Iso(id: int | None = None, name: str | None = None, type: str | None = None, architecture: str | None = None, description: str | None = None, deprecated: str | None = None, deprecation: dict | None = None)[source]

Iso Domain

Parameters:
  • id – int ID of the ISO

  • name – str, None Unique identifier of the ISO. Only set for public ISOs

  • description – str Description of the ISO

  • type – str Type of the ISO. Choices: public, private

  • architecture – str, None CPU Architecture that the ISO is compatible with. None means that the compatibility is unknown. Choices: x86, arm

  • deprecated – datetime, None ISO 8601 timestamp of deprecation, None if ISO is still available. After the deprecation time it will no longer be possible to attach the ISO to servers. This field is deprecated. Use deprecation instead.

  • deprecationDeprecationInfo, None Describes if, when & how the resources was deprecated. If this field is set to None the resource is not deprecated. If it has a value, it is considered deprecated.

property deprecated: datetime | None

ISO 8601 timestamp of deprecation, None if ISO is still available.