Welcome to the ChameleonCloud Python Doniclient CLI repository! This command-line interface (CLI) provides a convenient way to interact with ChameleonCloud's Doni hardware inventory project, enabling you to manage and automate various hardware-related tasks.

• Installation
• Authentication
• Usage
• Testing
• Contributing

You can install the ChameleonCloud Python Doniclient CLI using pip:

pip install python-doniclient

if you encounter an error message citing cython sources, please run the following to downgrade cython to a compatible version and use PyYaml 6.0+ pip install "cython<3.0.0"

Environment variables are the primary authentication method. Please refer to the documentation on OpenRC scripts to learn more about how to download and source your authentication credentials for the CLI;

To use the CLI, you can run the openstack hardware command followed by the desired subcommand. openstack hardware --help shows all the subcommands available. Here's a basic usage examples:

openstack hardware list

Options:

• --all: List hardware from all owners (requires admin rights).
• --long: Include all columns in the output.
• --worker-type <worker_type>: Filter by worker type.
• --worker-state <worker_state>: Filter by worker state (choices: PENDING, IN_PROGRESS, ERROR, STEADY).

For more details on specific commands and their options use --help or -h

openstack hardware create --name <hardware_name> --hardware-type <hardware_type> --property <property_name>=<property_value>

openstack hardware get <hardware_uuid>

openstack hardware get <hardware_name>

openstack hardware set <hardware_uuid> --name <new_hardware_name> --property <property_name>=<new_property_value>

Sets new name and property for the item <hardware_uuid>

openstack hardware set <hardware_name> --property <property_name>=<new_property_value>

Sets property for the item <hardware_name

openstack hardware unset <hardware_uuid> --property <property_name>

Unsets property <property_name> for the item <hardware_uuid

openstack hardware update <hardware_name> --property <property_name>=<new_property_value>

Unsets property <property_name> for the item <hardware_name>