system

SystemManager to provide system level information from Podman service.

class SystemManager(client: APIClient)[source]

Bases: object

SystemManager to provide system level information from Podman service.

Initialize SystemManager object.

Parameters:

client – Connection to Podman service.

df() → dict[str, Any][source]

Disk usage by Podman resources.

Returns:

Keyed by resource categories and their data usage.

Return type:

dict

info(*_, **__) → dict[str, Any][source]

Returns information on Podman service.

login(username: str, password: str | None = None, email: str | None = None, registry: str | None = None, reauth: bool | None = False, dockercfg_path: str | None = None, auth: str | None = None, identitytoken: str | None = None, registrytoken: str | None = None, tls_verify: bool | str | None = None) → dict[str, Any][source]

Log into Podman service.

Parameters:

  • username – Registry username

  • password – Registry plaintext password

  • email – Registry account email address

  • registry – URL for registry access. For example, https://quay.io/v2

  • reauth – Ignored: If True, refresh existing authentication. Default: False

  • dockercfg_path – Ignored: Path to custom configuration file.

  • auth – TODO: Add description based on the source code of Podman.

  • identitytoken – IdentityToken is used to authenticate the user and get an access token for the registry.

  • registrytoken – RegistryToken is a bearer token to be sent to a registry

  • tls_verify – Whether to verify TLS certificates.

ping() → bool[source]

Returns True if service responded with OK.

version(**kwargs) → dict[str, Any][source]

Get version information from service.

Keyword Arguments:

api_version (bool) – When True include API version