The tuskar client is the command-line interface (CLI) for the Deployment API and its extensions. This chapter documents tuskar version 0.1.18. For help on a specific tuskar command, enter: $ tuskar help COMMAND

usage: tuskar [-h] [--version] [-d] [--os-username OS_USERNAME] [--os-password OS_PASSWORD] [--os-tenant-id OS_TENANT_ID] [--os-tenant-name OS_TENANT_NAME] [--os-auth-url OS_AUTH_URL] [--os-auth-token OS_AUTH_TOKEN] [--tuskar-url TUSKAR_URL] [--tuskar-api-version TUSKAR_API_VERSION] <subcommand> ... <subcommand> plan-add-role Associate role to a plan. plan-create Create a new plan. plan-delete Delete an plan by its UUID. plan-flavor Change flavor of role in the plan. plan-list Show a list of the Plans. plan-patch Change an existing plan [Deprecated]. plan-remove-role Remove role from a plan. plan-scale Scale plan by changing count of roles. plan-show Show an individual Plan by its UUID. plan-show-flavors Show flavors assigned to roles of Plan. plan-show-scale Show scale counts of Plan. plan-templates Download the Heat templates for a Plan. plan-update Change an existing plan. role-list Show a list of the Roles. help Display help about this program or one of its subcommands.

-h, --help Print this help message and exit. --version Shows the client version and exits. -d, --debug Defaults to env[TUSKARCLIENT_DEBUG]. --os-username OS_USERNAME Defaults to env[OS_USERNAME] --os-password OS_PASSWORD Defaults to env[OS_PASSWORD] --os-tenant-id OS_TENANT_ID Defaults to env[OS_TENANT_ID] --os-tenant-name OS_TENANT_NAME Defaults to env[OS_TENANT_NAME] --os-auth-url OS_AUTH_URL Defaults to env[OS_AUTH_URL] --os-auth-token OS_AUTH_TOKEN Defaults to env[OS_AUTH_TOKEN] --tuskar-url TUSKAR_URL Defaults to env[TUSKAR_URL] --tuskar-api-version TUSKAR_API_VERSION Defaults to env[TUSKAR_API_VERSION] or 2

usage: tuskar plan-add-role [-h] -r <ROLE UUID> plan_uuid Associate role to a plan. plan_uuid UUID of the Plan to assign role to. -h, --help show this help message and exit -r <ROLE UUID>, --role-uuid <ROLE UUID> UUID of the Role to be assigned.

usage: tuskar plan-create [-h] [-d <DESCRIPTION>] name Create a new plan. name Name of the Plan to create. -h, --help show this help message and exit -d <DESCRIPTION>, --description <DESCRIPTION> User-readable text describing the Plan.

usage: tuskar plan-delete [-h] <PLAN> Delete an plan by its UUID. <PLAN> UUID of the plan to delete. -h, --help show this help message and exit

usage: tuskar plan-flavor [-h] -F FLAVOR role_name plan_uuid Change flavor of role in the plan. role_name Name of role which you want to flavor. plan_uuid UUID of the Plan to modify. -h, --help show this help message and exit -F FLAVOR, --flavor FLAVOR Flavor which shall be assigned to role.

usage: tuskar plan-list [-h] Show a list of the Plans. -h, --help show this help message and exit

usage: tuskar plan-remove-role [-h] -r <ROLE UUID> plan_uuid Remove role from a plan. plan_uuid UUID of the Plan to remove role from. -h, --help show this help message and exit -r <ROLE UUID>, --role-uuid <ROLE UUID> UUID of the Role to be removed.

usage: tuskar plan-scale [-h] -C COUNT role_name plan_uuid Scale plan by changing count of roles. role_name Name of role which you want scale. plan_uuid UUID of the Plan to modify. -h, --help show this help message and exit -C COUNT, --count COUNT Count of nodes to be set.

usage: tuskar plan-show [-h] [--verbose] [--only-empty-parameters] <PLAN> Show an individual Plan by its UUID. <PLAN> UUID of the Plan to show. -h, --help show this help message and exit --verbose Display full plan details --only-empty-parameters Display only parameters with empty or None value

usage: tuskar plan-show-flavors [-h] <PLAN> Show flavors assigned to roles of Plan. <PLAN> UUID of the Plan to show a scale. -h, --help show this help message and exit

usage: tuskar plan-show-scale [-h] <PLAN> Show scale counts of Plan. <PLAN> UUID of the Plan to show a scale. -h, --help show this help message and exit

usage: tuskar plan-templates [-h] -O <OUTPUT DIR> plan_uuid Download the Heat templates for a Plan. plan_uuid UUID of the Plan whose Templates will be retrieved. -h, --help show this help message and exit -O <OUTPUT DIR>, --output-dir <OUTPUT DIR> Directory to write template files into. It will be created if it does not exist.

usage: tuskar plan-update [-h] [-A <KEY1=VALUE1>] [-P <KEY1=VALUE1>] plan_uuid Change an existing plan. plan_uuid UUID of the Plan to modify. -h, --help show this help message and exit -A <KEY1=VALUE1>, --attribute <KEY1=VALUE1> This can be specified multiple times. This argument is deprecated, use -P and --parameter instead. -P <KEY1=VALUE1>, --parameter <KEY1=VALUE1> This can be specified multiple times.

usage: tuskar role-list [-h] Show a list of the Roles. -h, --help show this help message and exit