# Basic Usage

The `freezerclient` Python API

# Basic Usage

First create a client instance using a keystoneauth Session. For more information on this keystoneauth API, see Using Sessions.

    >>> from keystoneauth1 import identity
    >>> from keystoneauth1 import session
    >>> from freezerclient import client
    >>> username='username'
    >>> password='password'
    >>> project_name='demo'
    >>> project_domain_id='default'
    >>> user_domain_id='default'
    >>> auth_url='http://auth.example.com:5000/v3'
    >>> auth = identity.Password(auth_url=auth_url,
    ...                          username=username,
    ...                          password=password,
    ...                          project_name=project_name,
    ...                          project_domain_id=project_domain_id,
    ...                          user_domain_id=user_domain_id)
    >>> sess = session.Session(auth=auth)
    >>> freezer = client.Client(version='2',session=sess)

It is also possible to use an instance as a context manager in which case there will be a session kept alive for the duration of the with statement:

    >>> from freezerclient import client
    >>> freezer = client.Client('2')
    >>> freezer.jobs.list_all()

this page last updated: 2026-02-27 17:06:00

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.

found an error? report a bug