openstack-manuals/doc/cli-reference/source/tuskar.rst

Deployment command-line client

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

tuskar usage

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> ...

Subcommands

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.

tuskar optional arguments

-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

tuskar plan-add-role

usage: tuskar plan-add-role [-h] -r <ROLE UUID> plan_uuid

Associate role to a plan.

Positional arguments

plan_uuid

UUID of the Plan to assign role to.

Optional arguments

-h, --help

show this help message and exit

-r <ROLE UUID>, --role-uuid <ROLE UUID>

UUID of the Role to be assigned.

tuskar plan-create

usage: tuskar plan-create [-h] [-d <DESCRIPTION>] name

Create a new plan.

Positional arguments

name

Name of the Plan to create.

Optional arguments

-h, --help

show this help message and exit

-d <DESCRIPTION>, --description <DESCRIPTION>

User-readable text describing the Plan.

tuskar plan-delete

usage: tuskar plan-delete [-h] <PLAN>

Delete an plan by its UUID.

Positional arguments

<PLAN>

UUID of the plan to delete.

Optional arguments

-h, --help

show this help message and exit

tuskar plan-flavor

usage: tuskar plan-flavor [-h] -F FLAVOR role_name plan_uuid

Change flavor of role in the plan.

Positional arguments

role_name

Name of role which you want to flavor.

plan_uuid

UUID of the Plan to modify.

Optional arguments

-h, --help

show this help message and exit

-F FLAVOR, --flavor FLAVOR

Flavor which shall be assigned to role.

tuskar plan-list

usage: tuskar plan-list [-h]

Show a list of the Plans.

Optional arguments

-h, --help

show this help message and exit

tuskar plan-remove-role

usage: tuskar plan-remove-role [-h] -r <ROLE UUID> plan_uuid

Remove role from a plan.

Positional arguments

plan_uuid

UUID of the Plan to remove role from.

Optional arguments

-h, --help

show this help message and exit

-r <ROLE UUID>, --role-uuid <ROLE UUID>

UUID of the Role to be removed.

tuskar plan-scale

usage: tuskar plan-scale [-h] -C COUNT role_name plan_uuid

Scale plan by changing count of roles.

Positional arguments

role_name

Name of role which you want scale.

plan_uuid

UUID of the Plan to modify.

Optional arguments

-h, --help

show this help message and exit

-C COUNT, --count COUNT

Count of nodes to be set.

tuskar plan-show

usage: tuskar plan-show [-h] [--verbose] [--only-empty-parameters] <PLAN>

Show an individual Plan by its UUID.

Positional arguments

<PLAN>

UUID of the Plan to show.

Optional arguments

-h, --help

show this help message and exit

--verbose

Display full plan details

--only-empty-parameters

Display only parameters with empty or None value

tuskar plan-show-flavors

usage: tuskar plan-show-flavors [-h] <PLAN>

Show flavors assigned to roles of Plan.

Positional arguments

<PLAN>

UUID of the Plan to show a scale.

Optional arguments

-h, --help

show this help message and exit

tuskar plan-show-scale

usage: tuskar plan-show-scale [-h] <PLAN>

Show scale counts of Plan.

Positional arguments

<PLAN>

UUID of the Plan to show a scale.

Optional arguments

-h, --help

show this help message and exit

tuskar plan-templates

usage: tuskar plan-templates [-h] -O <OUTPUT DIR> plan_uuid

Download the Heat templates for a Plan.

Positional arguments

plan_uuid

UUID of the Plan whose Templates will be retrieved.

Optional arguments

-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.

tuskar plan-update

usage: tuskar plan-update [-h] [-A <KEY1=VALUE1>] [-P <KEY1=VALUE1>] plan_uuid

Change an existing plan.

Positional arguments

plan_uuid

UUID of the Plan to modify.

Optional arguments

-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.

tuskar role-list

usage: tuskar role-list [-h]

Show a list of the Roles.

Optional arguments

-h, --help

show this help message and exit