RosettaHub CLI Reference¶

Auto-generated from picocli @Command annotations.

Command Groups¶

rh acc — Manage cloud accounts
rh all — Commands applied to all connections
rh api-key — Manage API keys
rh blacklist — Manage blacklist
rh bookmark — Manage bookmarks
rh browse — Open RH portal with current connection
rh bucket — Manage federated buckets
rh budget-transfer — Manage budget transfers
rh certificate — Manage SSL certificates
rh ci — Manage Container Images
rh classroom — Manage classrooms
rh cloud — Manage clouds
rh cloud-account-pool — Manage cloud account pools
rh compliance — Manage compliance standards and policies
rh config — Manage CLI configuration
rh container — Manage containers
rh cr —
rh cron — Manage Cron Tasks
rh custodian — Manage Cloud Custodian policies
rh domain — Manage domains
rh email-template — Manage email templates
rh encryption-key — Manage encryption keys
rh engine — Manage engines
rh engine-pool — Manage engine pools
rh events — Listen in RH real-time events
rh federated-image — Manage federated images
rh federation — Federation admin commands
rh file-storage — Manage file storages
rh formation — Manage formations
rh ftp-storage — Manage FTP storages
rh get-cloud — Get the current default cloud provider
rh get-default — Check default connection
rh get-output — Get the current CLI output format
rh get-platform-settings — Get platform settings
rh get-region — Get the current default region
rh group — Manage user groups
rh iam-role — Manage federated IAM roles
rh iam-user — Manage federated IAM users
rh image — Manage Images
rh ip-address — Manage IP addresses
rh k8s — Manage Kubernetes clusters
rh key — Manage RH keys
rh key-pair — Manage cloud key pairs
rh login — create connection with RH
rh logout — release connection with RH
rh ls — List connections established with RH
rh marketplace — Manage marketplaces
rh notifications — Listen on RH message notifications
rh open — Open a URL in the browser
rh org — Manage organizations
rh org-rule — Manage organization rules
rh orgtrail — Listen on RH trail for all members of an organization
rh perspective — Manage golden perspectives
rh portfolio — Manage portfolios
rh project — Manage projects
rh rate-task — Manage scheduled rate tasks
rh registration — Manage user registrations
rh scope — Manage scopes (admin)
rh set-account-filter — Set engine cloud account filter
rh set-cloud — Set the default cloud of the default connection
rh set-cloud-filter — Set engine cloud ID filter
rh set-cloud-region — Set the default cloud and region of the default connection
rh set-default — Set the default RH connection
rh set-output — Set the output format for the default connection
rh set-region — Set the default region of the default connection
rh set-region-filter — Set engine region filter
rh set-timezone — Set engine timezone
rh settings — Show current settings
rh single — Commands applied to default connection only
rh snapshot — Manage block snapshots
rh sso — Manage Sso
rh startup-script — Manage startup scripts
rh status — Check if the RosettaHub daemon is ready
rh storage — Manage storages
rh token — Manage tokens
rh topup — Manage top-up credits
rh trail — Listen on the RH trail
rh update-description — Update artifact description
rh update-image — Update artifact image
rh update-label — Update artifact label
rh update-svg — Update artifact svg
rh user — Manage users
rh var — Manage CLI variables
rh view — Manage golden views
rh volume — Manage Images
rh voucher — Manage vouchers
rh whoami — Show current identity and role flags

Global Options¶

These options are available on all commands:

Option	Description
`-q`, `--quiet`	Suppress non-essential output
`-y`, `--yes`	Skip confirmation prompts
`-dr`, `--dry-run`	Preview the operation without executing
`-O`, `--output`	Output format: table, json, yaml, csv

rh acc¶

Manage cloud accounts

Subcommands:

assign-from-pool — Assign cloud accounts to users from pool (cpoc)
block — Block or unblock cloud accounts (cpoc)
browse — Open a connection to a cloud account in the browser
cleanup — Cleanup owned or managed cloud accounts
configure-aws-cli — configure AWS CLI
consoleurl — Get cloud accounts console urls
costs — Get cloud costs by service
cpoc-stop-all — Stop all instances on cloud accounts (cpoc)
create-key — Create RosettaHub Key Set
delete-admin-key — Delete admin key set
detach — Cleanup and detach cloud accounts from users
disable — Disable cloud accounts
enable — Enable cloud accounts
execute-aws-cli — Execute an AWS CLI command
get-default — Get default cloud account UID
has-accounts — Check if user has cloud accounts
issuevoucher — Issue vouchers to cloud accounts
ls — List cloud accounts
ls-assignable — List assignable root cloud accounts
ls-machines — List machine instances on cloud accounts
ls-owned — List owned cloud accounts
purge-aws-cli — configure AWS CLI
quarantine — Quarantine cloud accounts (cpoc)
refresh-billing — Refresh billing info (cpoc)
refresh-compute — Refresh compute info (cpoc)
regeneratevpc — Regenerate RosettaHub Vpcs on owned or managed cloud accounts
resetallkeys — Reset all keys on owned or managed cloud accounts
resetbillingdate — Reset billing date to now on managed cloud accounts
resetbudget — Reset Remaining budget to 0 on managed cloud accounts
reversetransfer — Reverse transfer budget from managed cloud accounts
set-console-target — Set STS console URL target
set-default — Set default cloud account
set-enabled — Enable or disable cloud accounts (cpoc)
set-sharing-duration — Set sharing session duration in seconds for a cloud account
setbudget — Set budgets on managed cloud accounts
stopall — Stop all machine instances, clusters on owned or managed cloud accounts
sts-session — Get cloud account STS session
su-assign — Assign cloud account to user (superuser)
su-console-url — Get STS console URL (superuser)
su-detach — Detach cloud accounts (superuser)
su-import — Import cloud accounts (superuser)
su-new-generic-accounts — Create generic accounts (superuser)
su-reset-all-keys — Reset all keys on cloud accounts (superuser)
su-set-cleanup-protected — Set cleanup protection on cloud accounts (superuser)
su-set-governance-level — Set governance access level (superuser)
su-set-metacloud-level — Set metacloud access level (superuser)
terminateall — Terminate all machine instances, clusters on owned or managed cloud accounts
transfer — transfer budget to managed cloud accounts
unquarantine — Unquarantine cloud accounts (cpoc)
update-billing — Update billing code and purchase order (manager)
update-compute-quotas — Update compute quotas for cloud accounts (cpoc)

rh acc assign-from-pool¶

Assign cloud accounts to users from pool (cpoc)

rh acc assign-from-pool --users=<<userLogins>> --pool=<<cloudAccountPoolUid>> [--budget=<<budget>>]

Options:

Option	Description	Default
`--users, -u`	User logins
`--pool, -p`	Cloud account pool UID
`--budget, -b`	Budget amount

rh acc block¶

Block or unblock cloud accounts (cpoc)

rh acc block <<cloudAccountUids>> [--unblock=<<unblock>>] [--send-email=<<sendEmail>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--unblock`	Unblock instead of block	`false`
`--send-email`	Send email notification	`false`

rh acc browse¶

Open a connection to a cloud account in the browser

rh acc browse <<cloudAccountUids>> [--my=<<my>>] [--ops=<<includeOps>>] [--uid-filter=<<uidFilter>>] [--pool-uid=<<poolUid>>] [--cloud-id=<<cloudId>>] [--acc-num-filter=<<accNumFilter>>] [--email-filter=<<emailFilter>>] [--owner-filter=<<ownerFilter>>] [--regtype-filter=<<regTypeFilter>>] [--root-acc-filter=<<rootAccFilter>>] [--incomplete=<<includeIncomplete>>] [--incomplete-only=<<includeIncompleteOnly>>] [--support=<<includeSupportCases>>] [--limit=<<limit>>] [--cli-output=<<cliOutput>>] [--incresources=<<includeResources>>] [--include-costs=<<includeCosts>>] [--set=<<varName>>] [--default-browser=<<defaultBrowser>>] [--browser-type=<<browserType>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--my, -my`	My Accounts	`false`
`--ops, -o`	Include Ops	`false`
`--uid-filter, -f`	UID filter	`*`
`--pool-uid, -w`	Pool UID filter	`*`
`--cloud-id, -ci`	Cloud Id
`--acc-num-filter, -c`	Account Number filter	`*`
`--email-filter, -ef`	Email filter	`*`
`--owner-filter, -n`	Owner filter	`*`
`--regtype-filter, -rt`	Reg Type	`*`
`--root-acc-filter, -ra`	Owner filter	`*`
`--incomplete, -m`	Include Incomplete Accounts	`false`
`--incomplete-only, -xm`	Include Incomplete Only	`false`
`--support, -s`	Include Support Cases	`false`
`--limit, -t`	Limit
`--cli-output, -co`	CLI output (table,json,yaml,csv)	`table`
`--incresources, -ir`	include resources	`false`
`--include-costs, -ic`	include costs	`false`
`--set, -v`	assign command result to variable
`--default-browser, -d`	Use default browser (faster option but only one session as a time can be active)	`false`
`--browser-type, -bt`	Browser type (chrome\|firefox)	`chrome`

rh acc cleanup¶

Cleanup owned or managed cloud accounts

rh acc cleanup <<cloudAccountUids>> <<cloudAccountUids>> [--my=<<my>>] [--ops=<<includeOps>>] [--uid-filter=<<uidFilter>>] [--pool-uid=<<poolUid>>] [--cloud-id=<<cloudId>>] [--acc-num-filter=<<accNumFilter>>] [--email-filter=<<emailFilter>>] [--owner-filter=<<ownerFilter>>] [--regtype-filter=<<regTypeFilter>>] [--root-acc-filter=<<rootAccFilter>>] [--incomplete=<<includeIncomplete>>] [--incomplete-only=<<includeIncompleteOnly>>] [--support=<<includeSupportCases>>] [--limit=<<limit>>] [--cli-output=<<cliOutput>>] [--incresources=<<includeResources>>] [--include-costs=<<includeCosts>>] [--set=<<varName>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--my, -my`	My Accounts	`false`
`--ops, -o`	Include Ops	`false`
`--uid-filter, -f`	UID filter	`*`
`--pool-uid, -w`	Pool UID filter	`*`
`--cloud-id, -ci`	Cloud Id
`--acc-num-filter, -c`	Account Number filter	`*`
`--email-filter, -ef`	Email filter	`*`
`--owner-filter, -n`	Owner filter	`*`
`--regtype-filter, -rt`	Reg Type	`*`
`--root-acc-filter, -ra`	Owner filter	`*`
`--incomplete, -m`	Include Incomplete Accounts	`false`
`--incomplete-only, -xm`	Include Incomplete Only	`false`
`--support, -s`	Include Support Cases	`false`
`--limit, -t`	Limit
`--cli-output, -co`	CLI output (table,json,yaml,csv)	`table`
`--incresources, -ir`	include resources	`false`
`--include-costs, -ic`	include costs	`false`
`--set, -v`	assign command result to variable

rh acc configure-aws-cli¶

configure AWS CLI

rh acc configure-aws-cli <<cloudAccountUids>> [--my=<<my>>] [--ops=<<includeOps>>] [--uid-filter=<<uidFilter>>] [--pool-uid=<<poolUid>>] [--cloud-id=<<cloudId>>] [--acc-num-filter=<<accNumFilter>>] [--email-filter=<<emailFilter>>] [--owner-filter=<<ownerFilter>>] [--regtype-filter=<<regTypeFilter>>] [--root-acc-filter=<<rootAccFilter>>] [--incomplete=<<includeIncomplete>>] [--incomplete-only=<<includeIncompleteOnly>>] [--support=<<includeSupportCases>>] [--limit=<<limit>>] [--cli-output=<<cliOutput>>] [--incresources=<<includeResources>>] [--include-costs=<<includeCosts>>] [--set=<<varName>>] [--duration=<<duration>>] [--admin=<<admin>>] [--display-profiles=<<displayProfiles>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--my, -my`	My Accounts	`false`
`--ops, -o`	Include Ops	`false`
`--uid-filter, -f`	UID filter	`*`
`--pool-uid, -w`	Pool UID filter	`*`
`--cloud-id, -ci`	Cloud Id
`--acc-num-filter, -c`	Account Number filter	`*`
`--email-filter, -ef`	Email filter	`*`
`--owner-filter, -n`	Owner filter	`*`
`--regtype-filter, -rt`	Reg Type	`*`
`--root-acc-filter, -ra`	Owner filter	`*`
`--incomplete, -m`	Include Incomplete Accounts	`false`
`--incomplete-only, -xm`	Include Incomplete Only	`false`
`--support, -s`	Include Support Cases	`false`
`--limit, -t`	Limit
`--cli-output, -co`	CLI output (table,json,yaml,csv)	`table`
`--incresources, -ir`	include resources	`false`
`--include-costs, -ic`	include costs	`false`
`--set, -v`	assign command result to variable
`--duration, -du`	Session duration in seconds	`43200`
`--admin, -A`	Use administrator credentials	`false`
`--display-profiles, -dp`	Display configured profiles	`true`

rh acc consoleurl¶

Get cloud accounts console urls

rh acc consoleurl <<cloudAccountUids>> [--duration=<<durationSeconds>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--duration, -d`	duration in seconds

rh acc costs¶

Get cloud costs by service

rh acc costs <<rootCloudAccountUid>> [--month=<<month>>] [--year=<<year>>] [--set=<<varName>>]

Parameters:

Parameter	Description
`<<rootCloudAccountUid>>`	Root cloud account UID

Options:

Option	Description	Default
`--month, -m`	Month (1-12), defaults to current month
`--year, -yr`	Year, defaults to current year
`--set, -v`	Assign command result to variable

rh acc cpoc-stop-all¶

Stop all instances on cloud accounts (cpoc)

rh acc cpoc-stop-all <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

rh acc create-key¶

Create RosettaHub Key Set

rh acc create-key <<cloudAccountUid>> --label=<<label>> [--description=<<description>>] [--default-capacity=<<defaultCapacity>>] [--max-instances=<<maxInstances>>] [--region=<<regionId>>]

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	cloud account uid

Options:

Option	Description	Default
`--label, -l`	label
`--description, -des`	description
`--default-capacity, -c`	Default instance type	`m4.large`
`--max-instances, -i`	Maximum number of instances	`100`
`--region, -r`	Default region

rh acc delete-admin-key¶

Delete admin key set

rh acc detach¶

Cleanup and detach cloud accounts from users

rh acc detach <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

rh acc disable¶

Disable cloud accounts

rh acc disable <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

rh acc enable¶

Enable cloud accounts

rh acc enable <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

rh acc execute-aws-cli¶

Execute an AWS CLI command

rh acc execute-aws-cli <<cloudAccountUids>> [--my=<<my>>] [--ops=<<includeOps>>] [--uid-filter=<<uidFilter>>] [--pool-uid=<<poolUid>>] [--cloud-id=<<cloudId>>] [--acc-num-filter=<<accNumFilter>>] [--email-filter=<<emailFilter>>] [--owner-filter=<<ownerFilter>>] [--regtype-filter=<<regTypeFilter>>] [--root-acc-filter=<<rootAccFilter>>] [--incomplete=<<includeIncomplete>>] [--incomplete-only=<<includeIncompleteOnly>>] [--support=<<includeSupportCases>>] [--limit=<<limit>>] [--cli-output=<<cliOutput>>] [--incresources=<<includeResources>>] [--include-costs=<<includeCosts>>] [--set=<<varName>>] [--duration=<<duration>>] [--admin=<<admin>>] [--display-profiles=<<displayProfiles>>] [--command=<<command>>] [--reset-aws-cli=<<resetAwsCli>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--my, -my`	My Accounts	`false`
`--ops, -o`	Include Ops	`false`
`--uid-filter, -f`	UID filter	`*`
`--pool-uid, -w`	Pool UID filter	`*`
`--cloud-id, -ci`	Cloud Id
`--acc-num-filter, -c`	Account Number filter	`*`
`--email-filter, -ef`	Email filter	`*`
`--owner-filter, -n`	Owner filter	`*`
`--regtype-filter, -rt`	Reg Type	`*`
`--root-acc-filter, -ra`	Owner filter	`*`
`--incomplete, -m`	Include Incomplete Accounts	`false`
`--incomplete-only, -xm`	Include Incomplete Only	`false`
`--support, -s`	Include Support Cases	`false`
`--limit, -t`	Limit
`--cli-output, -co`	CLI output (table,json,yaml,csv)	`table`
`--incresources, -ir`	include resources	`false`
`--include-costs, -ic`	include costs	`false`
`--set, -v`	assign command result to variable
`--duration, -du`	Session duration in seconds	`43200`
`--admin, -A`	Use administrator credentials	`false`
`--display-profiles, -dp`	Display configured profiles	`true`
`--command, -cmd`	AWS CLI command
`--reset-aws-cli, -rac`	Reset AWS CLI

rh acc get-default¶

Get default cloud account UID

rh acc has-accounts¶

Check if user has cloud accounts

rh acc issuevoucher¶

Issue vouchers to cloud accounts

rh acc issuevoucher <<cloudAccountUid>> --amount=<<amount>> --exp=<<expiryDate>>

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	cloud account uid

Options:

Option	Description	Default
`--amount, -am`	amount
`--exp, -e`	expiry date

rh acc ls¶

List cloud accounts

rh acc ls <<cloudAccountUids>> [--my=<<my>>] [--ops=<<includeOps>>] [--uid-filter=<<uidFilter>>] [--pool-uid=<<poolUid>>] [--cloud-id=<<cloudId>>] [--acc-num-filter=<<accNumFilter>>] [--email-filter=<<emailFilter>>] [--owner-filter=<<ownerFilter>>] [--regtype-filter=<<regTypeFilter>>] [--root-acc-filter=<<rootAccFilter>>] [--incomplete=<<includeIncomplete>>] [--incomplete-only=<<includeIncompleteOnly>>] [--support=<<includeSupportCases>>] [--limit=<<limit>>] [--cli-output=<<cliOutput>>] [--incresources=<<includeResources>>] [--include-costs=<<includeCosts>>] [--set=<<varName>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--my, -my`	My Accounts	`false`
`--ops, -o`	Include Ops	`false`
`--uid-filter, -f`	UID filter	`*`
`--pool-uid, -w`	Pool UID filter	`*`
`--cloud-id, -ci`	Cloud Id
`--acc-num-filter, -c`	Account Number filter	`*`
`--email-filter, -ef`	Email filter	`*`
`--owner-filter, -n`	Owner filter	`*`
`--regtype-filter, -rt`	Reg Type	`*`
`--root-acc-filter, -ra`	Owner filter	`*`
`--incomplete, -m`	Include Incomplete Accounts	`false`
`--incomplete-only, -xm`	Include Incomplete Only	`false`
`--support, -s`	Include Support Cases	`false`
`--limit, -t`	Limit
`--cli-output, -co`	CLI output (table,json,yaml,csv)	`table`
`--incresources, -ir`	include resources	`false`
`--include-costs, -ic`	include costs	`false`
`--set, -v`	assign command result to variable

rh acc ls-assignable¶

List assignable root cloud accounts

rh acc ls-machines¶

List machine instances on cloud accounts

rh acc ls-machines <<cloudAccountUids>> [--my=<<my>>] [--ops=<<includeOps>>] [--uid-filter=<<uidFilter>>] [--pool-uid=<<poolUid>>] [--cloud-id=<<cloudId>>] [--acc-num-filter=<<accNumFilter>>] [--email-filter=<<emailFilter>>] [--owner-filter=<<ownerFilter>>] [--regtype-filter=<<regTypeFilter>>] [--root-acc-filter=<<rootAccFilter>>] [--incomplete=<<includeIncomplete>>] [--incomplete-only=<<includeIncompleteOnly>>] [--support=<<includeSupportCases>>] [--limit=<<limit>>] [--cli-output=<<cliOutput>>] [--incresources=<<includeResources>>] [--include-costs=<<includeCosts>>] [--set=<<varName>>] [--instance-label=<<instanceLabel>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--my, -my`	My Accounts	`false`
`--ops, -o`	Include Ops	`false`
`--uid-filter, -f`	UID filter	`*`
`--pool-uid, -w`	Pool UID filter	`*`
`--cloud-id, -ci`	Cloud Id
`--acc-num-filter, -c`	Account Number filter	`*`
`--email-filter, -ef`	Email filter	`*`
`--owner-filter, -n`	Owner filter	`*`
`--regtype-filter, -rt`	Reg Type	`*`
`--root-acc-filter, -ra`	Owner filter	`*`
`--incomplete, -m`	Include Incomplete Accounts	`false`
`--incomplete-only, -xm`	Include Incomplete Only	`false`
`--support, -s`	Include Support Cases	`false`
`--limit, -t`	Limit
`--cli-output, -co`	CLI output (table,json,yaml,csv)	`table`
`--incresources, -ir`	include resources	`false`
`--include-costs, -ic`	include costs	`false`
`--set, -v`	assign command result to variable
`--instance-label, -il`	Instance label to filter by

rh acc ls-owned¶

List owned cloud accounts

rh acc ls-owned <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

rh acc purge-aws-cli¶

configure AWS CLI

rh acc purge-aws-cli <<cloudAccountUids>> [--my=<<my>>] [--ops=<<includeOps>>] [--uid-filter=<<uidFilter>>] [--pool-uid=<<poolUid>>] [--cloud-id=<<cloudId>>] [--acc-num-filter=<<accNumFilter>>] [--email-filter=<<emailFilter>>] [--owner-filter=<<ownerFilter>>] [--regtype-filter=<<regTypeFilter>>] [--root-acc-filter=<<rootAccFilter>>] [--incomplete=<<includeIncomplete>>] [--incomplete-only=<<includeIncompleteOnly>>] [--support=<<includeSupportCases>>] [--limit=<<limit>>] [--cli-output=<<cliOutput>>] [--incresources=<<includeResources>>] [--include-costs=<<includeCosts>>] [--set=<<varName>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--my, -my`	My Accounts	`false`
`--ops, -o`	Include Ops	`false`
`--uid-filter, -f`	UID filter	`*`
`--pool-uid, -w`	Pool UID filter	`*`
`--cloud-id, -ci`	Cloud Id
`--acc-num-filter, -c`	Account Number filter	`*`
`--email-filter, -ef`	Email filter	`*`
`--owner-filter, -n`	Owner filter	`*`
`--regtype-filter, -rt`	Reg Type	`*`
`--root-acc-filter, -ra`	Owner filter	`*`
`--incomplete, -m`	Include Incomplete Accounts	`false`
`--incomplete-only, -xm`	Include Incomplete Only	`false`
`--support, -s`	Include Support Cases	`false`
`--limit, -t`	Limit
`--cli-output, -co`	CLI output (table,json,yaml,csv)	`table`
`--incresources, -ir`	include resources	`false`
`--include-costs, -ic`	include costs	`false`
`--set, -v`	assign command result to variable

rh acc quarantine¶

Quarantine cloud accounts (cpoc)

rh acc quarantine <<cloudAccountUids>> [--send-email=<<sendEmail>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--send-email`	Send email notification	`false`

rh acc refresh-billing¶

Refresh billing info (cpoc)

rh acc refresh-billing <<rootCloudAccountUid>> [--reset-all=<<resetAll>>] [--regenerate-reports=<<regenerateReports>>]

Parameters:

Parameter	Description
`<<rootCloudAccountUid>>`	Root cloud account uid

Options:

Option	Description	Default
`--reset-all`	Reset all billing info	`false`
`--regenerate-reports`	Regenerate all reports	`false`

rh acc refresh-compute¶

Refresh compute info (cpoc)

rh acc refresh-compute <<rootCloudAccountUid>> [--accounts=<<userCloudAccountUids>>]

Parameters:

Parameter	Description
`<<rootCloudAccountUid>>`	Root cloud account uid

Options:

Option	Description	Default
`--accounts, -a`	User cloud account uids

rh acc regeneratevpc¶

Regenerate RosettaHub Vpcs on owned or managed cloud accounts

rh acc regeneratevpc <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

rh acc resetallkeys¶

Reset all keys on owned or managed cloud accounts

rh acc resetallkeys <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

rh acc resetbillingdate¶

Reset billing date to now on managed cloud accounts

rh acc resetbillingdate <<cloudAccountUids>> [--latest-expiry=<<latestExpiry>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--latest-expiry, -le`	latest expiry first

rh acc resetbudget¶

Reset Remaining budget to 0 on managed cloud accounts

rh acc resetbudget <<cloudAccountUids>> [--latest-expiry=<<latestExpiry>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--latest-expiry, -le`	latest expiry first

rh acc reversetransfer¶

Reverse transfer budget from managed cloud accounts

rh acc reversetransfer <<cloudAccountUids>> --amount=<<amount>> [--latest-expiry=<<latestExpiry>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--amount, -am`	amount
`--latest-expiry, -le`	latest expiry first

rh acc set-console-target¶

Set STS console URL target

rh acc set-console-target <<cloudAccountUid>> --target=<<target>>

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	cloud account uid

Options:

Option	Description	Default
`--target, -t`	Console URL target (0=classic, 1=new)

rh acc set-default¶

Set default cloud account

rh acc set-default <<cloudAccountUid>>

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	cloud account uid

rh acc set-enabled¶

Enable or disable cloud accounts (cpoc)

rh acc set-enabled <<cloudAccountUids>> [--disabled=<<disabled>>] [--send-email=<<sendEmail>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--disabled`	Disable instead of enable	`false`
`--send-email`	Send email notification	`false`

Set sharing session duration in seconds for a cloud account

rh acc set-sharing-duration <<cloudAccountUid>> <<durationSeconds>>

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account uid
`<<durationSeconds>>`	Duration in seconds

rh acc setbudget¶

Set budgets on managed cloud accounts

rh acc setbudget <<cloudAccountUids>> --budget=<<budget>> [--latest-expiry=<<latestExpiry>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--budget, -b`	budget
`--latest-expiry, -le`	latest expiry first

rh acc stopall¶

Stop all machine instances, clusters on owned or managed cloud accounts

rh acc stopall <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

rh acc sts-session¶

Get cloud account STS session

rh acc sts-session <<cloudAccountUid>> [--duration=<<durationSeconds>>]

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	cloud account uid

Options:

Option	Description	Default
`--duration, -d`	Session duration in seconds	`3600`

rh acc su-assign¶

Assign cloud account to user (superuser)

rh acc su-assign <<cloudAccountUid>> --user=<<userLogin>> [--delete-user=<<deleteUser>>]

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account uid

Options:

Option	Description	Default
`--user, -u`	User login
`--delete-user`	Delete user	`false`

rh acc su-console-url¶

Get STS console URL (superuser)

rh acc su-console-url <<cloudAccountUid>> [--duration=<<durationSeconds>>]

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account uid

Options:

Option	Description	Default
`--duration, -d`	Duration in seconds	`3600`

rh acc su-detach¶

Detach cloud accounts (superuser)

rh acc su-detach <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

rh acc su-import¶

Import cloud accounts (superuser)

rh acc su-import --root=<<rootCloudAccountUid>> --accounts=<<accountNumbers>> [--login-prefix=<<loginPrefix>>] [--login-suffix=<<loginSuffix>>]

Options:

Option	Description	Default
`--root, -r`	Root cloud account UID
`--accounts, -a`	Account numbers
`--login-prefix`	Login prefix
`--login-suffix`	Login suffix

rh acc su-new-generic-accounts¶

Create generic accounts (superuser)

rh acc su-new-generic-accounts --root=<<rootCloudAccountUid>> --count=<<nbRegistrations>> --prefix=<<loginPrefix>> [--start-at=<<startAt>>] [--reg-type=<<regType>>]

Options:

Option	Description	Default
`--root, -r`	Root cloud account uid
`--count, -n`	Number of registrations
`--prefix`	Login prefix
`--start-at`	Start at index	`1`
`--reg-type`	Registration type

rh acc su-reset-all-keys¶

Reset all keys on cloud accounts (superuser)

rh acc su-reset-all-keys <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

rh acc su-set-cleanup-protected¶

Set cleanup protection on cloud accounts (superuser)

rh acc su-set-cleanup-protected <<cloudAccountUids>> --protected=<<cleanupProtected>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--protected, -p`	Cleanup protected

rh acc su-set-governance-level¶

Set governance access level (superuser)

rh acc su-set-governance-level <<rootCloudAccountUids>> --level=<<level>>

Parameters:

Parameter	Description
`<<rootCloudAccountUids>>`	Root cloud account uids

Options:

Option	Description	Default
`--level, -l`	Governance access level

rh acc su-set-metacloud-level¶

Set metacloud access level (superuser)

rh acc su-set-metacloud-level <<cloudAccountUids>> --level=<<level>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--level, -l`	Metacloud access level

rh acc terminateall¶

Terminate all machine instances, clusters on owned or managed cloud accounts

rh acc terminateall <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

rh acc transfer¶

transfer budget to managed cloud accounts

rh acc transfer <<cloudAccountUids>> --amount=<<amount>> [--latest-expiry=<<latestExpiry>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	cloud account uids

Options:

Option	Description	Default
`--amount, -am`	amount
`--latest-expiry, -le`	latest expiry first

rh acc unquarantine¶

Unquarantine cloud accounts (cpoc)

rh acc unquarantine <<cloudAccountUids>> [--send-email=<<sendEmail>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--send-email`	Send email notification	`false`

rh acc update-billing¶

Update billing code and purchase order (manager)

rh acc update-billing <<cloudAccountUid>> [--billing-code=<<billingCode>>] [--purchase-order=<<purchaseOrder>>] [--autonomous=<<autonomousBilling>>]

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account uid

Options:

Option	Description	Default
`--billing-code, -b`	Billing code
`--purchase-order, -p`	Purchase order
`--autonomous`	Autonomous billing	`false`

rh acc update-compute-quotas¶

Update compute quotas for cloud accounts (cpoc)

rh acc update-compute-quotas --accounts=<<cloudAccountUids>> [--regions=<<regionIds>>]

Options:

Option	Description	Default
`--accounts, -a`	Cloud account uids
`--regions, -r`	Region ids

rh all¶

Commands applied to all connections

rh api-key¶

Manage API keys

Subcommands:

create — Create an API key
delete — Delete API keys
ls — List API keys

rh api-key create¶

Create an API key

rh api-key create [--timeout=<<timeoutMinutes>>] [--method-filters=<<methodNameFilters>>] [--tag-filters=<<methodTagFilters>>] [--label=<<label>>] [--description=<<description>>]

Options:

Option	Description	Default
`--timeout, -to`	Timeout in minutes (0 = no timeout)	`0`
`--method-filters, -mf`	Method name filters (comma-separated)
`--tag-filters, -tf`	Method tag filters (comma-separated)
`--label, -l`	Label
`--description, -desc`	Description

rh api-key delete¶

Delete API keys

rh api-key delete <<apiKeyPrefixes>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<apiKeyPrefixes>>`	API key prefixes

Options:

Option	Description	Default
`--all, -a`	Delete all API keys	`false`

rh api-key ls¶

List API keys

rh api-key ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh blacklist¶

Manage blacklist

Subcommands:

add — Add users to the blacklist
delete — Delete users from the blacklist
ls — List blacklisted users

rh blacklist add¶

Add users to the blacklist

rh blacklist add <<logins>> [--message=<<message>>] [--report-abuse=<<reportAbuse>>] [--label=<<label>>] [--description=<<description>>]

Parameters:

Parameter	Description
`<<logins>>`	User logins to blacklist

Options:

Option	Description	Default
`--message, -m`	Message
`--report-abuse, -ra`	Report abuse	`false`
`--label, -l`	Label
`--description, -d`	Description

rh blacklist delete¶

Delete users from the blacklist

rh blacklist delete <<logins>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<logins>>`	User logins to remove from blacklist

Options:

Option	Description	Default
`--all, -a`	Delete all blacklisted users	`false`

rh blacklist ls¶

List blacklisted users

rh blacklist ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	assign command result to variable

rh bookmark¶

Manage bookmarks

Subcommands:

add — Add artifact to bookmarks
folders — List bookmark folders
ls — List bookmarked artifacts
remove — Remove artifact from bookmarks
remove-folder — Remove bookmark folder

rh bookmark add¶

Add artifact to bookmarks

rh bookmark add <<artifactUid>> --folder=<<folder>>

Parameters:

Parameter	Description
`<<artifactUid>>`	Artifact uid

Options:

Option	Description	Default
`--folder, -fo`	Bookmark folder

rh bookmark folders¶

List bookmark folders

rh bookmark ls¶

List bookmarked artifacts

rh bookmark ls --folder=<<folder>>

Options:

Option	Description	Default
`--folder, -fo`	Bookmark folder

rh bookmark remove¶

Remove artifact from bookmarks

rh bookmark remove <<artifactUid>> --folder=<<folder>>

Parameters:

Parameter	Description
`<<artifactUid>>`	Artifact uid

Options:

Option	Description	Default
`--folder, -fo`	Bookmark folder

rh bookmark remove-folder¶

Remove bookmark folder

rh bookmark remove-folder <<folder>>

Parameters:

Parameter	Description
`<<folder>>`	Bookmark folder name

rh browse¶

Open RH portal with current connection

rh browse [--default-browser=<<defaultBrowser>>] [--browser-type=<<browserType>>]

Options:

Option	Description	Default
`--default-browser, -d`	Use default browser (faster option but only one session as a time can be active)	`false`
`--browser-type, -t`	Browser type (chrome\|firefox)	`chrome`

rh bucket¶

Manage federated buckets

Subcommands:

clone — Clone a federated bucket
delete — Delete federated buckets
empty — Empty federated buckets
ls — List federated buckets
share — Share a federated bucket
sync — Synchronize federated buckets
unshare — Unshare a federated bucket

rh bucket clone¶

Clone a federated bucket

rh bucket clone <<sourceBucketUid>> --destination=<<destinationBucketUid>>

Parameters:

Parameter	Description
`<<sourceBucketUid>>`	Source bucket UID

Options:

Option	Description	Default
`--destination, -d`	Destination bucket UID

rh bucket delete¶

Delete federated buckets

rh bucket delete <<bucketUids>>

Parameters:

Parameter	Description
`<<bucketUids>>`	Bucket UIDs

rh bucket empty¶

Empty federated buckets

rh bucket empty <<bucketUids>> [--include=<<includeFilter>>] [--exclude=<<excludeFilter>>]

Parameters:

Parameter	Description
`<<bucketUids>>`	Bucket UIDs

Options:

Option	Description	Default
`--include, -i`	Include filter pattern
`--exclude, -e`	Exclude filter pattern

rh bucket ls¶

List federated buckets

rh bucket ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Filter	`*`
`--all, -a`	Include all	`false`
`--private, -u`	Include private	`false`
`--shared, -s`	Include shared	`false`
`--public, -p`	Include public	`false`
`--set, -v`	Assign command result to variable

Share a federated bucket

rh bucket share <<bucketUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--folder-path=<<folderPath>>] [--rights=<<rights>>]

Parameters:

Parameter	Description
`<<bucketUid>>`	Bucket UID

Options:

Option	Description	Default
`--tenant, -t`	Tenant
`--tenantType, -p`	Tenant type, u: user, o: organization, g: group, r: role	`u`
`--replace, -d`	Replace	`false`
`--folder-path, -fp`	Folder path
`--rights, -ri`	Rights

rh bucket sync¶

Synchronize federated buckets

rh bucket sync <<cloudAccountUid>>

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account UID

rh bucket unshare¶

Unshare a federated bucket

rh bucket unshare <<bucketUid>>

Parameters:

Parameter	Description
`<<bucketUid>>`	Bucket UID

rh budget-transfer¶

Manage budget transfers

Subcommands:

by-logins — Transfer budget by user logins (cpoc)
cpoc-transfer — Transfer budget to users by cloud account UIDs (admin/cpoc)
create — Transfer budget to a user
ls — List budget transfers
ls-requests — List limit increase requests
request-increase — Request a budget increase
reset — Reset budget for cloud accounts (admin)
reverse — Reverse budget transfer from users (admin/cpoc)
set — Set budget to a specific amount for cloud accounts (admin)

rh budget-transfer by-logins¶

Transfer budget by user logins (cpoc)

rh budget-transfer by-logins --users=<<userLogins>> --amount=<<amount>> [--early-expiry-first=<<earlyExpiryFirst>>]

Options:

Option	Description	Default
`--users, -u`	User logins
`--amount, -a`	Transfer amount
`--early-expiry-first, -eef`	Use early expiry credits first	`false`

rh budget-transfer cpoc-transfer¶

Transfer budget to users by cloud account UIDs (admin/cpoc)

rh budget-transfer cpoc-transfer --to=<<toUserCloudAccountUids>> --amount=<<amount>> [--early-expiry-first=<<earlyExpiryFirst>>]

Options:

Option	Description	Default
`--to, -to`	Recipient cloud account UIDs (comma-separated)
`--amount, -am`	Transfer amount
`--early-expiry-first, -eef`	Use early expiry credits first	`false`

rh budget-transfer create¶

Transfer budget to a user

rh budget-transfer create <<toLogin>> --amount=<<amount>> [--early-expiry-first=<<earlyExpiryFirst>>]

Parameters:

Parameter	Description
`<<toLogin>>`	Recipient login

Options:

Option	Description	Default
`--amount, -am`	Transfer amount
`--early-expiry-first, -eef`	Use early expiry credits first	`false`

rh budget-transfer ls¶

List budget transfers

rh budget-transfer ls [--managed=<<managed>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--managed, -mg`	List managed budget transfers (admin/cpoc)	`false`
`--set, -v`	Assign command result to variable

rh budget-transfer ls-requests¶

List limit increase requests

rh budget-transfer request-increase¶

Request a budget increase

rh budget-transfer request-increase --amount=<<amount>> [--reason=<<reason>>]

Options:

Option	Description	Default
`--amount, -a`	Requested new budget amount
`--reason, -r`	Reason for the increase request

rh budget-transfer reset¶

Reset budget for cloud accounts (admin)

rh budget-transfer reset --accounts=<<userCloudAccountUids>> [--early-expiry-first=<<earlyExpiryFirst>>]

Options:

Option	Description	Default
`--accounts, -ac`	Cloud account UIDs (comma-separated)
`--early-expiry-first, -eef`	Use early expiry credits first	`false`

rh budget-transfer reverse¶

Reverse budget transfer from users (admin/cpoc)

rh budget-transfer reverse --from=<<fromCloudAccountUids>> --amount=<<amount>> [--early-expiry-first=<<earlyExpiryFirst>>]

Options:

Option	Description	Default
`--from, -fr`	Source cloud account UIDs (comma-separated)
`--amount, -am`	Amount to reverse
`--early-expiry-first, -eef`	Use early expiry credits first	`false`

rh budget-transfer set¶

Set budget to a specific amount for cloud accounts (admin)

rh budget-transfer set --accounts=<<cloudAccountUids>> --amount=<<amount>> [--early-expiry-first=<<earlyExpiryFirst>>]

Options:

Option	Description	Default
`--accounts, -ac`	Cloud account UIDs (comma-separated)
`--amount, -am`	Target budget amount
`--early-expiry-first, -eef`	Use early expiry credits first	`false`

rh certificate¶

Manage SSL certificates

Subcommands:

create — Create an SSL certificate
delete — Delete SSL certificates
get — Get SSL certificate details
ls — List SSL certificates
renew — Renew SSL certificates
set-main — Set an SSL certificate as main
share — Share SSL certificate
unshare — Unshare SSL certificate

rh certificate create¶

Create an SSL certificate

rh certificate create <<domainUid>> [--subdomain=<<subdomainNames>>] [--key-size=<<keySize>>] --label=<<label>> [--description=<<description>>]

Parameters:

Parameter	Description
`<<domainUid>>`	Domain uid

Options:

Option	Description	Default
`--subdomain, -sd`	Subdomain names
`--key-size, -ks`	Key size	`2048`
`--label, -l`	Label
`--description, -d`	Description

rh certificate delete¶

Delete SSL certificates

rh certificate delete <<sslCertificateUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<sslCertificateUids>>`	SSL certificate uids to delete

Options:

Option	Description	Default
`--all, -a`	Delete all SSL certificates	`false`

rh certificate get¶

Get SSL certificate details

rh certificate get <<sslCertificateUid>>

Parameters:

Parameter	Description
`<<sslCertificateUid>>`	SSL certificate uid

rh certificate ls¶

List SSL certificates

rh certificate ls [--filter=<<filter>>] [--set=<<varName>>] [--domain=<<domainName>>] [--approved=<<approved>>] [--enabled=<<enabled>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>]

Options:

Option	Description	Default
`--filter, -f`	Certificate filter
`--set, -v`	assign command result to variable
`--domain, -dm`	Filter by domain name
`--approved, -ap`	Filter by approved status
`--enabled, -en`	Filter by enabled status
`--all, -a`	include all certificates	`false`
`--private, -u`	include private certificates	`false`
`--shared, -s`	include shared certificates	`false`
`--public, -p`	include public certificates	`false`

rh certificate renew¶

Renew SSL certificates

rh certificate renew <<sslCertificateUids>>

Parameters:

Parameter	Description
`<<sslCertificateUids>>`	SSL certificate uids to renew

rh certificate set-main¶

Set an SSL certificate as main

rh certificate set-main <<sslCertificateUid>>

Parameters:

Parameter	Description
`<<sslCertificateUid>>`	SSL certificate uid

Share SSL certificate

rh certificate share <<sslCertificateUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--max-machines=<<machineNumberMax>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<sslCertificateUid>>`	SSL certificate uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--max-machines, -mm`	maximum number of machines	`0`
`--replace, -d`	replace	`false`

rh certificate unshare¶

Unshare SSL certificate

rh certificate unshare <<sslCertificateUid>>

Parameters:

Parameter	Description
`<<sslCertificateUid>>`	SSL certificate uid

rh ci¶

Manage Container Images

Subcommands:

clone — Clone a container image
create — Create a container image
delete — Delete a container image
get — Get container image details
launch — Launch a container image
ls — List container images
share — Share container image
unshare — Unshare container image
update — Update container image identity and registry settings
update-dockerfile — Update container image Dockerfile settings
update-formation — Update container image default formation
update-runtime — Update container image runtime configuration (apps, ports, volumes, env vars, commands)
update-scripts — Update container image startup scripts

rh ci clone¶

Clone a container image

rh ci clone <<containerImageUid>> --label=<<label>>

Parameters:

Parameter	Description
`<<containerImageUid>>`	Container image UID

Options:

Option	Description	Default
`--label, -l`	Label

rh ci create¶

Create a container image

rh ci create --name=<<containerImageName>> [--cmd=<<command>>] [--startup-scripts=<<startupScriptUids>>] [--ports=<<ports>>] [--label=<<label>>] [--description=<<description>>] [--app=<<apps>>] [--create-default-formation=<<createDefaultFormation>>] [--default-capacity=<<defaultCapacityId>>] [--repository=<<repositoryUid>>] [--local-image-id=<<localContainerImageId>>] [--size=<<size>>] [--virtual-size=<<virtualSize>>] [--disable-content-trust=<<disableContentTrust>>] [--platform=<<platform>>] [--recreate-on-reboot=<<recreateOnReboot>>]

Options:

Option	Description	Default
`--name, -n`	Container Image Name
`--cmd, -c`	Commands
`--startup-scripts, -ss`	Start Up Script Uids
`--ports, -pt`	Ports
`--label, -l`	Label
`--description, -desc`	Description
`--app, -ap`	Container application
`--create-default-formation, -cdf`	Create default formation	`false`
`--default-capacity, -t`	Default capacity
`--repository, -rp`	Repository Uid
`--local-image-id, -locid`	Local Container Image Id
`--size, -s`	Size
`--virtual-size, -vs`	Virtual Size
`--disable-content-trust, -dt`	Disable Content Trust	`false`
`--platform, -pl`	Platform
`--recreate-on-reboot, -rbt`	Recreate On Reboot

rh ci delete¶

Delete a container image

rh ci delete <<containerImageUids>> [--deleteformation=<<deleteDefaultFormation>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<containerImageUids>>`	Container Image Uids

Options:

Option	Description	Default
`--deleteformation, -df`	delete default formation	`false`
`--all, -a`	Delete all container images	`false`

rh ci get¶

Get container image details

rh ci get <<containerImageUid>>

Parameters:

Parameter	Description
`<<containerImageUid>>`	Container image uid

rh ci launch¶

Launch a container image

rh ci launch <<containerImageUid>> [--keys=<<keySetUid>>] [--volume=<<workingVolumeUid>>] [--working-dir=<<workingDirectory>>] [--label=<<label>>]

Parameters:

Parameter	Description
`<<containerImageUid>>`	Container image UID

Options:

Option	Description	Default
`--keys, -k`	Key set UID
`--volume, -v`	Working volume UID
`--working-dir, -wd`	Working directory
`--label, -l`	Label

rh ci ls¶

List container images

rh ci ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Container Image filter	`*`
`--all, -a`	include all container images	`false`
`--private, -u`	include private container images	`false`
`--shared, -s`	include shared container images	`false`
`--public, -p`	include public container images	`false`
`--region, -r`	region
`--cloud, -c`	cloud
`--set, -v`	assign command result to variable

Share container image

rh ci share <<containerImageUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--allow-clone=<<cloningAllowed>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<containerImageUid>>`	container image uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--allow-clone, -ac`	allow cloning	`false`
`--replace, -d`	replace	`false`

rh ci unshare¶

Unshare container image

rh ci unshare <<containerImageUid>>

Parameters:

Parameter	Description
`<<containerImageUid>>`	container image uid

rh ci update¶

Update container image identity and registry settings

rh ci update <<containerImageUid>> [--name=<<containerImageName>>] [--repository=<<repositoryUid>>] [--local-image-id=<<localContainerImageId>>] [--size=<<size>>] [--virtual-size=<<virtualSize>>] [--disable-content-trust=<<disableContentTrust>>] [--platform=<<platform>>]

Parameters:

Parameter	Description
`<<containerImageUid>>`	Container Image UID

Options:

Option	Description	Default
`--name, -n`	Container Image Name
`--repository, -rp`	Repository UID
`--local-image-id, -locid`	Local Container Image Id
`--size, -s`	Size	`0`
`--virtual-size, -vs`	Virtual Size	`0`
`--disable-content-trust, -dt`	Disable Content Trust	`false`
`--platform, -pl`	Platform

rh ci update-dockerfile¶

Update container image Dockerfile settings

rh ci update-dockerfile <<containerImageUid>> [--inline-dockerfile=<<inlineDockerFile>>] [--dockerfile-url=<<dockerFileUrl>>] [--dockerfile-path=<<dockerFilePath>>] [--dockerfile-volume=<<dockerFileVolumeUid>>]

Parameters:

Parameter	Description
`<<containerImageUid>>`	Container Image UID

Options:

Option	Description	Default
`--inline-dockerfile, -idf`	Inline Dockerfile content
`--dockerfile-url, -dfu`	Dockerfile URL
`--dockerfile-path, -dfp`	Dockerfile path
`--dockerfile-volume, -dfv`	Dockerfile volume UID

rh ci update-formation¶

Update container image default formation

rh ci update-formation <<containerImageUid>> --formation=<<defaultFormationUid>>

Parameters:

Parameter	Description
`<<containerImageUid>>`	Container Image UID

Options:

Option	Description	Default
`--formation, -f`	Default formation UID

rh ci update-runtime¶

Update container image runtime configuration (apps, ports, volumes, env vars, commands)

rh ci update-runtime <<containerImageUid>> [--apps=<<apps>>] [--app-settings=<<appSettings>>] [--env-vars=<<envVars>>] [--ports=<<ports>>] [--volumes=<<volumes>>] [--cmd=<<command>>] [--options=<<options>>] [--network-mode=<<networkMode>>] [--recreate-on-reboot=<<recreateOnReboot>>]

Parameters:

Parameter	Description
`<<containerImageUid>>`	Container Image UID

Options:

Option	Description	Default
`--apps, -ap`	Container applications (comma-separated)
`--app-settings, -as`	App settings as name=value pairs (comma-separated)
`--env-vars, -ev`	Environment variables as name=value pairs (comma-separated)
`--ports, -pt`	Ports (comma-separated)
`--volumes, -vol`	Volumes (comma-separated)
`--cmd, -c`	Command (comma-separated)
`--options, -opt`	Options (comma-separated)
`--network-mode, -nm`	Network mode	`0`
`--recreate-on-reboot, -rbt`	Recreate on reboot	`false`

rh ci update-scripts¶

Update container image startup scripts

rh ci update-scripts <<containerImageUid>> [--startup-scripts=<<startupScriptUids>>] [--inline-scripts=<<inlineScripts>>] [--recreate-on-reboot=<<recreateOnReboot>>]

Parameters:

Parameter	Description
`<<containerImageUid>>`	Container Image UID

Options:

Option	Description	Default
`--startup-scripts, -ss`	Startup script UIDs (comma-separated)
`--inline-scripts, -is`	Inline scripts as process:script:binary (semicolon-separated)
`--recreate-on-reboot, -rbt`	Recreate on reboot	`false`

rh classroom¶

Manage classrooms

Subcommands:

assign-manager — Assign managers to organization
create — Create a classroom
delete — Delete a classroom
delete-instances — Delete classroom formation instances (cpoc)
launch — Launch a classroom
ls — List classrooms
ls-accounts — List cloud accounts linked to a classroom
ls-instances — List classroom formation instances (cpoc)
reboot — Reboot classrooms
set-billing-code — Set billing code for a classroom
set-perspective — Set default perspective for a classroom
shutdown — Shutdown a classroom
start — Start a classroom
stop — Stop a classroom

rh classroom assign-manager¶

Assign managers to organization

rh classroom assign-manager <<organizationName>> --admin-role=<<adminRole>> [--admins=<<adminLogins>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<organizationName>>`	name

Options:

Option	Description	Default
`--admin-role, -ar`	manager roles: CPOC, ADMIN, SU
`--admins, -A`	admin logins
`--replace, -rep`	replace	`false`

rh classroom create¶

Create a classroom

rh classroom create --name=<<name>> [--label=<<label>>] [--desc=<<description>>] [--file=<<filename>>] --archetype=<<archetype>> [--classroomstorage=<<classroomStorageUid>>] [--participantsstorage=<<participantsStorageUid>>] [--rcai=<<classroomRootCloudAccountUid>>] [--budget=<<budgetByParticipant>>] [--nontransient=<<nonTransientParticipants>>] [--createaccount=<<cloudAccountPerParticipant>>] [--participantkeys=<<useParticipantsKeySets>>] [--keys=<<classroomKeySetUid>>] --container=<<containerImageUids>> --capacity=<<capacityId>> --apps=<<apps>> --formation=<<formationUids>>

Options:

Option	Description	Default
`--name, -n`	classroom name
`--label, -l`	label
`--desc, -d`	description
`--file, -fi`	participants file path
`--archetype, -c`	archetype
`--classroomstorage, -cs`	classroom storage uid
`--participantsstorage, -ps`	participants storage uid
`--rcai, -rc`	root cloud account uid
`--budget, -b`	budget per participant
`--nontransient, -nt`	transient participants	`false`
`--createaccount, -cr`	cloud account per participant	`false`
`--participantkeys, -pk`	use participtants keys	`false`
`--keys, -k`	classroom key set uid
`--container, -ci`	container image name
`--capacity, -t`	instance capacity
`--apps, -ap`	Apps
`--formation, -fm`	formation uid

rh classroom delete¶

Delete a classroom

rh classroom delete <<classroomUids>> [--delete-formations=<<deletFormations>>] [--delete-containerimages=<<deleteContainerImages>>] [--delete-classroom-storage=<<deleteClassroomStorage>>] [--delete-participants-storage=<<deleteParticipantsStorage>>]

Parameters:

Parameter	Description
`<<classroomUids>>`	classroom names

Options:

Option	Description	Default
`--delete-formations, -df`		`false`
`--delete-containerimages, -dci`		`false`
`--delete-classroom-storage, -dcs`		`false`
`--delete-participants-storage, -dps`		`false`

rh classroom delete-instances¶

Delete classroom formation instances (cpoc)

rh classroom delete-instances <<classroomUid>>

Parameters:

Parameter	Description
`<<classroomUid>>`	Classroom UID

rh classroom launch¶

Launch a classroom

rh classroom launch <<classroomUid>>

Parameters:

Parameter	Description
`<<classroomUid>>`	classroom uid

rh classroom ls¶

List classrooms

rh classroom ls [--filter=<<filter>>] [--includeresources=<<includeResources>>] [--include-managers=<<includeManagers>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`
`--includeresources, -ir`		`false`
`--include-managers, -im`		`false`
`--set, -v`	assign command result to variable

rh classroom ls-accounts¶

List cloud accounts linked to a classroom

rh classroom ls-accounts <<classroomName>> [--set=<<varName>>]

Parameters:

Parameter	Description
`<<classroomName>>`	Classroom name

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh classroom ls-instances¶

List classroom formation instances (cpoc)

rh classroom ls-instances <<classroomUid>>

Parameters:

Parameter	Description
`<<classroomUid>>`	Classroom UID

rh classroom reboot¶

Reboot classrooms

rh classroom reboot <<classroomUid>>

Parameters:

Parameter	Description
`<<classroomUid>>`	classroom uid

rh classroom set-billing-code¶

Set billing code for a classroom

rh classroom set-billing-code <<classroomName>> --billing-code=<<billingCode>> [--purchase-order=<<purchaseOrder>>]

Parameters:

Parameter	Description
`<<classroomName>>`	Classroom name

Options:

Option	Description	Default
`--billing-code, -bc`	Billing code
`--purchase-order, -poo`	Purchase order

rh classroom set-perspective¶

Set default perspective for a classroom

rh classroom set-perspective <<classroomName>> --perspective=<<goldenPerspectiveId>> [--priority=<<priority>>] [--sign-out-users=<<signOutUsers>>] [--hide-customization=<<hideCustomization>>]

Parameters:

Parameter	Description
`<<classroomName>>`	Classroom name

Options:

Option	Description	Default
`--perspective, -pe`	Golden perspective ID
`--priority, -pr`	Perspective priority index	`0`
`--sign-out-users, -so`	Sign out users after change	`false`
`--hide-customization, -hc`	Assign hide customization	`false`

rh classroom shutdown¶

Shutdown a classroom

rh classroom shutdown <<classroomUid>>

Parameters:

Parameter	Description
`<<classroomUid>>`	classroom uid

rh classroom start¶

Start a classroom

rh classroom start <<classroomUid>>

Parameters:

Parameter	Description
`<<classroomUid>>`	classroom uid

rh classroom stop¶

Stop a classroom

rh classroom stop <<classroomUid>>

Parameters:

Parameter	Description
`<<classroomUid>>`	classroom uid

rh cloud¶

Manage clouds

Subcommands:

capacities — List cloud capacities
disk-types — List cloud disk types
ls — List available clouds
ls-regions — List cloud regions

rh cloud capacities¶

List cloud capacities

rh cloud capacities --cloud=<<cloudId>> [--region=<<regionId>>] [--os=<<os>>] [--software=<<preInstalledSoftware>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--cloud, -c`	Cloud ID
`--region, -r`	Region ID
`--os`	Operating system filter
`--software`	Pre-installed software filter
`--set, -v`	Assign command result to variable

rh cloud disk-types¶

List cloud disk types

rh cloud disk-types --cloud=<<cloudId>> [--set=<<varName>>]

Options:

Option	Description	Default
`--cloud, -c`	Cloud ID
`--set, -v`	Assign command result to variable

rh cloud ls¶

List available clouds

rh cloud ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh cloud ls-regions¶

List cloud regions

rh cloud ls-regions --cloud=<<cloudId>> [--set=<<varName>>]

Options:

Option	Description	Default
`--cloud, -c`	Cloud ID
`--set, -v`	Assign command result to variable

rh cloud-account-pool¶

Manage cloud account pools

Subcommands:

add-account — Add cloud accounts to a pool
clone — Clone a cloud account pool
create — Create a cloud account pool
delete — Delete cloud account pools
get-uids — Get cloud account UIDs from pool
ls — List cloud account pools
share — Share a cloud account pool
unshare — Unshare a cloud account pool

rh cloud-account-pool add-account¶

Add cloud accounts to a pool

rh cloud-account-pool add-account <<cloudAccountPoolUid>> --accounts=<<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountPoolUid>>`	Cloud account pool UID

Options:

Option	Description	Default
`--accounts, -ac`	Cloud account UIDs (comma-separated)

rh cloud-account-pool clone¶

Clone a cloud account pool

rh cloud-account-pool clone <<cloudAccountPoolUid>> [--label=<<label>>]

Parameters:

Parameter	Description
`<<cloudAccountPoolUid>>`	Cloud account pool UID

Options:

Option	Description	Default
`--label, -l`	Label for the clone

rh cloud-account-pool create¶

Create a cloud account pool

rh cloud-account-pool create [--label=<<label>>] [--description=<<description>>]

Options:

Option	Description	Default
`--label, -l`	Label
`--description, -desc`	Description

rh cloud-account-pool delete¶

Delete cloud account pools

rh cloud-account-pool delete <<cloudAccountPoolUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<cloudAccountPoolUids>>`	Cloud account pool UIDs

Options:

Option	Description	Default
`--all, -a`	Delete all cloud account pools	`false`

rh cloud-account-pool get-uids¶

Get cloud account UIDs from pool

rh cloud-account-pool get-uids <<poolUid>>

Parameters:

Parameter	Description
`<<poolUid>>`	Pool uid

rh cloud-account-pool ls¶

List cloud account pools

rh cloud-account-pool ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

Share a cloud account pool

rh cloud-account-pool share <<cloudAccountPoolUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--rights=<<rights>>]

Parameters:

Parameter	Description
`<<cloudAccountPoolUid>>`	Cloud account pool UID

Options:

Option	Description	Default
`--tenant, -t`	Tenant
`--tenantType, -p`	Tenant type, u: user, o: organization, g: group, r: role	`u`
`--replace, -d`	Replace	`false`
`--rights, -ri`	Rights (comma-separated)

rh cloud-account-pool unshare¶

Unshare a cloud account pool

rh cloud-account-pool unshare <<cloudAccountPoolUid>>

Parameters:

Parameter	Description
`<<cloudAccountPoolUid>>`	Cloud account pool UID

rh compliance¶

Manage compliance standards and policies

Subcommands:

create — Create a compliance standard
execute — Execute compliance standards on cloud accounts
execute-on-users — Execute compliance standards on users (admin/cpoc)
execute-policies-on-users — Execute Cloud Custodian policies on users (admin/cpoc)
ls — List compliance standards
ls-policies — List Cloud Custodian policies
output — Get compliance policy execution output by cloud accounts
output-detail — Get detailed execution output (including output files)
share — Share a compliance standard
unshare — Unshare a compliance standard

rh compliance create¶

Create a compliance standard

rh compliance create --label=<<label>> [--description=<<description>>]

Options:

Option	Description	Default
`--label, -l`	Compliance standard label
`--description, -d`	Description

rh compliance execute¶

Execute compliance standards on cloud accounts

rh compliance execute [--accounts=<<cloudAccountUids>>] [--portfolios=<<portfolioUids>>] [--regions=<<regionIds>>]

Options:

Option	Description	Default
`--accounts, -ac`	Cloud account UIDs (comma-separated)
`--portfolios, -pf`	Portfolio UIDs (comma-separated)
`--regions, -rg`	Region IDs (comma-separated)

rh compliance execute-on-users¶

Execute compliance standards on users (admin/cpoc)

rh compliance execute-on-users [--portfolios=<<portfolioUids>>]

Options:

Option	Description	Default
`--portfolios, -pf`	Portfolio UIDs (comma-separated)

rh compliance execute-policies-on-users¶

Execute Cloud Custodian policies on users (admin/cpoc)

rh compliance execute-policies-on-users --policies=<<policyUids>>

Options:

Option	Description	Default
`--policies, -po`	Policy UIDs (comma-separated)

rh compliance ls¶

List compliance standards

rh compliance ls [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--all, -a`	Include all (private, shared, public)	`false`
`--private, -u`	Include private	`false`
`--shared, -s`	Include shared	`false`
`--public, -p`	Include public	`false`
`--set, -v`	Assign command result to variable

rh compliance ls-policies¶

List Cloud Custodian policies

rh compliance ls-policies [--resource=<<resource>>] [--policy-type=<<policyType>>] [--compliance-standard=<<complianceStandard>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--resource, -r`	Filter by resource type
`--policy-type, -pt`	Filter by policy type
`--compliance-standard, -cs`	Filter by compliance standard UID
`--set, -v`	Assign command result to variable

rh compliance output¶

Get compliance policy execution output by cloud accounts

rh compliance output [--accounts=<<cloudAccountUids>>] [--managed=<<managed>>] [--policy-uid=<<policyUid>>] [--portfolio-uid=<<portfolioUid>>] [--execution-bundle-uid=<<executionBundleUid>>] [--last-only=<<lastExecutionOnly>>] [--has-resource=<<hasResource>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--accounts, -ac`	Cloud account UIDs
`--managed, -mg`	Use admin (cpoc) API	`false`
`--policy-uid, -po`	Filter by policy UID
`--portfolio-uid, -pf`	Filter by portfolio UID
`--execution-bundle-uid, -eb`	Filter by execution bundle UID
`--last-only, -lo`	Last execution only	`false`
`--has-resource, -hr`	Only executions with resources	`false`
`--set, -v`	Assign command result to variable

rh compliance output-detail¶

Get detailed execution output (including output files)

rh compliance output-detail <<executionUids>> [--managed=<<managed>>] [--include-files=<<includeOutputFiles>>]

Parameters:

Parameter	Description
`<<executionUids>>`	Execution UIDs (comma-separated)

Options:

Option	Description	Default
`--managed, -mg`	Use admin (cpoc) API	`false`
`--include-files, -if`	Include output files	`true`

Share a compliance standard

rh compliance share <<portfolioUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--role=<<roles>>]

Parameters:

Parameter	Description
`<<portfolioUid>>`	Compliance standard (portfolio) UID

Options:

Option	Description	Default
`--tenant, -t`	Tenant
`--tenantType, -p`	Tenant type: u=user, o=organization, g=group, r=role	`u`
`--replace, -d`	Replace existing shares	`false`
`--role, -ro`	Portfolio roles

rh compliance unshare¶

Unshare a compliance standard

rh compliance unshare <<portfolioUid>>

Parameters:

Parameter	Description
`<<portfolioUid>>`	Compliance standard (portfolio) UID

rh config¶

Manage CLI configuration

Subcommands:

get-cloud — Get the current default cloud provider
get-default — Check default connection
get-output — Get the current CLI output format
get-region — Get the current default region
set-cloud — Set the default cloud of the default connection
set-cloud-region — Set the default cloud and region of the default connection
set-default — Set the default RH connection
set-output — Set the output format for the default connection
set-region — Set the default region of the default connection
settings — Show current settings

rh config get-cloud¶

Get the current default cloud provider

rh config get-default¶

Check default connection

rh config get-output¶

Get the current CLI output format

rh config get-region¶

Get the current default region

rh config set-cloud¶

Set the default cloud of the default connection

rh config set-cloud <<cloud>>

Parameters:

Parameter	Description
`<<cloud>>`	cloud, value can be: aws,gcp,azure or all

rh config set-cloud-region¶

Set the default cloud and region of the default connection

rh config set-cloud-region <<cloud>> <<region>>

Parameters:

Parameter	Description
`<<cloud>>`	cloud, value can be: aws,gcp,azure or all
`<<region>>`	region

rh config set-default¶

Set the default RH connection

rh config set-default <<username>>

Parameters:

Parameter	Description
`<<username>>`	Login or connection name to set as default

rh config set-output¶

Set the output format for the default connection

rh config set-output <<output>>

Parameters:

Parameter	Description
`<<output>>`	CLI output format, can be : table, json, yaml or csv

rh config set-region¶

Set the default region of the default connection

rh config set-region <<region>>

Parameters:

Parameter	Description
`<<region>>`	region

rh config settings¶

Show current settings

rh container¶

Manage containers

Subcommands:

commit — Commit container to image
create — Create containers
delete — Delete containers
get — Get container details
log — Get container log
reboot — Reboot containers
recreate — Recreate containers
start — Start containers
state — Get container state
stop — Stop containers

rh container commit¶

Commit container to image

rh container commit <<containerUid>> --image=<<imageName>> [--label=<<label>>]

Parameters:

Parameter	Description
`<<containerUid>>`	Container uid

Options:

Option	Description	Default
`--image, -i`	Image name
`--label, -l`	Label

rh container create¶

Create containers

rh container create <<containerUids>> --image=<<imageName>> [--state=<<containerState>>] [--refresh-config=<<refreshConfig>>]

Parameters:

Parameter	Description
`<<containerUids>>`	Container uids

Options:

Option	Description	Default
`--image, -i`	Container image name
`--state, -s`	Container state
`--refresh-config, -rc`	Refresh configuration	`false`

rh container delete¶

Delete containers

rh container delete <<containerUids>>

Parameters:

Parameter	Description
`<<containerUids>>`	Container uids

rh container get¶

Get container details

rh container get <<containerUid>>

Parameters:

Parameter	Description
`<<containerUid>>`	Container uid

rh container log¶

Get container log

rh container log <<containerUid>>

Parameters:

Parameter	Description
`<<containerUid>>`	Container uid

rh container reboot¶

Reboot containers

rh container reboot <<containerUids>> [--refresh-config=<<refreshConfig>>]

Parameters:

Parameter	Description
`<<containerUids>>`	Container uids

Options:

Option	Description	Default
`--refresh-config, -rc`	Refresh configuration	`false`

rh container recreate¶

Recreate containers

rh container recreate <<containerUids>> [--image=<<imageName>>] [--state=<<containerState>>] [--refresh-config=<<refreshConfig>>]

Parameters:

Parameter	Description
`<<containerUids>>`	Container uids

Options:

Option	Description	Default
`--image, -i`	Container image name
`--state, -s`	Container state
`--refresh-config, -rc`	Refresh configuration	`false`

rh container start¶

Start containers

rh container start <<containerUids>> [--refresh-config=<<refreshConfig>>]

Parameters:

Parameter	Description
`<<containerUids>>`	Container uids

Options:

Option	Description	Default
`--refresh-config, -rc`	Refresh configuration	`false`

rh container state¶

Get container state

rh container state <<containerUid>>

Parameters:

Parameter	Description
`<<containerUid>>`	Container uid

rh container stop¶

Stop containers

rh container stop <<containerUids>>

Parameters:

Parameter	Description
`<<containerUids>>`	Container uids

rh cr¶

Subcommands:

browse — Browse a container repository
create — Create a container repository
credentials — Get container repository credentials
delete — Delete a container repository
ls — List container repositories
share — Share a container repository
unshare — Unshare a container repository

rh cr browse¶

Browse a container repository

rh cr browse <<containerRepositoryUid>> [--duration=<<stsSessionDurationSeconds>>] [--no-selenium=<<noSelenium>>] [--browser-type=<<browserType>>]

Parameters:

Parameter	Description
`<<containerRepositoryUid>>`	Container Repository Uid

Options:

Option	Description	Default
`--duration, -d`	session duration in seconds
`--no-selenium, -n`	no selenium	`false`
`--browser-type, -t`	Browser type (chrome\|firefox)	`chrome`

rh cr create¶

Create a container repository

rh cr create --archetype=<<archetype>> --name=<<containerRepositoryName>> [--roles=<<containerRepositoryRoles>>] [--registry=<<registryId>>] [--public=<<isPublic>>] [--mutable=<<imageTagMutable>>] [--scan=<<scanOnPush>>] [--encrypt=<<encrypt>>] [--label=<<label>>] [--decription=<<description>>] --keys=<<keySetUid>> --user-name=<<registryUserName>> --user-pwd=<<registryPassword>>

Options:

Option	Description	Default
`--archetype, -c`	archetype
`--name, -n`	Container Repository Name
`--roles, -rr`	Container Repository Roles
`--registry, -rg`	Registry Id
`--public, -p`	Public Repository	`false`
`--mutable, -m`	Image Tage Mutable	`false`
`--scan, -s`	Scan On Push	`false`
`--encrypt, -e`	Encrypt	`false`
`--label, -l`	Label
`--decription, -d`	Description
`--keys, -k`	Key Set Uid
`--user-name, -u`	Registry User Name
`--user-pwd, -pwd`	Registry Password

rh cr credentials¶

Get container repository credentials

rh cr credentials <<containerRepositoryUid>>

Parameters:

Parameter	Description
`<<containerRepositoryUid>>`	Container repository uid

rh cr delete¶

Delete a container repository

rh cr delete <<containerRepositoryUids>> [--destroy=<<destroy>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<containerRepositoryUids>>`	Container Image Uids

Options:

Option	Description	Default
`--destroy, -d`	Destroy
`--all, -a`	Delete all container repositories	`false`

rh cr ls¶

List container repositories

rh cr ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--set=<<varName>>] [--region=<<region>>] [--cloud=<<cloud>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--set, -v`	assign command result to variable
`--region, -r`	Region
`--cloud, -c`	Cloud

Share a container repository

rh cr share <<containerRepositoryUid>> [--roles=<<repositoryRoles>>] --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--clonable=<<cloningAllowed>>]

Parameters:

Parameter	Description
`<<containerRepositoryUid>>`	container repository uid

Options:

Option	Description	Default
`--roles, -ro`	comma separated repository roles	`pull`
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`
`--clonable, -c`	cloning allowed	`false`

rh cr unshare¶

Unshare a container repository

rh cr unshare <<containerRepositoryUid>>

Parameters:

Parameter	Description
`<<containerRepositoryUid>>`	container repository uid

rh cron¶

Manage Cron Tasks

Subcommands:

create — Create Cron Task
delete — Delete Cron Tasks
ls — List Cron Tasks
ls-all — List all scheduled tasks

rh cron create¶

Create Cron Task

rh cron create --schedule-expression=<<scheduleExpression>> --daily-at=<<dailyAt>> [--time-zone=<<timeZone>>] [--label=<<label>>] --eventname=<<eventName>> [--attribute=<<attributes>>] [--task-group=<<taskGroup>>]

Options:

Option	Description	Default
`-se, --schedule-expression`	Schedule expression "(Seconds) (Minutes) (Hours) (Day of month) (Month) (Day of week) (Year)"
`--daily-at, -d`	Executes daily at
`--time-zone, -tz`	Scheduling time zone
`--label, -l`	label
`--eventname, -en`	event name
`--attribute, -attr`	event Attributes
`--task-group, -tg`	Task Group	`default`

rh cron delete¶

Delete Cron Tasks

rh cron delete <<taskUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<taskUids>>`	Cron Task Uids

Options:

Option	Description	Default
`--all, -a`	Delete all cron tasks	`false`

rh cron ls¶

List Cron Tasks

rh cron ls [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Cron tasks filter	`*`
`--set, -v`	assign command result to variable

rh cron ls-all¶

List all scheduled tasks

rh cron ls-all [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	assign command result to variable

rh custodian¶

Manage Cloud Custodian policies

Subcommands:

clone — Clone a Cloud Custodian policy
create — Create Cloud Custodian policies from YAML
delete — Delete Cloud Custodian policies
execute — Execute Cloud Custodian policies
execute-on-users — Execute Cloud Custodian policies on users (admin/cpoc)
ls — List Cloud Custodian policies
output — Get Cloud Custodian policy execution output by cloud accounts
output-detail — Get detailed execution output (including output files)
ping — Ping Cloud Custodian
share — Share Cloud Custodian policy
unshare — Unshare Cloud Custodian policy
update — Update a Cloud Custodian policy

rh custodian clone¶

Clone a Cloud Custodian policy

rh custodian clone <<policyUid>> [--label=<<label>>] [--description=<<description>>]

Parameters:

Parameter	Description
`<<policyUid>>`	Policy UID to clone

Options:

Option	Description	Default
`--label, -l`	Label for the cloned policy
`--description, -d`	Description for the cloned policy

rh custodian create¶

Create Cloud Custodian policies from YAML

rh custodian create --file=<<filePath>>

Options:

Option	Description	Default
`--file, -fi`	Path to YAML file

rh custodian delete¶

Delete Cloud Custodian policies

rh custodian delete <<policyUids>>

Parameters:

Parameter	Description
`<<policyUids>>`	Policy UIDs

rh custodian execute¶

Execute Cloud Custodian policies

rh custodian execute [--accounts=<<cloudAccountUids>>] --policies=<<policyUids>> [--regions=<<regionIds>>]

Options:

Option	Description	Default
`--accounts, -ac`	Cloud account UIDs
`--policies, -po`	Policy UIDs
`--regions, -rg`	Region IDs

rh custodian execute-on-users¶

Execute Cloud Custodian policies on users (admin/cpoc)

rh custodian execute-on-users --policies=<<policyUids>>

Options:

Option	Description	Default
`--policies, -po`	Policy UIDs (comma-separated)

rh custodian ls¶

List Cloud Custodian policies

rh custodian ls [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Policy filter	`*`
`--set, -v`	assign command result to variable

rh custodian output¶

Get Cloud Custodian policy execution output by cloud accounts

rh custodian output [--accounts=<<cloudAccountUids>>] [--managed=<<managed>>] [--policy-uid=<<policyUid>>] [--portfolio-uid=<<portfolioUid>>] [--execution-bundle-uid=<<executionBundleUid>>] [--last-only=<<lastExecutionOnly>>] [--has-resource=<<hasResource>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--accounts, -ac`	Cloud account UIDs
`--managed, -mg`	Use admin (cpoc) API	`false`
`--policy-uid, -po`	Filter by policy UID
`--portfolio-uid, -pf`	Filter by portfolio UID
`--execution-bundle-uid, -eb`	Filter by execution bundle UID
`--last-only, -lo`	Last execution only	`false`
`--has-resource, -hr`	Only executions with resources	`false`
`--set, -v`	Assign command result to variable

rh custodian output-detail¶

Get detailed execution output (including output files)

rh custodian output-detail <<executionUids>> [--managed=<<managed>>] [--include-files=<<includeOutputFiles>>]

Parameters:

Parameter	Description
`<<executionUids>>`	Execution UIDs (comma-separated)

Options:

Option	Description	Default
`--managed, -mg`	Use admin (cpoc) API	`false`
`--include-files, -if`	Include output files	`true`

rh custodian ping¶

Ping Cloud Custodian

rh custodian ping <<cloudAccountUid>>

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account UID

Share Cloud Custodian policy

rh custodian share <<cloudCustodianPolicyUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--allow-clone=<<cloningAllowed>>]

Parameters:

Parameter	Description
`<<cloudCustodianPolicyUid>>`	cloud custodian policy uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`
`--allow-clone, -ac`	cloning allowed	`false`

rh custodian unshare¶

Unshare Cloud Custodian policy

rh custodian unshare <<cloudCustodianPolicyUid>>

Parameters:

Parameter	Description
`<<cloudCustodianPolicyUid>>`	cloud custodian policy uid

rh custodian update¶

Update a Cloud Custodian policy

rh custodian update <<cloudCustodianPolicyUid>> --policy=<<originalPolicy>>

Parameters:

Parameter	Description
`<<cloudCustodianPolicyUid>>`	Cloud Custodian policy UID

Options:

Option	Description	Default
`--policy, -po`	Original policy content (YAML)

rh domain¶

Manage domains

Subcommands:

add-certificate — Create an SSL certificate for a domain
create — Create a domain
delete — Delete domains
get — Get domain details
ls — List domains
retrieve — Retrieve domains from Route53
share — Share domain
unshare — Unshare domain

rh domain add-certificate¶

Create an SSL certificate for a domain

rh domain add-certificate <<domainUid>> [--subdomains=<<subdomains>>] [--key-size=<<keySize>>] --label=<<label>> [--description=<<description>>]

Parameters:

Parameter	Description
`<<domainUid>>`	Domain UID

Options:

Option	Description	Default
`--subdomains, -sd`	Subdomain names
`--key-size, -ks`	Key size in bits	`2048`
`--label, -l`	Label
`--description, -d`	Description

rh domain create¶

Create a domain

rh domain create <<domainName>> [--keys=<<keySetUid>>] [--dns-delay=<<dnsChallengeDelaySec>>] [--subdomain-include=<<subdomainIncludes>>] [--subdomain-exclude=<<subdomainExcludes>>] --label=<<label>> [--description=<<description>>]

Parameters:

Parameter	Description
`<<domainName>>`	Domain name

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--dns-delay, -dd`	DNS challenge delay in seconds	`0`
`--subdomain-include, -si`	Subdomain includes
`--subdomain-exclude, -se`	Subdomain excludes
`--label, -l`	Label
`--description, -d`	Description

rh domain delete¶

Delete domains

rh domain delete <<domainUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<domainUids>>`	Domain uids to delete

Options:

Option	Description	Default
`--all, -a`	Delete all domains	`false`

rh domain get¶

Get domain details

rh domain get <<domainUid>>

Parameters:

Parameter	Description
`<<domainUid>>`	Domain uid

rh domain ls¶

List domains

rh domain ls [--filter=<<filter>>] [--set=<<varName>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>]

Options:

Option	Description	Default
`--filter, -f`	Domain filter
`--set, -v`	assign command result to variable
`--all, -a`	include all domains	`false`
`--private, -u`	include private domains	`false`
`--shared, -s`	include shared domains	`false`
`--public, -p`	include public domains	`false`

rh domain retrieve¶

Retrieve domains from Route53

rh domain retrieve --keys=<<keySetUid>>

Options:

Option	Description	Default
`--keys, -k`	Key set uid

Share domain

rh domain share <<domainUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--max-certs=<<sslCertificateNumberMax>>] [--subdomain-include=<<subdomainIncludes>>] [--subdomain-exclude=<<subdomainExcludes>>]

Parameters:

Parameter	Description
`<<domainUid>>`	domain uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`
`--max-certs, -mc`	ssl certificate number max	`0`
`--subdomain-include, -si`	subdomain includes
`--subdomain-exclude, -se`	subdomain excludes

rh domain unshare¶

Unshare domain

rh domain unshare <<domainUid>>

Parameters:

Parameter	Description
`<<domainUid>>`	domain uid

rh email-template¶

Manage email templates

Subcommands:

create — Create an email template
delete — Delete email templates
get — Get email template details
ls — List email templates
share — Share an email template

rh email-template create¶

Create an email template

rh email-template create --subject=<<subject>> --body=<<body>> [--responses=<<responses>>] --label=<<label>> [--description=<<description>>]

Options:

Option	Description	Default
`--subject, -s`	Email subject
`--body, -b`	Email body (HTML)
`--responses, -r`	Response options
`--label, -l`	Label
`--description, -d`	Description

rh email-template delete¶

Delete email templates

rh email-template delete <<templateUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<templateUids>>`	Email template uids

Options:

Option	Description	Default
`--all, -a`	Delete all email templates	`false`

rh email-template get¶

Get email template details

rh email-template get <<emailTemplateUid>>

Parameters:

Parameter	Description
`<<emailTemplateUid>>`	Email template uid

rh email-template ls¶

List email templates

rh email-template ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

Share an email template

rh email-template share <<emailTemplateUid>> --users=<<users>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<emailTemplateUid>>`	Email template UID

Options:

Option	Description	Default
`--users, -u`	Users to share with
`--replace, -d`	Replace existing shares	`false`

rh encryption-key¶

Manage encryption keys

Subcommands:

create — Create an encryption key
delete — Delete encryption keys
ls — List encryption keys
retrieve — Retrieve encryption keys from cloud
share — Share encryption key
unshare — Unshare encryption key

rh encryption-key create¶

Create an encryption key

rh encryption-key create [--keys=<<keySetUid>>] --label=<<label>> [--description=<<description>>]

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--label, -l`	Label
`--description, -d`	Description

rh encryption-key delete¶

Delete encryption keys

rh encryption-key delete <<encryptionKeyUids>> [--destroy=<<destroy>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<encryptionKeyUids>>`	Encryption key uids to delete

Options:

Option	Description	Default
`--destroy, -D`	Destroy underlying resources	`false`
`--all, -a`	Delete all encryption keys	`false`

rh encryption-key ls¶

List encryption keys

rh encryption-key ls [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Encryption key filter
`--set, -v`	assign command result to variable

rh encryption-key retrieve¶

Retrieve encryption keys from cloud

rh encryption-key retrieve <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

Share encryption key

rh encryption-key share <<encryptionKeyUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--rights=<<rights>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<encryptionKeyUid>>`	encryption key uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--rights, -ri`	rights	`r`
`--replace, -d`	replace	`false`

rh encryption-key unshare¶

Unshare encryption key

rh encryption-key unshare <<encryptionKeyUid>>

Parameters:

Parameter	Description
`<<encryptionKeyUid>>`	encryption key uid

rh engine¶

Manage engines

Subcommands:

add-to-pool — Add an engine to a pool
borrow — Borrow an engine from pool
browse — Connect to an engine in the browser
commit — Commit engine to a machine image
connection-urls — Get connection URLs for an engine
container-urls — Get engine URLs for a container
dcv — Get DCV connection info for an engine
delete — Delete engines
engine-settings — Get engine settings
engine-urls — Get engine URLs for a machine instance
hpc-dcv — Get DCV connection URL for HPC cluster
kill — Kill an engine
label — Update machine label
linked-dcv — Get DCV connection for linked cluster
linked-password — Get Windows password for linked cluster
linked-private-key — Get private key for linked cluster
linked-rdp — Get RDP connection for linked cluster
ls — List engines
private-key — Get private key for an engine
rdp — Get RDP connection info for an engine
reboot — Reboot engine instances
refresh-config — Refresh machine instance configuration
release — Release an engine
reset-engine-pool — Reset an engine pool
retrieve — Retrieve private engines from cloud
return — Return an engine to pool
script-outputs — Get startup script outputs for an engine
settings — Get engine machine instance settings
share — Share an engine
shutdown — Shutdown engines
snapshot — Create a machine image from a running engine
start — Start engine instances
stop — Stop engine instances
windows-password — Get Windows password for an engine

rh engine add-to-pool¶

Add an engine to a pool

rh engine add-to-pool <<engineUid>> --pool=<<enginePoolUid>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine UID

Options:

Option	Description	Default
`--pool, -pl`	Engine pool UID

rh engine borrow¶

Borrow an engine from pool

rh engine borrow <<enginePoolUid>>

Parameters:

Parameter	Description
`<<enginePoolUid>>`	Engine pool UID

rh engine browse¶

Connect to an engine in the browser

rh engine browse <<engineUid>> [--default-browser=<<defaultBrowser>>] [--perspective=<<perspective>>] [--full-screen=<<fullScreen>>] [--browser-type=<<browserType>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--default-browser, -d`	Use default browser (faster option but only one engine at a time can be active)	`false`
`--perspective, -p`	Default perspective/app
`--full-screen, -s`	Open perspective in full screen mode	`false`
`--browser-type, -t`	Browser type (chrome\|firefox)	`chrome`

rh engine commit¶

Commit engine to a machine image

rh engine commit <<engineUid>> --label=<<label>> [--root-volume-size=<<rootVolumeSizeGb>>] [--shutdown-on-success=<<shutdownOnSuccess>>] [--no-formation-update=<<noFormationUpdate>>] [--update-all-formations=<<updateAllDependentFormationsOnSuccess>>] [--reset-win-password=<<resetWindowsPassword>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--label, -l`	Label for the machine image to create
`--root-volume-size, -v`	a new size in Gb for the machine image root disk	`0`
`--shutdown-on-success, -s`	shutdown on success	`false`
`--no-formation-update, -nof`	Formation of the current engine is updated with the new machine image on success, this option disables such update	`false`
`--update-all-formations, -ua`	update all dependent formations on success	`false`
`--reset-win-password, -rw`	Reset Windows password	`false`

rh engine connection-urls¶

Get connection URLs for an engine

rh engine connection-urls <<engineUid>> [--perspective=<<perspectiveId>>] [--full-screen=<<fullScreen>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--perspective, -p`	Perspective id
`--full-screen, -s`	Full screen mode	`false`

rh engine container-urls¶

Get engine URLs for a container

rh engine container-urls <<containerUid>> [--perspective=<<perspectiveId>>] [--full-screen=<<fullScreen>>]

Parameters:

Parameter	Description
`<<containerUid>>`	Container uid

Options:

Option	Description	Default
`--perspective`	Perspective id
`--full-screen`	Full screen mode	`false`

rh engine dcv¶

Get DCV connection info for an engine

rh engine dcv <<engineUid>> [--file=<<outputFile>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--file, -o`	Write .dcv connection file to this path

rh engine delete¶

Delete engines

rh engine delete <<engineUids>>

Parameters:

Parameter	Description
`<<engineUids>>`	Engine uid

rh engine engine-settings¶

Get engine settings

rh engine engine-settings <<engineUid>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

rh engine engine-urls¶

Get engine URLs for a machine instance

rh engine engine-urls <<engineUid>> [--perspective=<<perspectiveId>>] [--full-screen=<<fullScreen>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--perspective`	Perspective id
`--full-screen`	Full screen mode	`false`

rh engine hpc-dcv¶

Get DCV connection URL for HPC cluster

rh engine hpc-dcv <<engineUid>> [--container-index=<<containerIndex>>] [--cluster-index=<<clusterIndex>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--container-index`		`0`
`--cluster-index`		`0`

rh engine kill¶

Kill an engine

rh engine kill <<engineUid>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

rh engine label¶

Update machine label

rh engine label <<engineUid>> --label=<<label>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--label, -l`

rh engine linked-dcv¶

Get DCV connection for linked cluster

rh engine linked-dcv <<engineUid>> [--file=<<outputFile>>] [--container-index=<<containerIndex>>] [--cluster-index=<<clusterIndex>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--file, -o`	Write .dcv connection file to this path
`--container-index`		`0`
`--cluster-index`		`0`

rh engine linked-password¶

Get Windows password for linked cluster

rh engine linked-password <<engineUid>> [--container-index=<<containerIndex>>] [--cluster-index=<<clusterIndex>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--container-index`		`0`
`--cluster-index`		`0`

rh engine linked-private-key¶

Get private key for linked cluster

rh engine linked-private-key <<engineUid>> [--file=<<outputFile>>] [--container-index=<<containerIndex>>] [--cluster-index=<<clusterIndex>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--file, -o`	Write private key to file (sets chmod 600 on Unix)
`--container-index`		`0`
`--cluster-index`		`0`

rh engine linked-rdp¶

Get RDP connection for linked cluster

rh engine linked-rdp <<engineUid>> [--file=<<outputFile>>] [--container-index=<<containerIndex>>] [--cluster-index=<<clusterIndex>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--file, -o`	Write .rdp connection file to this path
`--container-index`		`0`
`--cluster-index`		`0`

rh engine ls¶

List engines

rh engine ls [--set=<<varName>>] [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--spot=<<spot>>]

Options:

Option	Description	Default
`--set, -v`	assign command result to variable
`--filter, -f`	Engine filter	`*`
`--all, -a`	Include all engines	`false`
`--private, -u`	Include private engines	`false`
`--shared, -s`	Include shared engines	`false`
`--public, -p`	Include public engines	`false`
`--region, -r`	Engine region
`--cloud, -c`	Engine cloud
`--category, -t`	Engine category, can be : all, machine, docker-machine, vlab, hpc or bigdata
`--spot, -o`	Spot engine	`false`

rh engine private-key¶

Get private key for an engine

rh engine private-key <<engineUid>> [--file=<<outputFile>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--file, -o`	Write private key to file (sets chmod 600 on Unix)

rh engine rdp¶

Get RDP connection info for an engine

rh engine rdp <<engineUid>> [--file=<<outputFile>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--file, -o`	Write .rdp connection file to this path

rh engine reboot¶

Reboot engine instances

rh engine reboot <<engineUids>> [--force=<<force>>]

Parameters:

Parameter	Description
`<<engineUids>>`	Engine uids

Options:

Option	Description	Default
`--force, -F`		`false`

rh engine refresh-config¶

Refresh machine instance configuration

rh engine refresh-config <<engineUid>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

rh engine release¶

Release an engine

rh engine release <<engineUid>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine UID

rh engine reset-engine-pool¶

Reset an engine pool

rh engine reset-engine-pool <<enginePoolUid>>

Parameters:

Parameter	Description
`<<enginePoolUid>>`	Engine pool UID

rh engine retrieve¶

Retrieve private engines from cloud

rh engine retrieve <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

rh engine return¶

Return an engine to pool

rh engine return <<engineUid>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine UID

rh engine script-outputs¶

Get startup script outputs for an engine

rh engine script-outputs <<engineUid>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

rh engine settings¶

Get engine machine instance settings

rh engine settings <<engineUid>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Share an engine

rh engine share <<engineUid>> --users=<<users>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

Options:

Option	Description	Default
`--users, -u`	Users to share with
`--replace, -d`	Replace existing shares	`false`

rh engine shutdown¶

Shutdown engines

rh engine shutdown <<engineUids>>

Parameters:

Parameter	Description
`<<engineUids>>`	Engine uid

rh engine snapshot¶

Create a machine image from a running engine

rh engine snapshot <<machineInstanceUid>> [--image-type=<<imageType>>] [--root-volume-size=<<rootVolumeSizeGb>>] [--shutdown=<<shutdownOnSuccess>>] [--update-formation=<<updateOriginiatorFormationOnSuccess>>] [--update-all-formations=<<updateAllDependentFormationsOnSuccess>>] [--reset-windows=<<resetWindowsPassword>>] --label=<<label>>

Parameters:

Parameter	Description
`<<machineInstanceUid>>`	Machine instance UID

Options:

Option	Description	Default
`--image-type, -it`	Image type (0=standard)	`0`
`--root-volume-size, -rvs`	Root volume size in GB (0=same as instance)	`0`
`--shutdown, -sd`	Shutdown instance after snapshot	`false`
`--update-formation, -uf`	Update originator formation on success	`false`
`--update-all-formations, -ua`	Update all dependent formations on success	`false`
`--reset-windows, -rw`	Reset Windows password	`false`
`--label, -l`	Label

rh engine start¶

Start engine instances

rh engine start <<engineUids>>

Parameters:

Parameter	Description
`<<engineUids>>`	Engine uid

rh engine stop¶

Stop engine instances

rh engine stop <<engineUids>> [--force=<<force>>] [--hibernate=<<hibernate>>]

Parameters:

Parameter	Description
`<<engineUids>>`	Engine uid

Options:

Option	Description	Default
`--force, -F`		`false`
`--hibernate, -h`		`false`

rh engine windows-password¶

Get Windows password for an engine

rh engine windows-password <<engineUid>>

Parameters:

Parameter	Description
`<<engineUid>>`	Engine uid

rh engine-pool¶

Manage engine pools

Subcommands:

clone — Clone an engine pool
create — Create an engine pool
delete — Delete engine pools
exists — Check if engine pool exists
ls — List engine pools
share — Share an engine pool
unshare — Unshare an engine pool

rh engine-pool clone¶

Clone an engine pool

rh engine-pool clone <<enginePoolUid>> --label=<<label>>

Parameters:

Parameter	Description
`<<enginePoolUid>>`	Engine pool uid

Options:

Option	Description	Default
`--label, -l`	Label for cloned engine pool

rh engine-pool create¶

Create an engine pool

rh engine-pool create [--label=<<label>>] [--description=<<description>>] [--exclusive=<<exclusive>>] [--perspective-id=<<perspectiveId>>] [--container-index=<<containerIndex>>] [--proxy-managed=<<proxyManaged>>]

Options:

Option	Description	Default
`--label, -l`	label
`--description, -d`	description
`--exclusive, -ex`	exclusive	`false`
`--perspective-id, -pid`	perspective id
`--container-index, -ci`	container index	`0`
`--proxy-managed, -pm`	proxy managed	`false`

rh engine-pool delete¶

Delete engine pools

rh engine-pool delete <<enginePoolUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<enginePoolUids>>`	Engine pool uids

Options:

Option	Description	Default
`--all, -a`	Delete all engine pools	`false`

rh engine-pool exists¶

Check if engine pool exists

rh engine-pool exists <<enginePoolUid>>

Parameters:

Parameter	Description
`<<enginePoolUid>>`	Engine pool uid

rh engine-pool ls¶

List engine pools

rh engine-pool ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--set=<<varName>>] [--pool-uid=<<enginePoolUid>>] [--exclusive=<<exclusive>>]

Options:

Option	Description	Default
`--filter, -f`	Engine pool filter	`*`
`--all, -a`	include all items	`false`
`--private, -u`	include private items	`false`
`--shared, -s`	include shared items	`false`
`--public, -p`	include public items	`false`
`--set, -v`	assign command result to variable
`--pool-uid, -pu`	engine pool uid
`--exclusive, -ex`	exclusive

Share an engine pool

rh engine-pool share <<enginePoolUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--rights=<<rights>>] [--max-engines=<<nbEnginesMax>>] [--max-borrow-duration=<<borrowDurationMax>>]

Parameters:

Parameter	Description
`<<enginePoolUid>>`	engine pool uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`
`--rights, -ri`	rights
`--max-engines, -me`	max engines	`0`
`--max-borrow-duration, -mbd`	max borrow duration	`0`

rh engine-pool unshare¶

Unshare an engine pool

rh engine-pool unshare <<enginePoolUid>>

Parameters:

Parameter	Description
`<<enginePoolUid>>`	engine pool uid

rh events¶

Listen in RH real-time events

rh events [--username=<<username>>]

Options:

Option	Description	Default
`--username, -u`

rh federated-image¶

Manage federated images

Subcommands:

delete — Delete federated images
ls — List federated images
share — Share a federated image
sync — Synchronize federated images
unshare — Unshare a federated image

rh federated-image delete¶

Delete federated images

rh federated-image delete <<imageUids>>

Parameters:

Parameter	Description
`<<imageUids>>`	Image UIDs

rh federated-image ls¶

List federated images

rh federated-image ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Filter	`*`
`--all, -a`	Include all	`false`
`--private, -u`	Include private	`false`
`--shared, -s`	Include shared	`false`
`--public, -p`	Include public	`false`
`--set, -v`	Assign command result to variable

Share a federated image

rh federated-image share <<imageUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<imageUid>>`	Image UID

Options:

Option	Description	Default
`--tenant, -t`	Tenant
`--tenantType, -p`	Tenant type, u: user, o: organization, g: group, r: role	`u`
`--replace, -d`	Replace	`false`

rh federated-image sync¶

Synchronize federated images

rh federated-image sync <<cloudAccountUid>>

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account UID

rh federated-image unshare¶

Unshare a federated image

rh federated-image unshare <<imageUid>>

Parameters:

Parameter	Description
`<<imageUid>>`	Image UID

rh federation¶

Federation admin commands

Subcommands:

cleanup-all — Cleanup all owned cloud accounts
cpoc-detect-idle — Detect idle resources on user cloud accounts (CPOC)
cpoc-detect-idle-for-organization — Detect idle resources across an organization (CPOC)
detect-idle — Detect idle resources on cloud accounts (read-only)
get-default-region — Get default region for root cloud account (cpoc)
get-deny-policy — Get deny policy for a root cloud account
get-idle-resource-actions — Get available idle resource actions for an institution
get-institution — Get basic institution info
get-site — Get federated site info
ls-allowed-capacities — List allowed capacities
ls-allowed-regions — List allowed regions
ls-allowed-services — List allowed services
manage-idle — Manage idle resources on cloud accounts (detect and optionally delete)
regenerate-artifacts — Regenerate RosettaHub artifacts on cloud accounts (cpoc)
regenerate-vpc — Regenerate key set VPC on cloud accounts (cpoc)
request-aws-service — Request an AWS service
request-support — Submit a support request
send-email — Send email using template (cpoc)
su-cleanup-all — Cleanup all on cloud accounts (superuser)
su-manage-idle — Manage idle resources on user cloud accounts (superuser)
su-manage-idle-for-organization — Manage idle resources across an organization (superuser)
su-terminate-all — Terminate all instances on cloud accounts (superuser)
update-deny-policy — Update deny policy for a root cloud account

rh federation cleanup-all¶

Cleanup all owned cloud accounts

rh federation cleanup-all <<cloudAccountUids>> [--delete-artifacts=<<deleteArtifacts>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--delete-artifacts`	Delete RosettaHub artifacts	`false`

rh federation cpoc-detect-idle¶

Detect idle resources on user cloud accounts (CPOC)

rh federation cpoc-detect-idle <<userCloudAccountUids>> [--regions=<<regions>>] [--services=<<services>>] [--action-configs=<<actionConfigsJson>>]

Parameters:

Parameter	Description
`<<userCloudAccountUids>>`	User cloud account uids

Options:

Option	Description	Default
`--regions`	AWS regions to scan (default: all allowed regions)
`--services`	Service names to filter (e.g. ec2, rds)
`--action-configs`	JSON with per-action config (nbDays, etc.)

rh federation cpoc-detect-idle-for-organization¶

Detect idle resources across an organization (CPOC)

rh federation cpoc-detect-idle-for-organization <<rootCloudAccountUid>> <<organizationName>> [--regions=<<regions>>] [--services=<<services>>] [--action-configs=<<actionConfigsJson>>]

Parameters:

Parameter	Description
`<<rootCloudAccountUid>>`	Root cloud account UID of the organization
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--regions`	AWS regions to scan (default: all allowed regions)
`--services`	Service names to filter (e.g. ec2, rds)
`--action-configs`	JSON with per-action config (nbDays, etc.)

rh federation detect-idle¶

Detect idle resources on cloud accounts (read-only)

rh federation detect-idle <<cloudAccountUids>> [--regions=<<regions>>] [--services=<<services>>] [--action-configs=<<actionConfigsJson>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--regions`	AWS regions to scan (default: all allowed regions)
`--services`	Service names to filter (e.g. ec2, rds)
`--action-configs`	JSON with per-action config (nbDays, etc.)

rh federation get-default-region¶

Get default region for root cloud account (cpoc)

rh federation get-default-region <<rootCloudAccountUid>>

Parameters:

Parameter	Description
`<<rootCloudAccountUid>>`	Root cloud account uid

rh federation get-deny-policy¶

Get deny policy for a root cloud account

rh federation get-deny-policy <<rootCloudAccountUid>>

Parameters:

Parameter	Description
`<<rootCloudAccountUid>>`	Root cloud account uid

rh federation get-idle-resource-actions¶

Get available idle resource actions for an institution

rh federation get-idle-resource-actions <<institutionId>> <<cloudId>>

Parameters:

Parameter	Description
`<<institutionId>>`	Institution ID
`<<cloudId>>`	Cloud provider ID (aws, azure, gcp, aliyun, openstack)

rh federation get-institution¶

Get basic institution info

rh federation get-site¶

Get federated site info

rh federation ls-allowed-capacities¶

List allowed capacities

rh federation ls-allowed-capacities [--cloud-account=<<cloudAccountUid>>] [--service=<<awsServiceId>>]

Options:

Option	Description	Default
`--cloud-account, -c`	Cloud account uid
`--service, -s`	AWS service id

rh federation ls-allowed-regions¶

List allowed regions

rh federation ls-allowed-services¶

List allowed services

rh federation manage-idle¶

Manage idle resources on cloud accounts (detect and optionally delete)

rh federation manage-idle <<cloudAccountUids>> [--regions=<<regions>>] [--services=<<services>>] [--preserve-data=<<preserveData>>] [--action-configs=<<actionConfigsJson>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--regions`	AWS regions to scan (default: all allowed regions)
`--services`	Service names to filter (e.g. ec2, rds)
`--preserve-data`	Force createSnapshot=true on all actions	`false`
`--action-configs`	JSON with per-action config (nbDays, deleteEnabled, createSnapshot)

rh federation regenerate-artifacts¶

Regenerate RosettaHub artifacts on cloud accounts (cpoc)

rh federation regenerate-artifacts <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

rh federation regenerate-vpc¶

Regenerate key set VPC on cloud accounts (cpoc)

rh federation regenerate-vpc <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

rh federation request-aws-service¶

Request an AWS service

rh federation request-aws-service <<awsServiceId>>

Parameters:

Parameter	Description
`<<awsServiceId>>`	AWS service id

rh federation request-support¶

Submit a support request

rh federation request-support --type=<<requestType>> --message=<<message>>

Options:

Option	Description	Default
`--type, -t`	Request type
`--message, -m`	Support message

rh federation send-email¶

Send email using template (cpoc)

rh federation send-email --template=<<emailTemplateUid>> [--bcc-me=<<bccMe>>]

Options:

Option	Description	Default
`--template, -t`	Email template uid
`--bcc-me`	BCC yourself on the email	`false`

rh federation su-cleanup-all¶

Cleanup all on cloud accounts (superuser)

rh federation su-cleanup-all <<cloudAccountUids>> [--delete-artifacts=<<deleteArtifacts>>]

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

Options:

Option	Description	Default
`--delete-artifacts`	Delete RosettaHub artifacts	`false`

rh federation su-manage-idle¶

Manage idle resources on user cloud accounts (superuser)

rh federation su-manage-idle <<userCloudAccountUids>> [--regions=<<regions>>] [--services=<<services>>] [--preserve-data=<<preserveData>>] [--action-configs=<<actionConfigsJson>>]

Parameters:

Parameter	Description
`<<userCloudAccountUids>>`	User cloud account uids

Options:

Option	Description	Default
`--regions`	AWS regions to scan (default: all allowed regions)
`--services`	Service names to filter (e.g. ec2, rds)
`--preserve-data`	Force createSnapshot=true on all actions	`false`
`--action-configs`	JSON with per-action config (nbDays, deleteEnabled, createSnapshot)

rh federation su-manage-idle-for-organization¶

Manage idle resources across an organization (superuser)

rh federation su-manage-idle-for-organization <<rootCloudAccountUid>> <<organizationName>> [--regions=<<regions>>] [--services=<<services>>] [--preserve-data=<<preserveData>>] [--action-configs=<<actionConfigsJson>>]

Parameters:

Parameter	Description
`<<rootCloudAccountUid>>`	Root cloud account UID of the organization
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--regions`	AWS regions to scan (default: all allowed regions)
`--services`	Service names to filter (e.g. ec2, rds)
`--preserve-data`	Force createSnapshot=true on all actions	`false`
`--action-configs`	JSON with per-action config (nbDays, deleteEnabled, createSnapshot)

rh federation su-terminate-all¶

Terminate all instances on cloud accounts (superuser)

rh federation su-terminate-all <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

rh federation update-deny-policy¶

Update deny policy for a root cloud account

rh federation update-deny-policy <<rootCloudAccountUid>> [--policy=<<denyPolicy>>] [--file=<<policyFile>>]

Parameters:

Parameter	Description
`<<rootCloudAccountUid>>`	Root cloud account uid

Options:

Option	Description	Default
`--policy, -p`	Deny policy string
`--file, -f`	Read deny policy from file

rh file-storage¶

Manage file storages

Subcommands:

create — Create file storage
delete — Delete file storages
get — Get file storage details
ls — List file storages
retrieve — Retrieve file storages from cloud
share — Share file storage
unshare — Unshare file storage
update — Update a file storage

rh file-storage create¶

Create file storage

rh file-storage create [--type=<<storageType>>] [--keys=<<keySetUid>>] [--capacity=<<storageCapacity>>] [--folder=<<folderPath>>] [--mount=<<defaultMountPoint>>] --label=<<label>> [--description=<<description>>] [--encrypt=<<encrypt>>] [--encryption-key=<<encryptionKeyUid>>]

Options:

Option	Description	Default
`--type, -t`	storage type
`--keys, -k`	key set uid
`--capacity, -c`	storage capacity
`--folder, -fo`	folder path	`/`
`--mount, -m`	default mount point
`--label, -l`	label
`--description, -d`	description
`--encrypt, -en`	encrypt storage	`false`
`--encryption-key, -ek`	encryption key uid

rh file-storage delete¶

Delete file storages

rh file-storage delete <<fileStorageUids>> [--destroy=<<destroy>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<fileStorageUids>>`	File storage uids to delete

Options:

Option	Description	Default
`--destroy, -D`	Destroy underlying resources	`false`
`--all, -a`	Delete all file storages	`false`

rh file-storage get¶

Get file storage details

rh file-storage get <<fileStorageUid>>

Parameters:

Parameter	Description
`<<fileStorageUid>>`	File storage uid

rh file-storage ls¶

List file storages

rh file-storage ls [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	File storage filter
`--set, -v`	assign command result to variable

rh file-storage retrieve¶

Retrieve file storages from cloud

rh file-storage retrieve <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

Share file storage

rh file-storage share <<fileStorageUid>> [--rights=<<rights>>] [--folder=<<folderPath>>] [--login=<<appendTenantLoginToFolderPath>>] --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<fileStorageUid>>`	file storage uid

Options:

Option	Description	Default
`--rights, -ri`	rights	`r`
`--folder, -fo`	folder path	`/`
`--login, -lg`	append tenant login to folder path	`false`
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`

rh file-storage unshare¶

Unshare file storage

rh file-storage unshare <<fileStorageUid>>

Parameters:

Parameter	Description
`<<fileStorageUid>>`	file storage uid

rh file-storage update¶

Update a file storage

rh file-storage update <<fileStorageUid>> [--folder=<<folderPath>>] [--mount-point=<<defaultMountPoint>>]

Parameters:

Parameter	Description
`<<fileStorageUid>>`	File storage UID

Options:

Option	Description	Default
`--folder, -fo`	Folder path
`--mount-point, -mp`	Default mount point

rh formation¶

Manage formations

Subcommands:

clone — Clone formation
configure — Configure formation
configure-container — Configure container-level options for a formation
configure-engine — Configure engine options for a formation container
configure-lifecycle — Configure lifecycle and auto-stop options for a formation
configure-machine — Configure machine-level launch options for a formation
configure-network — Configure network and monitoring options for a formation
configure-session — Configure session server options for a formation
configure-sharing — Configure sharing and engine pool options for a formation
create-cf — Create a CloudFormation formation
create-cf-advanced — Create a CloudFormation formation from JSON config
create-emr — Create an EMR Cluster formation
create-hpc — Create an HPC Cluster formation
create-machine — Create a Machine formation
create-machine-pool — Create a Machine Pool formation
create-spark — Create a Spark Cluster formation
create-spot-machine — Create a Spot Machine formation
create-spot-machine-pool — Create a Spot Machine Pool formation
create-terraform — Create a Terraform formation
create-virtuallab — Create a Virtual Lab formation
delete — Delete RosettaHub Formations
delete-instances — Delete all machine instances of a formation
delete-sharees — Delete formation on shared users
launch — Launch a formation
launch-pool — Launch a formation pool
launch-sharees — Launch formation on shared users
ls — List Formations
ls-cf — List CloudFormation Formations
ls-emr — List EMR Cluster Formations
ls-hpc — List HPC Cluster Formations
ls-machine — List Machine Formations
ls-machine-pool — List Machine Pool Formations
ls-spark — List Spark Cluster Formations
ls-spot-machine — List Spot Machine Formations
ls-spot-machine-pool — List Spot Machine Pool Formations
ls-terraform — List Terraform Formations
ls-virtuallab — List Virtual Lab Formations
reboot — Reboot all machine instances of a formation
reboot-sharees — Reboot formation on shared users
send-session-links — Send formation session links
set-az — Set formation availability zone
set-key — Set formation key set
set-ssl — Set formation SSL certificate
share — Share formation
shutdown — Shutdown (terminate) all machine instances of a formation
shutdown-sharees — Shutdown formation on shared users
start — Start all machine instances of a formation
start-sharees — Start formation on shared users
stop — Stop all machine instances of a formation
stop-sharees — Stop formation on shared users
sync-sharees — Synchronize formation on shared users
unshare — Unshare formation
update — Update formation
update-container-dirs — Update formation container project directories
update-terraform — Update a Terraform formation
update-vlab-basic — Update virtual lab basic settings
view-container-config — View Container Configurations

rh formation clone¶

Clone formation

rh formation clone <<formationUid>> [--label=<<label>>] [--deep=<<deepClone>>] [--spot=<<spot>>] [--pool=<<pool>>] [--key=<<keySetUid>>] [--encrypt=<<encrypt>>] [--ekid=<<encryptionKeyId>>]

Parameters:

Parameter	Description
`<<formationUid>>`

Options:

Option	Description	Default
`--label, -l`	Label for the cloned formation
`--deep, -d`	deep cloning	`false`
`--spot, -s`	spot	`false`
`--pool, -p`	pool	`false`
`--key, -k`	Key Sey Uid (optional)
`--encrypt, -ec`	Encrypt	`false`
`--ekid, -ekid`	Encryption Key Id

rh formation configure¶

Configure formation

rh formation configure <<formationUid>> [--container-index=<<containerIndex>>] [--volume-uid=<<volumeUid>>] [--ref-volume-uids=<<refVolumeUids>>] [--container-image-uids=<<containerImageUids>>] [--container-image-id=<<containerImageId>>] [--container-full-screen=<<containerFullScreen>>] [--container-carousel=<<containerCarousel>>]

Parameters:

Parameter	Description
`<<formationUid>>`

Options:

Option	Description	Default
`--container-index, -index`	Container Index	`-1`
`--volume-uid, -v`	Volume Uid
`--ref-volume-uids, -refv`	Reference Volume Uids
`--container-image-uids, -cuid`	Container Image Uids
`--container-image-id, -ci`	Container Image Id
`--container-full-screen, -fs`	Container Full Screen
`--container-carousel, -cr`	Container Carousel

rh formation configure-container¶

Configure container-level options for a formation

rh formation configure-container <<formationUid>> [--container-index=<<containerIndex>>] [--container-project-dir=<<containerProjectDir>>] [--container-name=<<containerName>>] [--apps=<<apps>>] [--desktop=<<desktop>>] [--vnc-geometry=<<vncGeometry>>] [--vnc-linux-user=<<vncLinuxUser>>] [--vnc-linux-password=<<vncLinuxPassword>>] [--use-tiger-vnc=<<useTigerVnc>>] [--container-perspective-id=<<containerPerspectiveId>>] [--startup-script-uids=<<startupScriptUids>>] [--engine-wait=<<engineWait>>] [--container-image-id=<<containerImageId>>] [--container-image-uids=<<containerImageUids>>] [--pull-from=<<pullFrom>>] [--registry-user=<<registryUserName>>] [--registry-password=<<registryPassword>>] [--skip-image-verification=<<skipImageVerification>>] [--soap-enabled=<<soapEnabled>>] [--squid-enabled=<<squidEnabled>>] [--squid-config=<<squidConfigurationFileContent>>] [--default-document=<<defaultDocument>>] [--engine-policy=<<enginePolicy>>] [--html-root-folder=<<htmlRootFolder>>] [--html-index-file=<<htmlIndexFile>>] [--html-public=<<htmlPublic>>] [--default-user-name=<<defaultUserName>>] [--default-password=<<defaultPassword>>] [--initial-container-status=<<initialContainerStatus>>] [--nfs-enabled=<<nfsEnabled>>] [--smb-enabled=<<smbEnabled>>] [--target-k8s-node-groups=<<targetKubernetesNodeGroupUids>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation UID

Options:

Option	Description	Default
`--container-index, -ci`	Container index (-1 = all containers)	`-1`
`--container-project-dir, -cpd`	Container project directory
`--container-name, -cn`	Container name
`--apps, -ap`	Apps (comma-separated)
`--desktop, -dt`	Desktop environment (e.g. xfce, gnome, kde)
`--vnc-geometry, -vg`	VNC geometry (e.g. 1920x1080)
`--vnc-linux-user, -vu`	VNC Linux user
`--vnc-linux-password, -vp`	VNC Linux password
`--use-tiger-vnc, -tv`	Use TigerVNC
`--container-perspective-id, -pid`	Container perspective ID
`--startup-script-uids, -ss`	Startup script UIDs (comma-separated)
`--engine-wait, -ew`	Engine wait time (seconds)
`--container-image-id, -cid`	Container image ID
`--container-image-uids, -ciu`	Container image UIDs (comma-separated)
`--pull-from, -pf`	Pull image from registry URL
`--registry-user, -ru`	Registry user name
`--registry-password, -rp`	Registry password
`--skip-image-verification, -siv`	Skip image verification
`--soap-enabled, -soap`	Enable SOAP
`--squid-enabled, -sqe`	Enable Squid proxy
`--squid-config, -sqc`	Squid configuration file content
`--default-document, -dd`	Default document
`--engine-policy, -epol`	Engine policy
`--html-root-folder, -hrf`	HTML root folder
`--html-index-file, -hif`	HTML index file
`--html-public, -hpub`	HTML public
`--default-user-name, -du`	Default user name
`--default-password, -dp`	Default password
`--initial-container-status, -ics`	Initial container status
`--nfs-enabled, -nfs`	Enable NFS
`--smb-enabled, -smb`	Enable SMB
`--target-k8s-node-groups, -tkg`	Target Kubernetes node group UIDs (comma-separated)

rh formation configure-engine¶

Configure engine options for a formation container

rh formation configure-engine <<formationUid>> [--container-index=<<containerIndex>>] [--autoload=<<autoload>>] [--autoconnect=<<autoconnect>>] [--create-engines-at-startup=<<createEnginesAtStartup>>] [--in-memory-database=<<inMemoryDatabase>>] [--engine-memory-min=<<engineMemoryMinMegabytes>>] [--engine-memory-max=<<engineMemoryMaxMegabytes>>] [--allowed-ips=<<allowedIps>>] [--email-whitelist=<<emailWhiteList>>] [--email-poll-period=<<emailPollPeriod>>] [--poll-period=<<pollPeriod>>] [--sync=<<sync>>] [--delete-on-sync=<<deleteOnSync>>] [--auto-sync=<<autoSync>>] [--engines-share-working-dir=<<enginesShareWorkingDirectory>>] [--collaborative-rstudio=<<collaborativeRstudioEnabled>>] [--jms-max-connections=<<jmsMaxConnections>>] [--jms-max-frame-size=<<jmsMaxFrameSize>>] [--max-inactivity-duration=<<maxInactivityDuration>>] [--max-inactivity-initial-delay=<<maxInactivityDurationInitalDelay>>] [--mqtt-keep-alive=<<mqttKeepAliveInterval>>] [--mqtt-connect-timeout=<<mqttConnectTimeout>>] [--amq-connect-timeout=<<amqConnectTimeout>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation UID

Options:

Option	Description	Default
`--container-index, -ci`	Container index (-1 = all containers)	`-1`
`--autoload, -al`	Enable autoload
`--autoconnect, -ac`	Enable autoconnect
`--create-engines-at-startup, -ces`	Create engines at startup
`--in-memory-database, -imd`	Use in-memory database
`--engine-memory-min, -emn`	Engine minimum memory (MB)
`--engine-memory-max, -emx`	Engine maximum memory (MB)
`--allowed-ips, -aip`	Allowed IPs
`--email-whitelist, -ewl`	Email whitelist
`--email-poll-period, -epp`	Email poll period (milliseconds)
`--poll-period, -pp`	Poll period (milliseconds)
`--sync, -sy`	Enable sync
`--delete-on-sync, -dos`	Delete on sync
`--auto-sync, -asy`	Enable auto sync
`--engines-share-working-dir, -eswd`	Engines share working directory
`--collaborative-rstudio, -cr`	Enable collaborative RStudio
`--jms-max-connections, -jmc`	JMS max connections
`--jms-max-frame-size, -jmf`	JMS max frame size
`--max-inactivity-duration, -mid`	Max inactivity duration (milliseconds)
`--max-inactivity-initial-delay, -miid`	Max inactivity initial delay (milliseconds)
`--mqtt-keep-alive, -mka`	MQTT keep alive interval (seconds)
`--mqtt-connect-timeout, -mct`	MQTT connect timeout (seconds)
`--amq-connect-timeout, -act`	AMQ connect timeout (seconds)

rh formation configure-lifecycle¶

Configure lifecycle and auto-stop options for a formation

rh formation configure-lifecycle <<formationUid>> [--life-length=<<lifeLengthMilliseconds>>] [--finalize-action=<<finalizeAction>>] [--spot-persistent=<<spotPersistent>>] [--interruption-behavior=<<instanceInterruptionBehavior>>] [--repeat-mode=<<repeatMode>>] [--repeat-from=<<repeatFrom>>] [--snapshot-gpu-only=<<snapshotGpuInstanceTypesOnly>>] [--auto-stop-enabled=<<autoStopEnabled>>] [--auto-stop-idle-seconds=<<autoStopIdleDurationSeconds>>] [--auto-stop-cpu-threshold=<<autoStopCpuThreshold>>] [--auto-stop-action=<<autoStopAction>>] [--send-ready-email=<<sendContainerReadyEmail>>] [--ready-email-subject=<<containerReadyEmailSubject>>] [--ready-email-body=<<containerReadyEmailBody>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation UID

Options:

Option	Description	Default
`--life-length, -ll`	Life length in milliseconds (0 = unlimited)
`--finalize-action, -fa`	Finalize action (0=none, 1=stop, 2=terminate)
`--spot-persistent, -sp`	Spot persistent
`--interruption-behavior, -ib`	Instance interruption behavior (stop, terminate, hibernate)
`--repeat-mode, -rm`	Repeat mode (0=none, 1=repeat)
`--repeat-from, -rf`	Repeat from (cron expression)
`--snapshot-gpu-only, -sgo`	Snapshot GPU instance types only
`--auto-stop-enabled, -ase`	Enable auto-stopper
`--auto-stop-idle-seconds, -asi`	Auto-stop idle duration in seconds
`--auto-stop-cpu-threshold, -asc`	Auto-stop CPU threshold (0.0-1.0)
`--auto-stop-action, -asa`	Auto-stop action (0=none, 1=stop, 2=terminate)
`--send-ready-email, -sre`	Send container ready email
`--ready-email-subject, -res`	Container ready email subject
`--ready-email-body, -reb`	Container ready email body

rh formation configure-machine¶

Configure machine-level launch options for a formation

rh formation configure-machine <<formationUid>> [--ssl-enabled=<<sslEnabled>>] [--root-volume-size=<<rootVolumeSizeGb>>] [--root-volume-type=<<rootVolumeType>>] [--root-volume-iops=<<rootVolumeIops>>] [--root-volume-throughput=<<rootVolumeThroughput>>] [--root-volume-encrypted=<<rootVolumeEncrypted>>] [--root-volume-encryption-key=<<rootVolumeEncryptionKeyUid>>] [--root-volume-delete-on-termination=<<rootVolumeDeleteOnTermination>>] [--use-private-subnet=<<usePrivateSubnet>>] [--use-private-ip=<<usePrivateIp>>] [--hibernate-on-stop=<<hibernateOnStop>>] [--connectivity-mode=<<connectivityMode>>] [--source-ips=<<sourceIps>>] [--squid-source-ips=<<squidSourceIps>>] [--security-groups=<<securityGroups>>] [--additional-security-groups=<<additionalSecurityGroups>>] [--placement-group=<<placementGroup>>] [--agent-version=<<agentVersion>>] [--cluster-agent-version=<<clusteragentVersion>>] [--ssh-user=<<sshUser>>] [--http-proxy=<<httpProxyAddress>>] [--disable-smt=<<disableSimultaneousMultithreading>>] [--nginx-port=<<nginxPort>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation UID

Options:

Option	Description	Default
`--ssl-enabled, -ssl`	Enable SSL
`--root-volume-size, -rvs`	Root volume size in GB
`--root-volume-type, -rvt`	Root volume type (gp2, gp3, io1, io2)
`--root-volume-iops, -rvi`	Root volume IOPS
`--root-volume-throughput, -rvtp`	Root volume throughput
`--root-volume-encrypted, -rve`	Encrypt root volume
`--root-volume-encryption-key, -rvek`	Encryption key UID for root volume
`--root-volume-delete-on-termination, -rvd`	Delete root volume on termination
`--use-private-subnet, -ps`	Use private subnet
`--use-private-ip, -pi`	Use private IP
`--hibernate-on-stop, -hib`	Hibernate on stop
`--connectivity-mode, -cm`	Connectivity mode
`--source-ips, -sip`	Allowed source IPs
`--squid-source-ips, -ssip`	Squid proxy source IPs
`--security-groups, -sg`	Security group IDs (comma-separated)
`--additional-security-groups, -asg`	Additional security group IDs (comma-separated)
`--placement-group, -pg`	Placement group
`--agent-version, -av`	Agent version
`--cluster-agent-version, -cav`	Cluster agent version
`--ssh-user, -su`	SSH user
`--http-proxy, -hp`	HTTP proxy address
`--disable-smt, -dsmt`	Disable simultaneous multithreading
`--nginx-port, -np`	Nginx port

rh formation configure-network¶

Configure network and monitoring options for a formation

rh formation configure-network <<formationUid>> [--network-in-max=<<networkInMaxMegabytes>>] [--network-out-max=<<networkOutMaxMegabytes>>] [--network-threshold-action=<<networkThresholdExceededActionId>>] [--monitoring-enabled=<<monitoringEnabled>>] [--monitoring-period=<<monitoringPeriodMillisec>>] [--log-enabled=<<logEnabled>>] [--log-retention-days=<<logRetentionInDays>>] [--log-deletion-policy=<<logDeletionPolicy>>] [--cloud-monitoring-enabled=<<cloudMonitoringEnabled>>] [--cloud-log-enabled=<<cloudLogEnabled>>] [--cloud-log-retention-days=<<cloudLogRetentionInDays>>] [--cloud-log-deletion-policy=<<cloudLogDeletionPolicy>>] [--platform-log-enabled=<<platformLogEnabled>>] [--platform-log-level=<<platformLogLevel>>] [--log-volume=<<logVolumeUid>>] [--config-volume=<<configVolumeUid>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation UID

Options:

Option	Description	Default
`--network-in-max, -ni`	Max network in (MB)
`--network-out-max, -no`	Max network out (MB)
`--network-threshold-action, -nta`	Action when network threshold exceeded (0=none, 1=stop, 2=terminate)
`--monitoring-enabled, -me`	Enable monitoring
`--monitoring-period, -mp`	Monitoring period (milliseconds)
`--log-enabled, -le`	Enable logging
`--log-retention-days, -lr`	Log retention in days
`--log-deletion-policy, -ldp`	Log deletion policy
`--cloud-monitoring-enabled, -cme`	Enable cloud monitoring
`--cloud-log-enabled, -cle`	Enable cloud logging
`--cloud-log-retention-days, -clr`	Cloud log retention in days
`--cloud-log-deletion-policy, -cldp`	Cloud log deletion policy
`--platform-log-enabled, -ple`	Enable platform logging
`--platform-log-level, -pll`	Platform log level
`--log-volume, -lv`	Log volume UID
`--config-volume, -cv`	Config volume UID

rh formation configure-session¶

Configure session server options for a formation

rh formation configure-session <<formationUid>> [--platform-session-enabled=<<platformSessionServerEnabled>>] [--platform-session-timeout=<<platformSessionTimeoutMinutes>>] [--platform-session-method-filters=<<platformSessionMethodNameFilters>>] [--platform-session-tag-filters=<<platformSessionMethodTagFilters>>] [--iam-session-enabled=<<iamSessionServerEnabled>>] [--iam-session-policy=<<iamSessionPolicy>>] [--engine-session-enabled=<<engineSessionServerEnabled>>] [--engine-session-roles=<<engineSessionRoles>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation UID

Options:

Option	Description	Default
`--platform-session-enabled, -pse`	Enable platform session server
`--platform-session-timeout, -pst`	Platform session timeout in minutes
`--platform-session-method-filters, -psmf`	Platform session method name filters (comma-separated)
`--platform-session-tag-filters, -pstf`	Platform session method tag filters (comma-separated)
`--iam-session-enabled, -ise`	Enable IAM session server
`--iam-session-policy, -isp`	IAM session policy
`--engine-session-enabled, -ese`	Enable engine session server
`--engine-session-roles, -esr`	Engine session roles (comma-separated)

Configure sharing and engine pool options for a formation

rh formation configure-sharing <<formationUid>> [--share-with-public=<<shareWithPublic>>] [--sharing-roles=<<sharingRoles>>] [--async-share=<<asynchShare>>] [--engine-pool-uids=<<enginePoolUids>>] [--clone-count=<<cloneCount>>] [--docker-jpy-enabled=<<dockerJpyEnabled>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation UID

Options:

Option	Description	Default
`--share-with-public, -swp`	Share with public
`--sharing-roles, -sr`	Sharing roles (comma-separated)
`--async-share, -as`	Asynchronous sharing
`--engine-pool-uids, -ep`	Engine pool UIDs (comma-separated)
`--clone-count, -cc`	Clone count
`--docker-jpy-enabled, -djpy`	Enable Docker Jupyter

rh formation create-cf¶

Create a CloudFormation formation

rh formation create-cf --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--proxy-capacity=<<proxyCapacityId>>] [--template-machine-image=<<templateMachineImageUid>>] [--template-link=<<templateLink>>] [--template-content=<<templateContent>>] [--input-var=<<inputVars>>] [--output-var=<<outputVars>>] [--post-creation-var=<<postCreationVars>>] [--control-instance-app=<<controlInstanceApps>>] [--control-instance-app-settings=<<controlInstanceAppSettings>>] [--exported-key=<<exportedKeys>>] [--control-instance-ssh-port=<<controlInstanceSshPort>>] [--control-instance-ssh-user=<<controlInstanceSshUserName>>] [--control-instance-os=<<controlInstanceOsName>>] [--cluster-logical-name=<<clusterLogicalName>>] [--wait-for-cluster=<<waitForCluster>>] [--use-private-ips=<<usePrivateIps>>] [--shared-cluster=<<sharedCluster>>] [--add-ssh-users=<<addSshUsers>>] [--category=<<category>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--proxy-capacity, -pc`	Proxy Capacity Id
`--template-machine-image, -tmi`	Template Machine Image Uid
`--template-link, -tl`	Template Link
`--template-content, -tc`	Template Content
`--input-var, -iv`	Input variable (key=value)
`--output-var, -ov`	Output variable (key=value)
`--post-creation-var, -pcv`	Post creation output template variable (key=value)
`--control-instance-app, -cia`	Control instance app
`--control-instance-app-settings, -cias`	Control instance app settings
`--exported-key, -ek`	Exported key
`--control-instance-ssh-port, -csp`	Control instance SSH port	`22`
`--control-instance-ssh-user, -csu`	Control instance SSH user name
`--control-instance-os, -cos`	Control instance OS name
`--cluster-logical-name, -cln`	Cluster logical name
`--wait-for-cluster, -wc`	Wait for cluster	`false`
`--use-private-ips, -upi`	Use private IPs	`false`
`--shared-cluster, -sc`	Shared cluster	`false`
`--add-ssh-users, -asu`	Add SSH users	`false`
`--category, -c`	Category

rh formation create-cf-advanced¶

Create a CloudFormation formation from JSON config

rh formation create-cf-advanced --config=<<configFile>>

Options:

Option	Description	Default
`--config, -c`	JSON config file

rh formation create-emr¶

Create an EMR Cluster formation

rh formation create-emr --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--category=<<category>>] [--cluster-size=<<clusterSize>>] [--master-capacity=<<masterCapacityId>>] [--slave-capacity=<<slaveCapacityId>>] [--accelerator-id=<<acceleratorId>>] [--accelerator-count=<<acceleratorCount>>] [--proxy-capacity=<<proxyCapacityId>>] [--release-label=<<releaseLabel>>] [--applications=<<applications>>] [--cluster-settings=<<clusterSettings>>] [--autoscaling=<<autoscalingEnabled>>] [--initial-cluster-size=<<initialClusterSize>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--category, -c`	Category
`--cluster-size, -csz`	Cluster Size	`1`
`--master-capacity, -mc`	Master Capacity Id
`--slave-capacity, -slc`	Slave Capacity Id
`--accelerator-id, -aid`	Accelerator Id
`--accelerator-count, -acc`	Accelerator Count	`0`
`--proxy-capacity, -pc`	Proxy Capacity Id
`--release-label, -rl`	Release Label
`--applications, -ap`	Applications
`--cluster-settings, -cset`	Cluster Settings
`--autoscaling, -as`	Autoscaling Enabled	`false`
`--initial-cluster-size, -ics`	Initial Cluster Size	`0`

rh formation create-hpc¶

Create an HPC Cluster formation

rh formation create-hpc --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--category=<<category>>] [--cluster-size=<<clusterSize>>] [--master-capacity=<<masterCapacityId>>] [--slave-capacity=<<slaveCapacityId>>] [--accelerator-id=<<acceleratorId>>] [--accelerator-count=<<acceleratorCount>>] [--proxy-capacity=<<proxyCapacityId>>] [--release-label=<<releaseLabel>>] [--applications=<<applications>>] [--scheduler=<<scheduler>>] [--cluster-settings=<<clusterSettings>>] [--autoscaling=<<autoscalingEnabled>>] [--initial-cluster-size=<<initialClusterSize>>] [--cluster-config=<<clusterConfig>>] [--managed-network=<<managedNetwork>>] [--managed-storage=<<managedStorage>>] [--managed-master=<<managedMaster>>] [--managed-slaves=<<managedSlaves>>] [--managed-image=<<managedImage>>] [--cluster-os=<<clusterOs>>] [--master-root-volume-size=<<masterRootVolumeSize>>] [--master-root-volume-type=<<masterRootVolumeType>>] [--slave-root-volume-size=<<slaveRootVolumeSize>>] [--slave-root-volume-type=<<slaveRootVolumeType>>] [--proxy-private-subnet=<<proxyInPrivateSubnet>>] [--master-private-subnet=<<masterInPrivateSubnet>>] [--slaves-private-subnet=<<slavesInPrivateSubnet>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--category, -c`	Category
`--cluster-size, -csz`	Cluster Size	`1`
`--master-capacity, -mc`	Master Capacity Id
`--slave-capacity, -slc`	Slave Capacity Id
`--accelerator-id, -aid`	Accelerator Id
`--accelerator-count, -acc`	Accelerator Count	`0`
`--proxy-capacity, -pc`	Proxy Capacity Id
`--release-label, -rl`	Release Label
`--applications, -ap`	Applications
`--scheduler, -sch`	Scheduler
`--cluster-settings, -cset`	Cluster Settings
`--autoscaling, -as`	Autoscaling Enabled	`false`
`--initial-cluster-size, -ics`	Initial Cluster Size	`0`
`--cluster-config, -ccfg`	Cluster Config
`--managed-network, -mn`	Managed Network	`false`
`--managed-storage, -mst`	Managed Storage	`false`
`--managed-master, -mm`	Managed Master	`false`
`--managed-slaves, -ms`	Managed Slaves	`false`
`--managed-image, -mi`	Managed Image	`false`
`--cluster-os, -cos`	Cluster OS
`--master-root-volume-size, -mrvs`	Master Root Volume Size	`0`
`--master-root-volume-type, -mrvt`	Master Root Volume Type
`--slave-root-volume-size, -srvs`	Slave Root Volume Size	`0`
`--slave-root-volume-type, -srvt`	Slave Root Volume Type
`--proxy-private-subnet, -pps`	Proxy In Private Subnet	`false`
`--master-private-subnet, -mps`	Master In Private Subnet	`false`
`--slaves-private-subnet, -sps`	Slaves In Private Subnet	`false`

rh formation create-machine¶

Create a Machine formation

rh formation create-machine --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--capacity-id=<<capacityId>>] [--accelerator-id=<<acceleratorId>>] [--accelerator-count=<<acceleratorCount>>] [--instances-min=<<instancesCountMin>>] [--instances-max=<<instancesCountMax>>] [--instances-desired=<<instancesCountDesired>>] [--retry-count=<<retryOnFailureCount>>] [--retry-delay=<<retryOnFailureDelayMinutes>>] [--category=<<category>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--capacity-id, -cap`	Capacity Id
`--accelerator-id, -aid`	Accelerator Id
`--accelerator-count, -acc`	Accelerator Count	`0`
`--instances-min, -imin`	Minimum instances count	`1`
`--instances-max, -imax`	Maximum instances count	`1`
`--instances-desired, -id`	Desired instances count	`1`
`--retry-count, -rc`	Retry on failure count	`0`
`--retry-delay, -rd`	Retry on failure delay in minutes	`0`
`--category, -c`	Category

rh formation create-machine-pool¶

Create a Machine Pool formation

rh formation create-machine-pool --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--capacity-id=<<capacityId>>] [--pool-uid=<<poolUid>>] [--autoscaling=<<autoscalingEnabled>>] [--accelerator-id=<<acceleratorId>>] [--accelerator-count=<<acceleratorCount>>] [--instances-min=<<instancesCountMin>>] [--instances-max=<<instancesCountMax>>] [--instances-desired=<<instancesCountDesired>>] [--retry-count=<<retryOnFailureCount>>] [--retry-delay=<<retryOnFailureDelayMinutes>>] [--category=<<category>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--capacity-id, -cap`	Capacity Id
`--pool-uid, -pu`	Pool Uid
`--autoscaling, -as`	Enable autoscaling	`false`
`--accelerator-id, -aid`	Accelerator Id
`--accelerator-count, -acc`	Accelerator Count	`0`
`--instances-min, -imin`	Minimum instances count	`1`
`--instances-max, -imax`	Maximum instances count	`1`
`--instances-desired, -id`	Desired instances count	`1`
`--retry-count, -rc`	Retry on failure count	`0`
`--retry-delay, -rd`	Retry on failure delay in minutes	`0`
`--category, -c`	Category

rh formation create-spark¶

Create a Spark Cluster formation

rh formation create-spark --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--category=<<category>>] [--cluster-size=<<clusterSize>>] [--master-capacity=<<masterCapacityId>>] [--slave-capacity=<<slaveCapacityId>>] [--accelerator-id=<<acceleratorId>>] [--accelerator-count=<<acceleratorCount>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--category, -c`	Category
`--cluster-size, -csz`	Cluster Size	`1`
`--master-capacity, -mc`	Master Capacity Id
`--slave-capacity, -slc`	Slave Capacity Id
`--accelerator-id, -aid`	Accelerator Id
`--accelerator-count, -acc`	Accelerator Count	`0`

rh formation create-spot-machine¶

Create a Spot Machine formation

rh formation create-spot-machine --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--category=<<category>>] [--fallback-to-on-demand=<<fallbackToOnDemand>>] [--capacity-id=<<capacityId>>] [--pool-uid=<<poolUid>>] [--spot-price=<<spotPrice>>] [--persistent=<<persistent>>] [--launch-group=<<launchGroup>>] [--block-duration=<<blockDurationMinutes>>] [--az-group=<<availabilityZoneGroup>>] [--accelerator-id=<<acceleratorId>>] [--accelerator-count=<<acceleratorCount>>] [--instances-min=<<instancesCountMin>>] [--instances-max=<<instancesCountMax>>] [--instances-desired=<<instancesCountDesired>>] [--retry-count=<<retryOnFailureCount>>] [--retry-delay=<<retryOnFailureDelayMinutes>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--category, -c`	Category
`--fallback-to-on-demand, -fod`	Fallback to on-demand	`false`
`--capacity-id, -cap`	Capacity Id
`--pool-uid, -pu`	Pool Uid
`--spot-price, -sp`	Spot Price	`0`
`--persistent, -pe`	Persistent	`false`
`--launch-group, -lg`	Launch Group
`--block-duration, -bd`	Block Duration Minutes	`0`
`--az-group, -azg`	Availability Zone Group
`--accelerator-id, -aid`	Accelerator Id
`--accelerator-count, -acc`	Accelerator Count	`0`
`--instances-min, -imin`	Instances Count Min	`1`
`--instances-max, -imax`	Instances Count Max	`1`
`--instances-desired, -id`	Instances Count Desired	`1`
`--retry-count, -rc`	Retry On Failure Count	`0`
`--retry-delay, -rd`	Retry On Failure Delay Minutes	`0`

rh formation create-spot-machine-pool¶

Create a Spot Machine Pool formation

rh formation create-spot-machine-pool --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--category=<<category>>] [--capacity-id=<<capacityId>>] [--pool-uid=<<poolUid>>] [--autoscaling=<<autoscalingEnabled>>] [--spot-price=<<spotPrice>>] [--persistent=<<persistent>>] [--launch-group=<<launchGroup>>] [--block-duration=<<blockDurationMinutes>>] [--az-group=<<availabilityZoneGroup>>] [--accelerator-id=<<acceleratorId>>] [--accelerator-count=<<acceleratorCount>>] [--instances-min=<<instancesCountMin>>] [--instances-max=<<instancesCountMax>>] [--instances-desired=<<instancesCountDesired>>] [--retry-count=<<retryOnFailureCount>>] [--retry-delay=<<retryOnFailureDelayMinutes>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--category, -c`	Category
`--capacity-id, -cap`	Capacity Id
`--pool-uid, -pu`	Pool Uid
`--autoscaling, -as`	Autoscaling Enabled	`false`
`--spot-price, -sp`	Spot Price	`0`
`--persistent, -pe`	Persistent	`false`
`--launch-group, -lg`	Launch Group
`--block-duration, -bd`	Block Duration Minutes	`0`
`--az-group, -azg`	Availability Zone Group
`--accelerator-id, -aid`	Accelerator Id
`--accelerator-count, -acc`	Accelerator Count	`0`
`--instances-min, -imin`	Instances Count Min	`1`
`--instances-max, -imax`	Instances Count Max	`1`
`--instances-desired, -id`	Instances Count Desired	`1`
`--retry-count, -rc`	Retry On Failure Count	`0`
`--retry-delay, -rd`	Retry On Failure Delay Minutes	`0`

rh formation create-terraform¶

Create a Terraform formation

rh formation create-terraform --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--proxy-capacity=<<proxyCapacityId>>] [--template-machine-image=<<templateMachineImageUid>>] [--template-link=<<templateLink>>] [--template-content=<<templateContent>>] [--input-var=<<inputVars>>] [--output-var=<<outputVars>>] [--post-creation-var=<<postCreationVars>>] [--control-instance-app=<<controlInstanceApps>>] [--control-instance-app-settings=<<controlInstanceAppSettings>>] [--exported-key=<<exportedKeys>>] [--control-instance-ssh-port=<<controlInstanceSshPort>>] [--control-instance-ssh-user=<<controlInstanceSshUserName>>] [--control-instance-os=<<controlInstanceOsName>>] [--cluster-logical-name=<<clusterLogicalName>>] [--wait-for-cluster=<<waitForCluster>>] [--use-private-ips=<<usePrivateIps>>] [--shared-cluster=<<sharedCluster>>] [--add-ssh-users=<<addSshUsers>>] [--category=<<category>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--proxy-capacity, -pc`	Proxy Capacity Id
`--template-machine-image, -tmi`	Template Machine Image Uid
`--template-link, -tl`	Template Link
`--template-content, -tc`	Template Content
`--input-var`	Input variable (key=value)
`--output-var`	Output variable (key=value)
`--post-creation-var`	Post creation output template variable (key=value)
`--control-instance-app`	Control instance app
`--control-instance-app-settings`	Control instance app settings
`--exported-key`	Exported key
`--control-instance-ssh-port`	Control instance SSH port	`22`
`--control-instance-ssh-user`	Control instance SSH user name
`--control-instance-os`	Control instance OS name
`--cluster-logical-name`	Cluster logical name
`--wait-for-cluster`	Wait for cluster	`false`
`--use-private-ips`	Use private IPs	`false`
`--shared-cluster`	Shared cluster	`false`
`--add-ssh-users`	Add SSH users	`false`
`--category, -c`	Category

rh formation create-virtuallab¶

Create a Virtual Lab formation

rh formation create-virtuallab --label=<<label>> [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--availabilityzone=<<availabilityZone>>] [--category=<<category>>] [--proxy-capacity=<<proxyCapacityId>>] [--vlab-image=<<virtualLabMachineImageUid>>] [--vlab-capacity=<<virtualLabCapacityId>>] [--proxy-private-subnet=<<proxyInPrivateSubnet>>] [--vlab-private-subnet=<<virtualLabInPrivateSubnet>>] [--vlab-root-volume-size=<<virtualLabRootVolumeSizeGb>>] [--remote-app=<<remoteApp>>] [--remote-app-dir=<<remoteAppDir>>] [--remote-app-args=<<remoteAppArgs>>] [--accelerator-id=<<acceleratorId>>] [--accelerator-count=<<acceleratorCount>>] [--instances-min=<<instancesCountMin>>] [--instances-max=<<instancesCountMax>>] [--instances-desired=<<instancesCountDesired>>] [--retry-count=<<retryOnFailureCount>>] [--retry-delay=<<retryOnFailureDelayMinutes>>]

Options:

Option	Description	Default
`--label, -l`	Label for the formation
`--key, -k`	Key Set Uid
`--image, -i`	Machine Image Uid
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--availabilityzone, -az`	Availability Zone
`--category, -c`	Category
`--proxy-capacity, -pc`	Proxy Capacity Id
`--vlab-image, -vi`	Virtual Lab Machine Image Uid
`--vlab-capacity, -vc`	Virtual Lab Capacity Id
`--proxy-private-subnet, -pps`	Proxy in private subnet	`false`
`--vlab-private-subnet, -vps`	Virtual Lab in private subnet	`false`
`--vlab-root-volume-size, -vrvs`	Virtual Lab root volume size in GB	`0`
`--remote-app, -ra`	Remote app
`--remote-app-dir, -rad`	Remote app directory
`--remote-app-args, -raa`	Remote app arguments
`--accelerator-id, -aid`	Accelerator Id
`--accelerator-count, -acc`	Accelerator count	`0`
`--instances-min, -imin`	Minimum instances count	`1`
`--instances-max, -imax`	Maximum instances count	`1`
`--instances-desired, -id`	Desired instances count	`1`
`--retry-count, -rc`	Retry on failure count	`0`
`--retry-delay, -rd`	Retry on failure delay in minutes	`0`

rh formation delete¶

Delete RosettaHub Formations

rh formation delete <<formationUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<formationUids>>`	Formation Uids

Options:

Option	Description	Default
`--all, -a`	Delete all formations	`false`

rh formation delete-instances¶

Delete all machine instances of a formation

rh formation delete-instances <<formationUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

rh formation delete-sharees¶

Delete formation on shared users

rh formation delete-sharees <<formationUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

rh formation launch¶

Launch a formation

rh formation launch <<formationUid>> --label=<<label>> [--working-storage=<<workingStorageUid>>] [--working-directory=<<workingDirectory>>] [--reference-storage=<<referenceStorageUids>>] [--parameter=<<parameters>>] [--text-file=<<textFiles>>] [--binary-file=<<binaryFiles>>] [--script-file=<<scriptFiles>>] [--wait-until-running=<<waitUntilRunning>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--label, -l`	Label for the launched instance
`--working-storage, -w`	Working storage uid
`--working-directory, -d`	Working directory
`--reference-storage, -e`	Reference storage uid
`--parameter, -p`	Parameter
`--text-file, -t`	Text file
`--binary-file, -b`	Binary file
`--script-file, -s`	Script file
`--wait-until-running, -g`	Wait until machine instance is ready

rh formation launch-pool¶

Launch a formation pool

rh formation launch-pool <<formationUid>> --label=<<label>> [--count=<<instanceCount>>] [--engine-pool=<<enginePoolUid>>] [--working-storage=<<workingStorageUid>>] [--working-directory=<<workingDirectory>>] [--parameter=<<parameters>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--label, -l`	Label for the launched pool
`--count, -n`	Number of instances to launch	`1`
`--engine-pool, -ep`	Engine pool uid
`--working-storage, -w`	Working storage uid
`--working-directory, -d`	Working directory
`--parameter, -p`	Parameter (key=value)

rh formation launch-sharees¶

Launch formation on shared users

rh formation launch-sharees <<formationUid>> --label=<<label>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--label, -l`	Label for the launched formation

rh formation ls¶

List Formations

rh formation ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--spot=<<spot>>] [--show-rights=<<showRights>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category, can be : all, machine, docker-machine, vlab, hpc or bigdata
`--spot, -o`	spot formation	`false`
`--show-rights`	show rights	`false`
`--set, -v`	assign command result to variable

rh formation ls-cf¶

List CloudFormation Formations

rh formation ls-cf [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation ls-emr¶

List EMR Cluster Formations

rh formation ls-emr [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation ls-hpc¶

List HPC Cluster Formations

rh formation ls-hpc [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation ls-machine¶

List Machine Formations

rh formation ls-machine [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation ls-machine-pool¶

List Machine Pool Formations

rh formation ls-machine-pool [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation ls-spark¶

List Spark Cluster Formations

rh formation ls-spark [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation ls-spot-machine¶

List Spot Machine Formations

rh formation ls-spot-machine [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation ls-spot-machine-pool¶

List Spot Machine Pool Formations

rh formation ls-spot-machine-pool [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation ls-terraform¶

List Terraform Formations

rh formation ls-terraform [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation ls-virtuallab¶

List Virtual Lab Formations

rh formation ls-virtuallab [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--category=<<category>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Formation filter	`*`
`--all, -a`	include all formations	`false`
`--private, -u`	include private formations	`false`
`--shared, -s`	include shared formations	`false`
`--public, -p`	include public formations	`false`
`--region, -r`	formation region
`--cloud, -c`	formation cloud
`--category, -t`	formation category
`--set, -v`	assign command result to variable

rh formation reboot¶

Reboot all machine instances of a formation

rh formation reboot <<formationUid>> [--force=<<force>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--force, -F`	Force reboot	`false`

rh formation reboot-sharees¶

Reboot formation on shared users

rh formation reboot-sharees <<formationUid>> [--force=<<force>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--force, -F`	Force reboot	`false`

rh formation send-session-links¶

Send formation session links

rh formation send-session-links <<formationUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

rh formation set-az¶

Set formation availability zone

rh formation set-az <<formationUid>> --az=<<availabilityZone>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--az, -a`	Availability zone

rh formation set-key¶

Set formation key set

rh formation set-key <<formationUid>> --key=<<keySetUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--key, -k`	Key set uid

rh formation set-ssl¶

Set formation SSL certificate

rh formation set-ssl <<formationUid>> --ssl=<<sslCertificateUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--ssl, -s`	SSL certificate uid

Share formation

rh formation share <<formationUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--allow-keys=<<keySetAccessAllowed>>] [--share-image=<<shareMachineImage>>] [--share-storage=<<shareStorage>>] [--launch-number=<<launchNumber>>] [--allow-clone=<<cloningAllowed>>] [--share-engines=<<shareEnginesWithFormationOwner>>] [--allow-engine-sharing=<<allowEngineSharing>>] [--max-concurrent=<<maxConcurrentInstances>>] [--max-launch=<<maxLaunchCount>>]

Parameters:

Parameter	Description
`<<formationUid>>`	formation uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`
`--allow-keys`	key set access allowed	`false`
`--share-image`	share machine image	`false`
`--share-storage`	share storage	`false`
`--launch-number`	launch number	`1`
`--allow-clone`	cloning allowed	`false`
`--share-engines`	share engines with formation owner	`false`
`--allow-engine-sharing`	allow engine sharing	`false`
`--max-concurrent`	max concurrent instances	`0`
`--max-launch`	max launch count	`0`

rh formation shutdown¶

Shutdown (terminate) all machine instances of a formation

rh formation shutdown <<formationUid>> [--cancel-spot=<<cancelSpotRequest>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--cancel-spot, -cs`	Cancel spot request	`false`

rh formation shutdown-sharees¶

Shutdown formation on shared users

rh formation shutdown-sharees <<formationUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

rh formation start¶

Start all machine instances of a formation

rh formation start <<formationUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

rh formation start-sharees¶

Start formation on shared users

rh formation start-sharees <<formationUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

rh formation stop¶

Stop all machine instances of a formation

rh formation stop <<formationUid>> [--force=<<force>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--force, -F`	Force stop	`false`

rh formation stop-sharees¶

Stop formation on shared users

rh formation stop-sharees <<formationUid>> [--force=<<force>>] [--hibernate=<<hibernate>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--force, -F`	Force stop	`false`
`--hibernate, -h`	Hibernate	`false`

rh formation sync-sharees¶

Synchronize formation on shared users

rh formation sync-sharees <<formationUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

rh formation unshare¶

Unshare formation

rh formation unshare <<formationUid>>

Parameters:

Parameter	Description
`<<formationUid>>`	formation uid

rh formation update¶

Update formation

rh formation update <<formationUid>> [--availabilityzone=<<availabilityZone>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--key=<<keySetUid>>] [--image=<<machineImageUid>>] [--capacity=<<capacityId>>] [--accelerator=<<acceleratorId>>] [--acc-count=<<acceleratorCount>>] [--count-min=<<instancesCountMin>>] [--count-max=<<instancesCountMax>>] [--count-desired=<<instancesCountDesired>>] [--retry-on-failure-count=<<retryOnFailureCount>>] [--retry-on-failure-delay-minutes=<<retryOnFailureDelayMinutes>>] [--spot-price=<<spotPrice>>] [--lab-spot-price=<<labSpotPrice>>] [--persistent=<<persistent>>] [--snapshot=<<snapshotOnTermination>>] [--fallback=<<fallbackToOnDemand>>] [--labimage=<<virtualLabMachineImageUid>>] [--labcapacity=<<virtualLabCapacityId>>] [--privateproxy=<<proxyInPrivateSubnet>>] [--privatelab=<<virtualLabInPrivateSubnet>>] [--labvolumesize=<<virtualLabRootVolumeSizeGb>>] [--remote-app=<<remoteApp>>] [--remote-app-dir=<<remoteAppDir>>] [--remote-app-args=<<remoteAppArgs>>] [--duration=<<blockDurationMinutes>>]

Parameters:

Parameter	Description
`<<formationUid>>`

Options:

Option	Description	Default
`--availabilityzone, -az`	Availability Zone
`--ssl, -s`	Ssl Certificate Uid
`--keypairuid, -kp`	key Pair Uid
`--ipaddressuid, -ip`	ip Address Uid
`--kubernetes-cluster-uid, -kub`	kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	kubernetes Node Group Name
`--key, -k`	Key Sey Uid
`--image, -i`	Machine Image Uid
`--capacity, -c`	Capacity Id
`--accelerator, -acc`	Accelerator Id
`--acc-count, -count`	Accelerator Count
`--count-min, -cmin`	instances Count Min
`--count-max, -cmax`	instances Count Max
`--count-desired, -cd`	instances Count Desired
`--retry-on-failure-count`	retryOnFailureCount
`--retry-on-failure-delay-minutes`	retryOnFailureDelayMinutes
`--spot-price, -sp`	Spot Price
`--lab-spot-price, -lsp`	Lab Spot Price
`--persistent, -pers`	Persistent
`--snapshot, -snap`	Snaphot On Termination
`--fallback, -fb`	Fallback to on demand
`--labimage, -li`	Virtual Lab Machine Image Uid
`--labcapacity, -lc`	Virtual Lab Capacity Id
`--privateproxy, -pp`	Proxy In Private Subnet
`--privatelab, -pl`	Virtual Lab In Private Subnet
`--labvolumesize, -ls`	Virtual Lab Root Volume Size
`--remote-app, -ra`	Remote App
`--remote-app-dir, -rad`	Remote App Directory
`--remote-app-args, -raa`	Remote App Args
`--duration, -d`	Block duration in minutes

rh formation update-container-dirs¶

Update formation container project directories

rh formation update-container-dirs <<formationUid>> [--dir=<<dirs>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--dir, -d`	Project directories

rh formation update-terraform¶

Update a Terraform formation

rh formation update-terraform <<formationUid>> [--key=<<keySetUid>>] [--availabilityzone=<<availabilityZone>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--kubernetes-cluster-uid=<<kubernetesClusterUid>>] [--kubernetes-node-group-name=<<kubernetesNodeGroupName>>] [--image=<<machineImageUid>>] [--proxy-capacity=<<proxyCapacityId>>] [--template-machine-image=<<templateMachineImageUid>>] [--template-link=<<templateLink>>] [--template-content=<<templateContent>>] [--input-var=<<inputVars>>] [--output-var=<<outputVars>>] [--post-creation-var=<<postCreationVars>>] [--control-instance-app=<<controlInstanceApps>>] [--control-instance-app-settings=<<controlInstanceAppSettings>>] [--exported-key=<<exportedKeys>>] [--control-instance-ssh-port=<<controlInstanceSshPort>>] [--control-instance-ssh-user=<<controlInstanceSshUserName>>] [--control-instance-os=<<controlInstanceOsName>>] [--cluster-logical-name=<<clusterLogicalName>>] [--wait-for-cluster=<<waitForCluster>>] [--use-private-ips=<<usePrivateIps>>] [--shared-cluster=<<sharedCluster>>] [--add-ssh-users=<<addSshUsers>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation Uid

Options:

Option	Description	Default
`--key, -k`	Key Set Uid
`--availabilityzone, -az`	Availability Zone
`--ssl, -s`	SSL Certificate Uid
`--keypairuid, -kp`	Key Pair Uid
`--ipaddressuid, -ip`	IP Address Uid
`--kubernetes-cluster-uid, -kub`	Kubernetes Cluster Uid
`--kubernetes-node-group-name, -kng`	Kubernetes Node Group Name
`--image, -i`	Machine Image Uid
`--proxy-capacity, -pc`	Proxy Capacity Id
`--template-machine-image, -tmi`	Template Machine Image Uid
`--template-link, -tl`	Template Link
`--template-content, -tc`	Template Content
`--input-var`	Input variable (key=value)
`--output-var`	Output variable (key=value)
`--post-creation-var`	Post creation output template variable (key=value)
`--control-instance-app`	Control instance app
`--control-instance-app-settings`	Control instance app settings
`--exported-key`	Exported key
`--control-instance-ssh-port`	Control instance SSH port	`0`
`--control-instance-ssh-user`	Control instance SSH user name
`--control-instance-os`	Control instance OS name
`--cluster-logical-name`	Cluster logical name
`--wait-for-cluster`	Wait for cluster	`false`
`--use-private-ips`	Use private IPs	`false`
`--shared-cluster`	Shared cluster	`false`
`--add-ssh-users`	Add SSH users	`false`

rh formation update-vlab-basic¶

Update virtual lab basic settings

rh formation update-vlab-basic <<formationUid>> [--proxy-capacity=<<proxyCapacityId>>] [--lab-capacity=<<labCapacityId>>] [--lab-volume-size=<<labVolumeSize>>]

Parameters:

Parameter	Description
`<<formationUid>>`	Formation uid

Options:

Option	Description	Default
`--proxy-capacity`	Proxy capacity id
`--lab-capacity`	Lab capacity id
`--lab-volume-size`	Lab volume size	`0`

rh formation view-container-config¶

View Container Configurations

rh formation view-container-config <<formationUid>> [--show-all=<<showAll>>]

Parameters:

Parameter	Description
`<<formationUid>>`

Options:

Option	Description	Default
`--show-all, -a`	Show All Fields

rh ftp-storage¶

Manage FTP storages

Subcommands:

create — Create FTP storage
delete — Delete FTP storages
ls — List FTP storages
share — Share FTP storage

rh ftp-storage create¶

Create FTP storage

rh ftp-storage create --host=<<host>> [--port=<<port>>] --login=<<ftpLogin>> --password=<<ftpPassword>> [--folder=<<ftpFolder>>] [--ftps=<<ftps>>] --label=<<label>> [--description=<<description>>] [--rights=<<rights>>] [--check=<<check>>]

Options:

Option	Description	Default
`--host, -ho`	FTP host
`--port, -po`	FTP port	`21`
`--login, -lg`	FTP login
`--password, -pw`	FTP password
`--folder, -fo`	FTP folder	`/`
`--ftps, -ft`	Use FTPS (SSL)	`false`
`--label, -l`	label
`--description, -d`	description
`--rights, -ri`	access rights	`rw`
`--check, -ch`	check FTP connection	`true`

rh ftp-storage delete¶

Delete FTP storages

rh ftp-storage delete <<ftpStorageUids>> [--destroy=<<destroy>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<ftpStorageUids>>`	FTP storage uids to delete

Options:

Option	Description	Default
`--destroy, -D`	Destroy underlying resources	`false`
`--all, -a`	Delete all FTP storages	`false`

rh ftp-storage ls¶

List FTP storages

rh ftp-storage ls [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	FTP storage filter
`--set, -v`	assign command result to variable

Share FTP storage

rh ftp-storage share <<ftpStorageUid>> --users=<<users>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<ftpStorageUid>>`	FTP storage uid

Options:

Option	Description	Default
`--users, -u`	Users to share with
`--replace, -d`	replace	`false`

rh get-cloud¶

Get the current default cloud provider

rh get-default¶

Check default connection

rh get-output¶

Get the current CLI output format

rh get-platform-settings¶

Get platform settings

rh get-region¶

Get the current default region

rh group¶

Manage user groups

Subcommands:

add-managers — Add managers to a group
add-tenants — Add tenants to a group
add-users — Add users to a group
create — Create a user group
delete — Delete user groups
ls — List user groups
members — List members of a group
remove-users — Remove users from a group

rh group add-managers¶

Add managers to a group

rh group add-managers <<userGroupName>> --managers=<<managerLogins>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<userGroupName>>`	Group name

Options:

Option	Description	Default
`--managers, -mg`	Manager logins (comma-separated)
`--replace, -rp`	Replace existing managers	`false`

rh group add-tenants¶

Add tenants to a group

rh group add-tenants <<groupName>> --tenants=<<tenantLogins>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<groupName>>`	Group name

Options:

Option	Description	Default
`--tenants, -t`	Tenant logins
`--replace, -rp`	Replace existing tenants	`false`

rh group add-users¶

Add users to a group

rh group add-users <<groupName>> --users=<<users>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<groupName>>`	Group name

Options:

Option	Description	Default
`--users, -u`	User logins to add
`--replace, -rp`	Replace existing members instead of adding	`false`

rh group create¶

Create a user group

rh group create --name=<<groupName>> [--label=<<label>>] [--description=<<description>>]

Options:

Option	Description	Default
`--name, -n`	Group name
`--label, -l`	Group label
`--description, -d`	Group description

rh group delete¶

Delete user groups

rh group delete <<groupNames>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<groupNames>>`	Group names to delete

Options:

Option	Description	Default
`--all, -a`	Delete all groups	`false`

rh group ls¶

List user groups

rh group ls [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Filter by group name
`--set, -v`	Assign command result to variable

rh group members¶

List members of a group

rh group members <<groupName>>

Parameters:

Parameter	Description
`<<groupName>>`	Group name

rh group remove-users¶

Remove users from a group

rh group remove-users <<groupName>> --users=<<users>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<groupName>>`	Group name

Options:

Option	Description	Default
`--users, -u`	User logins to remove
`--all, -a`	Remove all users from the group	`false`

rh iam-role¶

Manage federated IAM roles

Subcommands:

create — Create a federated IAM role
create-for-service — Create IAM role for a service
delete — Delete federated IAM roles
ls — List federated IAM roles
update-policy — Update IAM role policy
update-trust-policy — Update IAM role trust policy

rh iam-role create¶

Create a federated IAM role

rh iam-role create <<cloudAccountUid>> --name=<<iamRoleName>> [--trust-policy=<<trustPolicy>>] [--role-policy=<<rolePolicy>>] [--label=<<label>>] [--description=<<description>>]

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account uid

Options:

Option	Description	Default
`--name, -n`	IAM role name
`--trust-policy, -tp`	Trust policy
`--role-policy, -rp`	Role policy
`--label, -l`	Label
`--description, -d`	Description

rh iam-role create-for-service¶

Create IAM role for a service

rh iam-role create-for-service <<cloudAccountUid>> --name=<<iamRoleName>> --service=<<serviceName>> [--role-policy=<<rolePolicy>>] [--label=<<label>>] [--description=<<description>>]

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account UID

Options:

Option	Description	Default
`--name, -n`	IAM role name
`--service, -s`	Service name
`--role-policy, -rp`	Role policy
`--label, -l`	Label
`--description, -d`	Description

rh iam-role delete¶

Delete federated IAM roles

rh iam-role delete <<iamRoleUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<iamRoleUids>>`	IAM role uids to delete

Options:

Option	Description	Default
`--all, -a`	Delete all IAM roles	`false`

rh iam-role ls¶

List federated IAM roles

rh iam-role ls [--filter=<<filter>>] [--set=<<varName>>] [--role-uid=<<iamRoleUid>>] [--role-name=<<roleName>>] [--label=<<label>>] [--custom=<<custom>>]

Options:

Option	Description	Default
`--filter, -f`	IAM role filter
`--set, -v`	assign command result to variable
`--role-uid, -ru`	Filter by IAM role uid
`--role-name, -rn`	Filter by role name
`--label, -l`	Filter by label
`--custom, -cu`	Filter by custom flag

rh iam-role update-policy¶

Update IAM role policy

rh iam-role update-policy <<iamRoleUid>> --policy=<<rolePolicy>>

Parameters:

Parameter	Description
`<<iamRoleUid>>`	IAM role uid

Options:

Option	Description	Default
`--policy, -po`	Policy JSON document

rh iam-role update-trust-policy¶

Update IAM role trust policy

rh iam-role update-trust-policy <<iamRoleUid>> --policy=<<trustPolicy>>

Parameters:

Parameter	Description
`<<iamRoleUid>>`	IAM role uid

Options:

Option	Description	Default
`--policy, -po`	Trust policy JSON document

rh iam-user¶

Manage federated IAM users

Subcommands:

create — Create a federated IAM user
create-keys — Create RosettaHub keys from IAM user
delete — Delete federated IAM users
get-sts-keys — Get STS session keys for an IAM user
ls — List federated IAM users
reset-keys — Reset IAM user keys
set-signin-url — Set IAM user signin URL
share — Share a federated IAM user
unshare — Unshare a federated IAM user
update-policy — Update IAM user policy

rh iam-user create¶

Create a federated IAM user

rh iam-user create <<cloudAccountUid>> --name=<<iamUserName>> [--signin-url=<<signinUrl>>] [--policy=<<userPolicy>>] [--label=<<label>>] [--description=<<description>>] [--region=<<defaultRegion>>]

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account uid

Options:

Option	Description	Default
`--name, -n`	IAM user name
`--signin-url, -su`	Sign-in URL
`--policy, -po`	User policy
`--label, -l`	Label
`--description, -d`	Description
`--region, -r`	Default region

rh iam-user create-keys¶

Create RosettaHub keys from IAM user

rh iam-user create-keys <<iamUserUid>> [--region=<<regionId>>]

Parameters:

Parameter	Description
`<<iamUserUid>>`	IAM user UID

Options:

Option	Description	Default
`--region, -r`	Region ID

rh iam-user delete¶

Delete federated IAM users

rh iam-user delete <<iamUserNames>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<iamUserNames>>`	IAM user names

Options:

Option	Description	Default
`--all, -a`	Delete all IAM users	`false`

rh iam-user get-sts-keys¶

Get STS session keys for an IAM user

rh iam-user get-sts-keys <<iamUserUid>> [--duration=<<durationSeconds>>]

Parameters:

Parameter	Description
`<<iamUserUid>>`	IAM user UID

Options:

Option	Description	Default
`--duration, -du`	Duration in seconds	`3600`

rh iam-user ls¶

List federated IAM users

rh iam-user ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--set=<<varName>>] [--user-name=<<userName>>] [--user-uid=<<userUid>>] [--cloud-account=<<cloudAccountUid>>]

Options:

Option	Description	Default
`--filter, -f`	Filter	`*`
`--all, -a`	include all	`false`
`--private, -u`	include private	`false`
`--shared, -s`	include shared	`false`
`--public, -p`	include public	`false`
`--set, -v`	assign command result to variable
`--user-name, -un`	IAM user name filter
`--user-uid, -uu`	IAM user uid filter
`--cloud-account, -ca`	Cloud account uid filter

rh iam-user reset-keys¶

Reset IAM user keys

rh iam-user reset-keys <<iamUserUids>>

Parameters:

Parameter	Description
`<<iamUserUids>>`	IAM user UIDs

Set IAM user signin URL

rh iam-user set-signin-url <<iamUserUid>> --url=<<signinUrl>>

Parameters:

Parameter	Description
`<<iamUserUid>>`	IAM user UID

Options:

Option	Description	Default
`--url, -u`	Signin URL

Share a federated IAM user

rh iam-user share <<iamUserUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--allow-sts-console=<<allowStsConsole>>] [--allow-sts-keys=<<allowStsKeys>>] [--sts-policy=<<stsPolicy>>] [--sts-duration=<<stsSessionDurationSec>>] [--allow-keys=<<allowKeys>>] [--uri=<<uri>>]

Parameters:

Parameter	Description
`<<iamUserUid>>`	IAM user uid

Options:

Option	Description	Default
`--tenant, -t`	Tenant
`--tenantType, -p`	Tenant type, u: user, o: organization, g: group, r: role	`u`
`--replace, -d`	Replace existing shares	`false`
`--allow-sts-console, -asc`	Allow STS console access	`false`
`--allow-sts-keys, -ask`	Allow STS keys	`false`
`--sts-policy, -sp`	STS policy
`--sts-duration, -sd`	STS session duration in seconds	`3600`
`--allow-keys, -ak`	Allow keys	`false`
`--uri, -ur`	URI

rh iam-user unshare¶

Unshare a federated IAM user

rh iam-user unshare <<iamUserUid>>

Parameters:

Parameter	Description
`<<iamUserUid>>`	IAM user uid

rh iam-user update-policy¶

Update IAM user policy

rh iam-user update-policy <<iamUserUid>> --policy=<<userPolicy>>

Parameters:

Parameter	Description
`<<iamUserUid>>`	IAM user uid

Options:

Option	Description	Default
`--policy, -po`	Policy JSON document

rh image¶

Manage Images

Subcommands:

clone — Clone image
configure — Configure a machine image
create — Create an image
delete — Delete images
get — Get machine image details
launch — Create a machine formation from an image and launch it (SimpleLaunch)
ls — List images
retrieve — Retrieve machine images from cloud
share — Share an image
unshare — Unshare an image
update — Update a machine image

rh image clone¶

Clone image

rh image clone <<machineImageUid>> [--keys=<<keySetUid>>] [--label=<<label>>] [--deepclone=<<deepCloning>>] [--encrypt=<<encrypt>>] [--ekid=<<encryptionKeyId>>]

Parameters:

Parameter	Description
`<<machineImageUid>>`	machine image uid

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--label, -l`	Label
`--deepclone, -dc`	Deep cloning	`false`
`--encrypt, -ec`	Encrypt	`false`
`--ekid, -ekid`	Encryption Key Id

rh image configure¶

Configure a machine image

rh image configure <<machineImageUid>> [--capacities=<<capacities>>] [--ports=<<ports>>] [--os-user=<<osUserName>>] [--os-password=<<osUserPassword>>] [--cloud-image-id=<<cloudImageId>>] [--root-volume-size=<<rootVolumeSizeGb>>] [--deep-share=<<deepShare>>]

Parameters:

Parameter	Description
`<<machineImageUid>>`	Machine image UID

Options:

Option	Description	Default
`--capacities, -ca`	Capacity IDs
`--ports, -pt`	Port mappings
`--os-user, -ou`	OS username
`--os-password, -op`	OS password
`--cloud-image-id, -ci`	Cloud image ID
`--root-volume-size, -rvs`	Root volume size in GB	`0`
`--deep-share, -ds`	Enable deep sharing	`false`

rh image create¶

Create an image

rh image create --keys=<<keySetUid>> --image=<<imageId>> --arch=<<osArch>> --os=<<osName>> [--user=<<osUserName>>] [--userpassword=<<osUserPassword>>] [--sshport=<<osSshPort>>] [--ports=<<ports>>] [--label=<<label>>] [--root-only=<<snapshotRootVolumeOnly>>] [--public=<<isPublicImage>>] [--deepshare=<<deepShare>>]

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--image, -i`	Image id
`--arch, -ar`	OS Arch
`--os, -o`	OS Name
`--user, -u`	OS User Name
`--userpassword, -pwd`	OS User Password
`--sshport, -ssh`	OS Ssh Port	`22`
`--ports, -pt`	Ports
`--label, -l`	Label
`--root-only, -ro`	Snapshot root volume only
`--public, -p`	Is Public Image
`--deepshare, -s`	Deep share

rh image delete¶

Delete images

rh image delete <<machineImageUids>> [--destroy=<<deleteCloudImages>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<machineImageUids>>`	Machine Image Uids

Options:

Option	Description	Default
`--destroy, -d`	Delete underlying cloud images	`false`
`--all, -a`	Delete all machine images	`false`

rh image get¶

Get machine image details

rh image get <<machineImageUid>>

Parameters:

Parameter	Description
`<<machineImageUid>>`	Machine image uid

rh image launch¶

Create a machine formation from an image and launch it (SimpleLaunch)

rh image launch <<machineImageUid>> --label=<<label>> [--key=<<keySetUid>>] [--ssl=<<sslCertificateUid>>] [--keypairuid=<<keyPairUid>>] [--ipaddressuid=<<ipAddressUid>>] [--availabilityzone=<<availabilityZone>>] [--capacity-id=<<capacityId>>] [--accelerator-id=<<acceleratorId>>] [--accelerator-count=<<acceleratorCount>>] [--instances=<<instances>>] [--wait-until-running=<<waitUntilRunning>>]

Parameters:

Parameter	Description
`<<machineImageUid>>`	Machine Image UID

Options:

Option	Description	Default
`--label, -l`	Label for the formation and session
`--key, -k`	Key Set UID
`--ssl, -s`	SSL Certificate UID
`--keypairuid, -kp`	Key Pair UID
`--ipaddressuid, -ip`	IP Address UID
`--availabilityzone, -az`	Availability Zone
`--capacity-id, -cap`	Capacity ID
`--accelerator-id, -aid`	Accelerator ID
`--accelerator-count, -acc`	Accelerator count	`0`
`--instances, -n`	Number of instances	`1`
`--wait-until-running, -g`	Wait until machine instance is ready

rh image ls¶

List images

rh image ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Image filter	`*`
`--all, -a`	include all images	`false`
`--private, -u`	include private images	`false`
`--shared, -s`	include shared images	`false`
`--public, -p`	include public images	`false`
`--region, -r`	region
`--cloud, -c`	cloud
`--set, -v`	assign command result to variable

rh image retrieve¶

Retrieve machine images from cloud

rh image retrieve <<keySetUid>> [--tag=<<tag>>]

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

Options:

Option	Description	Default
`--tag, -t`	Image tag filter

Share an image

rh image share <<machineImageUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--clonable=<<cloningAllowed>>]

Parameters:

Parameter	Description
`<<machineImageUid>>`	machine image uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`
`--clonable, -c`	cloning allowed	`false`

rh image unshare¶

Unshare an image

rh image unshare <<machineImageUid>>

Parameters:

Parameter	Description
`<<machineImageUid>>`	machine image uid

rh image update¶

Update a machine image

rh image update <<machineImageUid>> [--label=<<label>>] [--description=<<description>>]

Parameters:

Parameter	Description
`<<machineImageUid>>`	Machine image uid

Options:

Option	Description	Default
`--label, -l`	Label
`--description, -d`	Description

rh ip-address¶

Manage IP addresses

Subcommands:

create — Create an IP address
delete — Delete IP addresses
get — Get IP address details
ls — List IP addresses
retrieve — Retrieve IP addresses from cloud
set-default — Set default IP address
share — Share IP address
unshare — Unshare IP address

rh ip-address create¶

Create an IP address

rh ip-address create <<keySetUid>> [--auto-nic=<<autocreateNetworkInterface>>] [--private-subnet=<<usePrivateSubnet>>] [--az=<<availabilityZone>>] [--label=<<label>>] [--description=<<description>>]

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

Options:

Option	Description	Default
`--auto-nic, -an`	Auto-create network interface	`false`
`--private-subnet, -ps`	Use private subnet	`false`
`--az, -z`	Availability zone
`--label, -l`	Label
`--description, -d`	Description

rh ip-address delete¶

Delete IP addresses

rh ip-address delete <<ipAddressUids>> [--destroy=<<destroy>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<ipAddressUids>>`	IP address uids to delete

Options:

Option	Description	Default
`--destroy, -D`	Destroy the IP address	`false`
`--all, -a`	Delete all IP addresses	`false`

rh ip-address get¶

Get IP address details

rh ip-address get <<ipAddressUid>>

Parameters:

Parameter	Description
`<<ipAddressUid>>`	IP address uid

rh ip-address ls¶

List IP addresses

rh ip-address ls [--filter=<<filter>>] [--set=<<varName>>] [--ip-uid=<<ipAddressUid>>] [--elastic-ip=<<elasticIp>>] [--key-set=<<keySetUid>>] [--instance-id=<<instanceId>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>]

Options:

Option	Description	Default
`--filter, -f`	IP address filter
`--set, -v`	assign command result to variable
`--ip-uid, -iu`	Filter by IP address uid
`--elastic-ip, -eip`	Filter by elastic IP
`--key-set, -ks`	Filter by key set uid
`--instance-id, -iid`	Filter by instance id
`--all, -a`	include all IP addresses	`false`
`--private, -u`	include private IP addresses	`false`
`--shared, -s`	include shared IP addresses	`false`
`--public, -p`	include public IP addresses	`false`

rh ip-address retrieve¶

Retrieve IP addresses from cloud

rh ip-address retrieve <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

rh ip-address set-default¶

Set default IP address

rh ip-address set-default <<ipAddressUid>>

Parameters:

Parameter	Description
`<<ipAddressUid>>`	IP address uid

Share IP address

rh ip-address share <<ipAddressUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--rights=<<rights>>]

Parameters:

Parameter	Description
`<<ipAddressUid>>`	IP address uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`
`--rights, -ri`	rights

rh ip-address unshare¶

Unshare IP address

rh ip-address unshare <<ipAddressUid>>

Parameters:

Parameter	Description
`<<ipAddressUid>>`	IP address uid

rh k8s¶

Manage Kubernetes clusters

Subcommands:

authorize-file-storage — Authorize Kubernetes file storage access
create — Create a Kubernetes cluster
create-autoscaler — Create a Kubernetes cluster autoscaler
create-dashboard — Create a Kubernetes cluster dashboard
delete — Delete Kubernetes clusters
delete-node-groups — Delete Kubernetes node groups
get — Get Kubernetes cluster details
ls — List Kubernetes clusters
node-groups — List Kubernetes node groups
share — Share Kubernetes cluster
unshare — Unshare Kubernetes cluster
versions — List available Kubernetes versions

rh k8s authorize-file-storage¶

Authorize Kubernetes file storage access

rh k8s authorize-file-storage <<kubernetesClusterUid>> --file-storage=<<fileStorageUid>>

Parameters:

Parameter	Description
`<<kubernetesClusterUid>>`	Kubernetes cluster uid

Options:

Option	Description	Default
`--file-storage, -f`	File storage uid

rh k8s create¶

Create a Kubernetes cluster

rh k8s create [--auto-create-drivers=<<autoCreateDrivers>>] [--keys=<<keySetUid>>] --label=<<label>> [--description=<<description>>]

Options:

Option	Description	Default
`--auto-create-drivers, -acd`	Auto create drivers	`false`
`--keys, -k`	Key set uid
`--label, -l`	Label
`--description, -d`	Description

rh k8s create-autoscaler¶

Create a Kubernetes cluster autoscaler

rh k8s create-autoscaler <<kubernetesClusterUid>>

Parameters:

Parameter	Description
`<<kubernetesClusterUid>>`	Kubernetes cluster UID

rh k8s create-dashboard¶

Create a Kubernetes cluster dashboard

rh k8s create-dashboard <<kubernetesClusterUid>>

Parameters:

Parameter	Description
`<<kubernetesClusterUid>>`	Kubernetes cluster UID

rh k8s delete¶

Delete Kubernetes clusters

rh k8s delete <<clusterUids>> [--destroy=<<destroy>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<clusterUids>>`	Kubernetes cluster uids

Options:

Option	Description	Default
`--destroy, -D`	Destroy underlying cloud resources	`false`
`--all, -a`	Delete all Kubernetes clusters	`false`

rh k8s delete-node-groups¶

Delete Kubernetes node groups

rh k8s delete-node-groups <<nodeGroupUids>> [--destroy=<<destroy>>]

Parameters:

Parameter	Description
`<<nodeGroupUids>>`	Kubernetes node group uids

Options:

Option	Description	Default
`--destroy, -D`	Destroy underlying cloud resources	`false`

rh k8s get¶

Get Kubernetes cluster details

rh k8s get <<clusterUid>> [--include-connectivity=<<includeConnectivity>>] [--duration=<<duration>>]

Parameters:

Parameter	Description
`<<clusterUid>>`	Kubernetes cluster uid

Options:

Option	Description	Default
`--include-connectivity, -ic`	Include connectivity information	`false`
`--duration, -d`	Duration in seconds	`3600`

rh k8s ls¶

List Kubernetes clusters

rh k8s ls [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Filter
`--set, -v`	Assign command result to variable

rh k8s node-groups¶

List Kubernetes node groups

rh k8s node-groups [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Filter
`--set, -v`	Assign command result to variable

Share Kubernetes cluster

rh k8s share <<kubernetesClusterUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--rights=<<rights>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<kubernetesClusterUid>>`	Kubernetes cluster uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--rights, -ri`	rights	`r`
`--replace, -d`	replace	`false`

rh k8s unshare¶

Unshare Kubernetes cluster

rh k8s unshare <<kubernetesClusterUid>>

Parameters:

Parameter	Description
`<<kubernetesClusterUid>>`	Kubernetes cluster uid

rh k8s versions¶

List available Kubernetes versions

rh k8s versions [--cloud=<<cloudId>>]

Options:

Option	Description	Default
`--cloud, -c`	Cloud id

rh key¶

Manage RH keys

Subcommands:

create — Create RosettaHub Keys
delete — Delete RosettaHub Keys
get — Get key set details
import-pub-key — Import a public key
ls — List RosettaHub Keys
reset — Reset keys on cloud accounts
reset-vpc — Regenerate VPC for key set
set-default — Set default RosettaHub Keys
share — Share key set
unshare — Unshare key set

rh key create¶

Create RosettaHub Keys

rh key create --acc=<<accountNumber>> --username=<<iamUserName>> --access-key=<<accessKeyId>> --secret-key=<<secretAccessKey>> --region-id=<<regionId>> [--label=<<label>>] [--description=<<description>>] [--cloud=<<cloudId>>] [--capa=<<defaultCapacityId>>]

Options:

Option	Description	Default
`--acc, -ac`	Account Number
`--username, -u`	User name
`--access-key, -key`	Access Key
`--secret-key, -sec`	Secret Access Key
`--region-id, -r`	Region Id
`--label, -l`	Label
`--description, -d`	Description
`--cloud, -c`	Cloud Id
`--capa, -t`	Default Capacity Id

rh key delete¶

Delete RosettaHub Keys

rh key delete <<keySetUids>> [--keep-vpc=<<keepVpc>>] [--delete-iam=<<deleteIam>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<keySetUids>>`	Key Set Uids

Options:

Option	Description	Default
`--keep-vpc, -kvpc`	Keep VPC	`false`
`--delete-iam, -diam`	Delete IAM	`false`
`--all, -a`	Delete all key sets	`false`

rh key get¶

Get key set details

rh key get <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

rh key import-pub-key¶

Import a public key

rh key import-pub-key <<keySetUid>> --name=<<keyName>> --file=<<keyFile>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

Options:

Option	Description	Default
`--name, -n`	Key name
`--file, -f`	Path to public key file

rh key ls¶

List RosettaHub Keys

rh key ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Key filter	`*`
`--all, -a`	include all sessions	`false`
`--private, -u`	include private sessions	`false`
`--shared, -s`	include shared sessions	`false`
`--public, -p`	include public sessions	`false`
`--region, -r`	session region
`--cloud, -c`	session cloud
`--set, -v`	assign command result to variable

rh key reset¶

Reset keys on cloud accounts

rh key reset <<cloudAccountUids>>

Parameters:

Parameter	Description
`<<cloudAccountUids>>`	Cloud account uids

rh key reset-vpc¶

Regenerate VPC for key set

rh key reset-vpc <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

rh key set-default¶

Set default RosettaHub Keys

rh key set-default <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Default Key Set Uid

Share key set

rh key share <<keySetUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--max-machines=<<machineNumberMax>>] [--allow-create-image=<<allowCreateImage>>] [--allow-create-storage=<<allowCreateSimpleStorage>>] [--allow-create-network-storage=<<allowCreateNetworkStorage>>] [--allow-create-block-storage=<<allowCreateBlockStorage>>]

Parameters:

Parameter	Description
`<<keySetUid>>`	key set uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`
`--max-machines, -mm`	machine number max	`0`
`--allow-create-image, -aci`	allow create image	`false`
`--allow-create-storage, -acs`	allow create simple storage	`false`
`--allow-create-network-storage, -acns`	allow create network storage	`false`
`--allow-create-block-storage, -acbs`	allow create block storage	`false`

rh key unshare¶

Unshare key set

rh key unshare <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	key set uid

rh key-pair¶

Manage cloud key pairs

Subcommands:

create — Create a key pair
delete — Delete key pairs
ls — List key pairs
retrieve — Retrieve key pairs from a key set

rh key-pair create¶

Create a key pair

rh key-pair create <<keySetUid>> --name=<<keyPairName>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

Options:

Option	Description	Default
`--name, -n`	Key pair name

rh key-pair delete¶

Delete key pairs

rh key-pair delete <<keyPairUids>> [--destroy=<<destroy>>]

Parameters:

Parameter	Description
`<<keyPairUids>>`	Key pair uids to delete

Options:

Option	Description	Default
`--destroy, -D`	Destroy key pairs permanently	`false`

rh key-pair ls¶

List key pairs

rh key-pair ls [--filter=<<filter>>] [--set=<<varName>>] [--key-name=<<keyName>>] [--key-pair-uid=<<keyPairUid>>] [--key-set=<<keySetUid>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>]

Options:

Option	Description	Default
`--filter, -f`	Key pair filter
`--set, -v`	assign command result to variable
`--key-name, -kn`	Filter by key name
`--key-pair-uid, -kpu`	Filter by key pair uid
`--key-set, -ks`	Filter by key set uid
`--all, -a`	include all items	`false`
`--private, -u`	include private items	`false`
`--shared, -s`	include shared items	`false`
`--public, -p`	include public items	`false`

rh key-pair retrieve¶

Retrieve key pairs from a key set

rh key-pair retrieve <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

create connection with RH

rh login --apikey=<<apikey>> [--username=<<username>>] [--password=<<password>>]

Options:

Option	Description	Default
`-k, --apikey`	RH api key
`-u, --username`	RH login or email address
`-p, --password`	RH password

rh logout¶

release connection with RH

rh logout <<username>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<username>>`

Options:

Option	Description	Default
`-a, --all`	logout all	`false`

rh ls¶

List connections established with RH

rh marketplace¶

Manage marketplaces

Subcommands:

categories — List product categories for a marketplace
create — Create a marketplace
delete — Delete marketplaces
delete-products — Delete marketplace products
ls — List marketplaces
products — List marketplace products
publish — Publish artifacts to marketplace
share — Share a marketplace

rh marketplace categories¶

List product categories for a marketplace

rh marketplace categories <<marketplaceId>>

Parameters:

Parameter	Description
`<<marketplaceId>>`	Marketplace ID

rh marketplace create¶

Create a marketplace

rh marketplace create --subdomain=<<mkpSubdomain>> --label=<<label>> [--description=<<description>>]

Options:

Option	Description	Default
`--subdomain, -sd`	Marketplace subdomain
`--label, -l`	Label
`--description, -d`	Description

rh marketplace delete¶

Delete marketplaces

rh marketplace delete <<marketplaceIds>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<marketplaceIds>>`	Marketplace IDs to delete

Options:

Option	Description	Default
`--all, -a`	Delete all marketplaces	`false`

rh marketplace delete-products¶

Delete marketplace products

rh marketplace delete-products <<productIds>> --marketplace=<<marketplaceId>>

Parameters:

Parameter	Description
`<<productIds>>`	Product IDs to delete

Options:

Option	Description	Default
`--marketplace, -m`	Marketplace ID

rh marketplace ls¶

List marketplaces

rh marketplace ls [--filter=<<filter>>] [--set=<<varName>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>]

Options:

Option	Description	Default
`--filter, -f`	Marketplace filter
`--set, -v`	assign command result to variable
`--all, -a`	include all marketplaces	`false`
`--private, -u`	include private marketplaces	`false`
`--shared, -s`	include shared marketplaces	`false`
`--public, -p`	include public marketplaces	`false`

rh marketplace products¶

List marketplace products

rh marketplace products [--marketplace=<<marketplaceId>>] [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--marketplace, -m`	Marketplace ID
`--filter, -f`	Product filter
`--set, -v`	assign command result to variable

rh marketplace publish¶

Publish artifacts to marketplace

rh marketplace publish <<marketplaceUid>> --artifacts=<<artifactUids>> [--quantity=<<quantity>>] [--access-duration=<<accessDurationMinutes>>] [--product-name=<<productName>>] [--product-description=<<productDescription>>]

Parameters:

Parameter	Description
`<<marketplaceUid>>`	Marketplace UID

Options:

Option	Description	Default
`--artifacts, -a`	Artifact UIDs to publish
`--quantity, -n`	Quantity	`0`
`--access-duration, -ad`	Access duration in minutes	`0`
`--product-name, -pn`	Product name
`--product-description, -pd`	Product description

Share a marketplace

rh marketplace share <<marketplaceUid>> --users=<<users>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<marketplaceUid>>`	Marketplace UID

Options:

Option	Description	Default
`--users, -u`	Users to share with
`--replace, -d`	Replace existing shares	`false`

rh notifications¶

Listen on RH message notifications

rh notifications [--username=<<username>>]

Options:

Option	Description	Default
`--username, -u`

rh open¶

Open a URL in the browser

rh open <<url>> [--no-selenium=<<noSelenium>>] [--browser=<<browserType>>]

Parameters:

Parameter	Description
`<<url>>`	URL to open

Options:

Option	Description	Default
`--no-selenium, -n`	Do not use Selenium	`false`
`--browser, -b`	Browser type

rh org¶

Manage organizations

Subcommands:

add-users — Add users to organization
assign-manager — Assign managers to organization
assign-roles — Assign roles to organizations (cpoc)
create — Create organization
delete — Delete organization
delete-formations — Delete formation instances for organization (cpoc)
get-cpocs — Get organization CPOCs
get-limits — Get assignable limits for institution as JSON (cpoc)
launch-formations — Launch formations for organization (cpoc)
ls — List organizations
ls-formation-instances — List formation instances for organization (cpoc)
ls-names — List organization names (cpoc)
node — Get organization node
reboot-formations — Reboot formation instances for organization (cpoc)
remove-users — Remove users from organization
set-auto-upgrade-vouchers — Set auto upgrade expiring vouchers (manager)
set-billing-code — Set billing code for an organization
set-default-formations — Set default formation UIDs for organization (cpoc)
set-description — Set organization description
set-limits — Set organization limits from JSON config (cpoc). Only fields present in the JSON are updated; others keep their current values.
set-perspective — Set default perspective for an organization
set-registration-allowed — Set registration allowed for organization (cpoc)
set-whitelisted-domains — Set whitelisted domains for an organization
shutdown-formations — Shutdown formation instances for organization (cpoc)
start-formations — Start formation instances for organization (cpoc)
stop-formations — Stop formation instances for organization (cpoc)
tree — Get organization tree
unassign-admins — Unassign admins from organization
unassign-cpocs — Unassign CPOCs from organization
unassign-roles — Unassign roles from organizations (cpoc)

rh org add-users¶

Add users to organization

rh org add-users <<organizationName>> --users=<<userLogins>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--users, -u`	User logins
`--replace, -rep`	Replace existing users	`false`

rh org assign-manager¶

Assign managers to organization

rh org assign-manager <<organizationName>> --admin-role=<<adminRole>> [--admins=<<adminLogins>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<organizationName>>`	organization name

Options:

Option	Description	Default
`--admin-role, -ar`	manager roles: CPOC, ADMIN, SU
`--admins, -A`	admin logins
`--replace, -rep`	replace	`false`

rh org assign-roles¶

Assign roles to organizations (cpoc)

rh org assign-roles --orgs=<<organizationNames>> --roles=<<roleNames>> [--replace=<<replace>>]

Options:

Option	Description	Default
`--orgs, -o`	Organization names
`--roles, -r`	Role names
`--replace`	Replace existing roles	`false`

rh org create¶

Create organization

rh org create --name=<<name>> --parentname=<<parentName>> [--label=<<label>>] [--description=<<description>>]

Options:

Option	Description	Default
`--name, -n`	organization name
`--parentname, -pn`	parent organization name
`--label, -l`	Label
`--description, -d`	Description

rh org delete¶

Delete organization

rh org delete --name=<<names>>

Options:

Option	Description	Default
`--name, -n`	organization names

rh org delete-formations¶

Delete formation instances for organization (cpoc)

rh org delete-formations <<organizationName>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

rh org get-cpocs¶

Get organization CPOCs

rh org get-cpocs <<organizationName>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

rh org get-limits¶

Get assignable limits for institution as JSON (cpoc)

rh org get-limits <<institutionId>> [--file=<<outputFile>>]

Parameters:

Parameter	Description
`<<institutionId>>`	Institution ID (root cloud account uid)

Options:

Option	Description	Default
`--file, -o`	Write JSON to file

rh org launch-formations¶

Launch formations for organization (cpoc)

rh org launch-formations <<organizationName>> --label=<<label>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--label, -l`	Label

rh org ls¶

List organizations

rh org ls [--filter=<<filter>>] [--include-managers=<<includeManagers>>] [--include-suborgs=<<includeSubOrganizations>>] [--include-resources=<<includeResources>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`
`--include-managers, -im`		`false`
`--include-suborgs, -is`		`false`
`--include-resources, -ir`		`false`
`--set, -v`	assign command result to variable

rh org ls-formation-instances¶

List formation instances for organization (cpoc)

rh org ls-formation-instances <<organizationName>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

rh org ls-names¶

List organization names (cpoc)

rh org node¶

Get organization node

rh org node <<organizationName>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

rh org reboot-formations¶

Reboot formation instances for organization (cpoc)

rh org reboot-formations <<organizationName>> [--force=<<force>>]

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--force, -F`	Force reboot	`false`

rh org remove-users¶

Remove users from organization

rh org remove-users <<organizationName>> --users=<<userLogins>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--users, -u`	User logins

rh org set-auto-upgrade-vouchers¶

Set auto upgrade expiring vouchers (manager)

rh org set-auto-upgrade-vouchers <<organizationName>> --enabled=<<enabled>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--enabled, -e`	Enable auto upgrade

rh org set-billing-code¶

Set billing code for an organization

rh org set-billing-code <<organizationName>> --billing-code=<<billingCode>> [--purchase-order=<<purchaseOrder>>]

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--billing-code, -bc`	Billing code
`--purchase-order, -poo`	Purchase order

rh org set-default-formations¶

Set default formation UIDs for organization (cpoc)

rh org set-default-formations <<organizationName>> --formations=<<formationUids>> [--max-instances=<<maxInstances>>]

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--formations, -f`	Formation UIDs
`--max-instances, -m`	Default formation finalize action	`1`

rh org set-description¶

Set organization description

rh org set-description <<organizationName>> --description=<<description>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--description, -d`	Description

rh org set-limits¶

Set organization limits from JSON config (cpoc). Only fields present in the JSON are updated; others keep their current values.

rh org set-limits <<organizationName>> --config=<<configFile>> [--institution=<<institutionId>>] [--full=<<fullReplace>>]

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--config, -c`	JSON file with limits to set (partial updates supported)
`--institution, -i`	Institution ID to fetch current limits from (for merge)
`--full`	Replace all limits (do not merge with current)	`false`

rh org set-perspective¶

Set default perspective for an organization

rh org set-perspective <<organizationName>> --perspective=<<goldenPerspectiveId>> [--priority=<<priority>>] [--sign-out-users=<<signOutUsers>>] [--hide-customization=<<hideCustomization>>]

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--perspective, -pe`	Golden perspective ID
`--priority, -pr`	Perspective priority index	`0`
`--sign-out-users, -so`	Sign out users after change	`false`
`--hide-customization, -hc`	Assign hide customization	`false`

rh org set-registration-allowed¶

Set registration allowed for organization (cpoc)

rh org set-registration-allowed <<organizationName>> --allowed=<<allowed>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--allowed, -a`	Registration allowed

rh org set-whitelisted-domains¶

Set whitelisted domains for an organization

rh org set-whitelisted-domains <<organizationName>> --domain=<<domains>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--domain`	Whitelisted domains

rh org shutdown-formations¶

Shutdown formation instances for organization (cpoc)

rh org shutdown-formations <<organizationName>> [--force=<<force>>]

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--force, -F`	Force shutdown	`false`

rh org start-formations¶

Start formation instances for organization (cpoc)

rh org start-formations <<organizationName>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

rh org stop-formations¶

Stop formation instances for organization (cpoc)

rh org stop-formations <<organizationName>> [--force=<<force>>]

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--force, -F`	Force stop	`false`

rh org tree¶

Get organization tree

rh org tree <<rootCloudAccountUid>> [--include-resources=<<includeResources>>] [--include-suborgs=<<includeSuborgs>>] [--include-roles=<<includeRoles>>]

Parameters:

Parameter	Description
`<<rootCloudAccountUid>>`	Root cloud account UID

Options:

Option	Description	Default
`--include-resources, -ir`	Include resources	`false`
`--include-suborgs, -is`	Include sub-organizations	`false`
`--include-roles, -iro`	Include roles	`false`

rh org unassign-admins¶

Unassign admins from organization

rh org unassign-admins <<organizationName>> --admins=<<adminLogins>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--admins, -a`	Admin logins

rh org unassign-cpocs¶

Unassign CPOCs from organization

rh org unassign-cpocs <<organizationName>> --cpocs=<<cpocLogins>>

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name

Options:

Option	Description	Default
`--cpocs, -c`	CPOC logins

rh org unassign-roles¶

Unassign roles from organizations (cpoc)

rh org unassign-roles --orgs=<<organizationNames>> --roles=<<roleNames>>

Options:

Option	Description	Default
`--orgs, -o`	Organization names
`--roles, -r`	Role names

rh org-rule¶

Manage organization rules

Subcommands:

delete — Delete organization rules
ls — List organization rules
reset — Reset organization rules

rh org-rule delete¶

Delete organization rules

rh org-rule delete <<organizationRuleUids>>

Parameters:

Parameter	Description
`<<organizationRuleUids>>`	Organization rule UIDs

rh org-rule ls¶

List organization rules

rh org-rule ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh org-rule reset¶

Reset organization rules

rh org-rule reset <<organizationRuleUids>>

Parameters:

Parameter	Description
`<<organizationRuleUids>>`	Organization rule UIDs

rh orgtrail¶

Listen on RH trail for all members of an organization

rh orgtrail [--orgname=<<orgname>>]

Options:

Option	Description	Default
`--orgname, -o`

rh perspective¶

Manage golden perspectives

Subcommands:

create — Create a golden perspective
create-from-settings — Create a golden perspective from user settings
delete — Delete golden perspectives
get — Get perspective details
ls — List golden perspectives
set-org-default — Set organization default perspective
share — Share golden perspective
unshare — Unshare golden perspective
update — Update a golden perspective

rh perspective create¶

Create a golden perspective

rh perspective create --label=<<label>> [--description=<<description>>] [--layout=<<goldenLayout>>] [--filter=<<filterEntries>>] [--side-menu=<<sideMenuVisible>>] [--filters-bar=<<filtersBarVisible>>] [--show-details=<<showDetailsOnHover>>] [--auto-zoom=<<autoZoom>>] [--synch-mode=<<synchMode>>] [--view-mode=<<viewMode>>] [--cloud=<<cloudId>>] [--region=<<regionId>>] [--index=<<perspectiveIndex>>] [--folder=<<folderName>>]

Options:

Option	Description	Default
`--label, -l`	Perspective label
`--description, -d`	Perspective description
`--layout, -ly`	Golden layout (JSON string)
`--filter, -fi`	Filter entries (key=value pairs)
`--side-menu, -sm`	Side menu visible	`true`
`--filters-bar, -fb`	Filters bar visible	`true`
`--show-details, -sd`	Show details on hover	`false`
`--auto-zoom, -az`	Auto zoom	`false`
`--synch-mode, -sy`	Synch mode	`0`
`--view-mode, -vm`	View mode	`0`
`--cloud, -c`	Cloud id
`--region, -r`	Region id
`--index, -idx`	Perspective index	`0`
`--folder, -fo`	Folder name

rh perspective create-from-settings¶

Create a golden perspective from user settings

rh perspective create-from-settings --label=<<label>> [--description=<<description>>] [--index=<<perspectiveIndex>>]

Options:

Option	Description	Default
`--label, -l`	Perspective label
`--description, -d`	Perspective description
`--index, -idx`	Perspective index	`0`

rh perspective delete¶

Delete golden perspectives

rh perspective delete <<goldenPerspectiveIds>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<goldenPerspectiveIds>>`	Golden perspective ids to delete

Options:

Option	Description	Default
`--all, -a`	Delete all golden perspectives	`false`

rh perspective get¶

Get perspective details

rh perspective get <<perspectiveUid>>

Parameters:

Parameter	Description
`<<perspectiveUid>>`	Golden perspective ID

rh perspective ls¶

List golden perspectives

rh perspective ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Perspective filter
`--all, -a`	Include all perspectives	`false`
`--private, -u`	Include private perspectives	`false`
`--shared, -s`	Include shared perspectives	`false`
`--public, -p`	Include public perspectives	`false`
`--set, -v`	Assign command result to variable

rh perspective set-org-default¶

Set organization default perspective

rh perspective set-org-default <<organizationName>> <<goldenPerspectiveId>> [--priority=<<perspectivePriorityIndex>>] [--sign-out-users=<<signOutUsers>>] [--hide-customization=<<assignHideCustomization>>]

Parameters:

Parameter	Description
`<<organizationName>>`	Organization name
`<<goldenPerspectiveId>>`	Golden perspective id

Options:

Option	Description	Default
`--priority, -pr`	Perspective priority index	`0`
`--sign-out-users, -so`	Sign out users	`false`
`--hide-customization, -hc`	Assign hide customization	`false`

Share golden perspective

rh perspective share <<goldenPerspectiveId>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--rights=<<rights>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<goldenPerspectiveId>>`	golden perspective id

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--rights, -ri`	rights	`r`
`--replace, -d`	replace	`false`

rh perspective unshare¶

Unshare golden perspective

rh perspective unshare <<goldenPerspectiveId>>

Parameters:

Parameter	Description
`<<goldenPerspectiveId>>`	golden perspective id

rh perspective update¶

Update a golden perspective

rh perspective update <<goldenPerspectiveId>> [--layout=<<goldenLayout>>] [--filter=<<filterEntries>>] [--side-menu=<<sideMenuVisible>>] [--in-top-menu=<<inTopMenu>>] [--filters-bar=<<filtersBarVisible>>] [--show-details=<<showDetailsOnHover>>] [--auto-zoom=<<autoZoom>>] [--synch-mode=<<synchMode>>] [--view-mode=<<viewMode>>] [--cloud=<<cloudId>>] [--region=<<regionId>>] [--index=<<perspectiveIndex>>] [--folder=<<folderName>>]

Parameters:

Parameter	Description
`<<goldenPerspectiveId>>`	Golden perspective id

Options:

Option	Description	Default
`--layout, -ly`	Golden layout (JSON string)
`--filter, -fi`	Filter entries (key=value pairs)
`--side-menu, -sm`	Side menu visible	`true`
`--in-top-menu, -itm`	In top menu	`false`
`--filters-bar, -fb`	Filters bar visible	`true`
`--show-details, -sd`	Show details on hover	`false`
`--auto-zoom, -az`	Auto zoom	`false`
`--synch-mode, -sy`	Synch mode	`0`
`--view-mode, -vm`	View mode	`0`
`--cloud, -c`	Cloud id
`--region, -r`	Region id
`--index, -idx`	Perspective index	`0`
`--folder, -fo`	Folder name

rh portfolio¶

Manage portfolios

Subcommands:

add-artifacts — Add artifacts to a portfolio
create — Create a portfolio
create-cloud — Create a cloud portfolio
delete — Delete portfolios
ls — List portfolios
remove-artifacts — Remove artifacts from a portfolio
share — Share portfolio
unshare — Unshare portfolio

rh portfolio add-artifacts¶

Add artifacts to a portfolio

rh portfolio add-artifacts <<portfolioUid>> --artifacts=<<artifactUids>>

Parameters:

Parameter	Description
`<<portfolioUid>>`	Portfolio UID

Options:

Option	Description	Default
`--artifacts, -ar`	Artifact UIDs (comma-separated)

rh portfolio create¶

Create a portfolio

rh portfolio create --label=<<label>> [--description=<<description>>] [--auto-add=<<autoAddArtifacts>>] [--type=<<portfolioType>>]

Options:

Option	Description	Default
`--label, -l`	Portfolio label
`--description, -d`	Portfolio description
`--auto-add, -aa`	Auto add artifacts	`false`
`--type, -t`	Portfolio type	`0`

rh portfolio create-cloud¶

Create a cloud portfolio

rh portfolio create-cloud [--keys=<<keySetUid>>] --label=<<label>> [--description=<<description>>]

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--label, -l`	Portfolio label
`--description, -d`	Portfolio description

rh portfolio delete¶

Delete portfolios

rh portfolio delete <<portfolioUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<portfolioUids>>`	Portfolio uids to delete

Options:

Option	Description	Default
`--all, -a`	Delete all portfolios	`false`

rh portfolio ls¶

List portfolios

rh portfolio ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--managed=<<managed>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Portfolio filter
`--all, -a`	Include all portfolios	`false`
`--private, -u`	Include private portfolios	`false`
`--shared, -s`	Include shared portfolios	`false`
`--public, -p`	Include public portfolios	`false`
`--managed, -mg`	List managed portfolios	`false`
`--set, -v`	Assign command result to variable

rh portfolio remove-artifacts¶

Remove artifacts from a portfolio

rh portfolio remove-artifacts <<portfolioUid>> --artifacts=<<artifactUids>>

Parameters:

Parameter	Description
`<<portfolioUid>>`	Portfolio UID

Options:

Option	Description	Default
`--artifacts, -ar`	Artifact UIDs (comma-separated)

Share portfolio

rh portfolio share <<portfolioUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>] [--role=<<roles>>]

Parameters:

Parameter	Description
`<<portfolioUid>>`	portfolio uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`
`--role, -ro`	portfolio roles

rh portfolio unshare¶

Unshare portfolio

rh portfolio unshare <<portfolioUid>>

Parameters:

Parameter	Description
`<<portfolioUid>>`	portfolio uid

rh project¶

Manage projects

Subcommands:

assign-cpocs — Assign CPOCs to project (superuser)
assign-manager — Assign admins to a project
assign-roles — Assign roles to projects (superuser)
assign-superusers — Assign superusers to project (superuser)
browse — Open RH portal with current connection
connect — Connect to Project
create — Create project
delete — Delete project
ls — List projects
masquerade — Masquerade as a project
set-billing-code — Set project billing code (superuser)
set-limits — Set project limits (superuser)
set-perspective — Set project default perspective (superuser)

rh project assign-cpocs¶

Assign CPOCs to project (superuser)

rh project assign-cpocs <<projectName>> --cpocs=<<cpocLogins>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<projectName>>`	Project name

Options:

Option	Description	Default
`--cpocs, -c`	CPOC logins
`--replace`	Replace existing CPOCs	`false`

rh project assign-manager¶

Assign admins to a project

rh project assign-manager <<projectName>> --admins=<<admins>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<projectName>>`	Project name

Options:

Option	Description	Default
`--admins, -ad`	Admin logins (comma-separated)
`--replace, -rp`	Replace existing admins	`false`

rh project assign-roles¶

Assign roles to projects (superuser)

rh project assign-roles --projects=<<projectNames>> --roles=<<roleNames>> [--replace=<<replace>>] [--role-prefixes=<<rolePrefixes>>]

Options:

Option	Description	Default
`--projects, -p`	Project names
`--roles, -r`	Role names
`--replace`	Replace existing roles	`false`
`--role-prefixes`	Role prefixes to filter replacement

rh project assign-superusers¶

Assign superusers to project (superuser)

rh project assign-superusers <<projectName>> --superusers=<<superuserLogins>> [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<projectName>>`	Project name

Options:

Option	Description	Default
`--superusers, -s`	Superuser logins
`--replace`	Replace existing superusers	`false`

rh project browse¶

Open RH portal with current connection

rh project browse <<name>> [--default-browser=<<defaultBrowser>>] [--browser-type=<<browserType>>]

Parameters:

Parameter	Description
`<<name>>`	project name

Options:

Option	Description	Default
`--default-browser, -d`	Use default browser (faster option but only one session as a time can be active)	`false`
`--browser-type, -t`	Browser type (chrome\|firefox)	`chrome`

rh project connect¶

Connect to Project

rh project connect <<name>>

Parameters:

Parameter	Description
`<<name>>`	project name

rh project create¶

Create project

rh project create --name=<<name>> --parentname=<<parentName>> [--label=<<label>>] [--description=<<description>>] [--root-account=<<rootCloudAccountUid>>] --budget=<<budget>> [--billing-code=<<billingCode>>] [--purchase-order=<<purchaseOrder>>]

Options:

Option	Description	Default
`--name, -n`	organization name
`--parentname, -pn`	parent organization name
`--label, -l`	Label
`--description, -d`	Description
`--root-account, -ra`	root cloud account uid
`--budget, -b`	Budget
`--billing-code, -bc`	Billing Code
`--purchase-order, -po`	Purchase Order

rh project delete¶

Delete project

rh project delete <<names>>

Parameters:

Parameter	Description
`<<names>>`	project names

rh project ls¶

List projects

rh project ls [--filter=<<filter>>] [--includeresources=<<includeResources>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`
`--includeresources, -ir`		`false`
`--set, -v`	assign command result to variable

rh project masquerade¶

Masquerade as a project

rh project masquerade <<projectName>>

Parameters:

Parameter	Description
`<<projectName>>`	Project name

rh project set-billing-code¶

Set project billing code (superuser)

rh project set-billing-code <<projectName>> [--billing-code=<<billingCode>>] [--purchase-order=<<purchaseOrder>>]

Parameters:

Parameter	Description
`<<projectName>>`	Project name

Options:

Option	Description	Default
`--billing-code, -b`	Billing code
`--purchase-order, -p`	Purchase order

rh project set-limits¶

Set project limits (superuser)

rh project set-limits <<projectName>> --config=<<configFile>>

Parameters:

Parameter	Description
`<<projectName>>`	Project name

Options:

Option	Description	Default
`--config, -c`	JSON file with limits configuration

rh project set-perspective¶

Set project default perspective (superuser)

rh project set-perspective <<projectName>> --perspective=<<goldenPerspectiveId>> [--priority=<<priority>>] [--sign-out-users=<<signOutUsers>>] [--hide-customization=<<hideCustomization>>]

Parameters:

Parameter	Description
`<<projectName>>`	Project name

Options:

Option	Description	Default
`--perspective, -p`	Golden perspective ID
`--priority, -pr`	Perspective priority index	`0`
`--sign-out-users, -so`	Sign out users after change	`false`
`--hide-customization, -hc`	Assign hide customization	`false`

rh rate-task¶

Manage scheduled rate tasks

Subcommands:

create — Create a rate-based scheduled task
delete — Delete all scheduled rate tasks
ls — List scheduled rate tasks

rh rate-task create¶

Create a rate-based scheduled task

rh rate-task create [--label=<<label>>] --eventname=<<eventName>> [--attribute=<<attributes>>] --rate-value=<<rateValue>> --rate-unit=<<rateUnit>> [--task-group=<<taskGroup>>]

Options:

Option	Description	Default
`--label, -l`	label
`--eventname, -en`	event name
`--attribute, -attr`	event Attributes
`--rate-value, -rv`	rate value
`--rate-unit, -ru`	rate unit (minutes, hours, days)
`--task-group, -tg`	Task Group	`default`

rh rate-task delete¶

Delete all scheduled rate tasks

rh rate-task ls¶

List scheduled rate tasks

rh rate-task ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh registration¶

Manage user registrations

Subcommands:

from-excel — Register users from Excel file (cpoc)
ls — List registrations
ls-emails — List registration emails (cpoc)
ls-processings — List registration processings (cpoc)
register-users — Register users (cpoc)
remove — Remove registrations (cpoc)
send-credentials — Send user credentials (cpoc)
send-verifications — Send registration verifications (cpoc)
send-welcomes — Send welcome emails (cpoc)
set-discarded — Set registration as discarded or not
set-duplicate — Set registration as duplicate or not
set-email-verified — Set registration email as verified or not
set-graduation — Set registration graduation info
set-reg-type — Set registration type
set-title — Set registration title
trigger-process — Trigger process registrations (cpoc)

rh registration from-excel¶

Register users from Excel file (cpoc)

rh registration from-excel --file=<<excelFile>> [--require-email-verification=<<requireEmailVerification>>] [--generic=<<generic>>]

Options:

Option	Description	Default
`--file, -f`	Excel file path
`--require-email-verification`	Require email verification	`true`
`--generic`	Generic registration	`false`

rh registration ls¶

List registrations

rh registration ls [--filter=<<filter>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Filter by login
`--set, -v`	Assign command result to variable

rh registration ls-emails¶

List registration emails (cpoc)

rh registration ls-emails [--login=<<login>>] [--email=<<email>>] [--reg-type=<<regType>>]

Options:

Option	Description	Default
`--login, -l`	Filter by login
`--email, -e`	Filter by email
`--reg-type, -r`	Filter by registration type

rh registration ls-processings¶

List registration processings (cpoc)

rh registration ls-processings [--login=<<login>>] [--email=<<email>>] [--reg-type=<<regType>>]

Options:

Option	Description	Default
`--login, -l`	Filter by login
`--email, -e`	Filter by email
`--reg-type, -r`	Filter by registration type

rh registration register-users¶

Register users (cpoc)

rh registration register-users --config=<<configFile>>

Options:

Option	Description	Default
`--config, -c`	JSON config file with registration info

rh registration remove¶

Remove registrations (cpoc)

rh registration remove <<userLogins>>

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

rh registration send-credentials¶

Send user credentials (cpoc)

rh registration send-credentials <<userLogins>>

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

rh registration send-verifications¶

Send registration verifications (cpoc)

rh registration send-verifications <<userLogins>>

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

rh registration send-welcomes¶

Send welcome emails (cpoc)

rh registration send-welcomes <<userLogins>>

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

rh registration set-discarded¶

Set registration as discarded or not

rh registration set-discarded <<userLogins>> [--undo=<<undo>>]

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

Options:

Option	Description	Default
`--undo`	Unset discarded flag	`false`

rh registration set-duplicate¶

Set registration as duplicate or not

rh registration set-duplicate <<userLogins>> [--undo=<<undo>>]

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

Options:

Option	Description	Default
`--undo`	Unset duplicate flag	`false`

rh registration set-email-verified¶

Set registration email as verified or not

rh registration set-email-verified <<userLogins>> [--undo=<<undo>>]

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

Options:

Option	Description	Default
`--undo`	Unset email verified flag	`false`

rh registration set-graduation¶

Set registration graduation info

rh registration set-graduation <<userLogins>> --month=<<graduationMonth>> --year=<<graduationYear>>

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

Options:

Option	Description	Default
`--month`	Graduation month
`--year`	Graduation year

rh registration set-reg-type¶

Set registration type

rh registration set-reg-type <<regType>> <<userLogins>>

Parameters:

Parameter	Description
`<<regType>>`	Registration type (e.g. Student, Researcher, Educator)
`<<userLogins>>`	User logins

rh registration set-title¶

Set registration title

rh registration set-title <<title>> <<userLogins>>

Parameters:

Parameter	Description
`<<title>>`	Title
`<<userLogins>>`	User logins

rh registration trigger-process¶

Trigger process registrations (cpoc)

rh registration trigger-process <<userLogins>> [--send-events=<<sendEvents>>] [--send-email=<<sendEmail>>]

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

Options:

Option	Description	Default
`--send-events`	Send events	`true`
`--send-email`	Send email	`true`

rh scope¶

Manage scopes (admin)

Subcommands:

clone — Clone a scope (admin)
create — Create a new scope (admin)
delete — Delete scopes (admin)
get — Get scope details (admin)
ls — List scopes (admin)
update — Update scope identity (label, description, role name) (admin)
update-instance-types — Update scope instance type restrictions and RAM quotas (admin)
update-limits — Update scope resource limits (admin)
update-quotas — Update scope artifact quotas (admin)

rh scope clone¶

Clone a scope (admin)

rh scope clone <<scopeUid>> [--label=<<label>>] [--description=<<description>>]

Parameters:

Parameter	Description
`<<scopeUid>>`	Scope UID to clone

Options:

Option	Description	Default
`--label, -l`	Label for the clone
`--description, -desc`	Description for the clone

rh scope create¶

Create a new scope (admin)

rh scope create --label=<<label>> [--description=<<description>>] [--role-name=<<roleName>>]

Options:

Option	Description	Default
`--label, -l`	Scope label
`--description, -desc`	Scope description
`--role-name, -rn`	Role name for the scope

rh scope delete¶

Delete scopes (admin)

rh scope delete <<scopeUids>>

Parameters:

Parameter	Description
`<<scopeUids>>`	Scope UIDs

rh scope get¶

Get scope details (admin)

rh scope get <<scopeUid>> [--set=<<varName>>]

Parameters:

Parameter	Description
`<<scopeUid>>`	Scope uid

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh scope ls¶

List scopes (admin)

rh scope ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh scope update¶

Update scope identity (label, description, role name) (admin)

rh scope update <<scopeUid>> [--label=<<label>>] [--description=<<description>>] [--role-name=<<roleName>>]

Parameters:

Parameter	Description
`<<scopeUid>>`	Scope UID

Options:

Option	Description	Default
`--label, -l`	Scope label
`--description, -desc`	Scope description
`--role-name, -rn`	Role name

rh scope update-instance-types¶

Update scope instance type restrictions and RAM quotas (admin)

rh scope update-instance-types <<scopeUid>> [--ram-quota=<<ramQuotaEntries>>] [--allowed-instance-types=<<allowedInstanceTypeEntries>>]

Parameters:

Parameter	Description
`<<scopeUid>>`	Scope UID

Options:

Option	Description	Default
`--ram-quota`	RAM quotas as cloud=limit pairs (e.g. aws=64,azure=32)
`--allowed-instance-types`	Allowed instance types as cloudId:type1,type2;cloudId:type1,type2

rh scope update-limits¶

Update scope resource limits (admin)

rh scope update-limits <<scopeUid>> [--maximum-hourly-cost=<<maximumHourlyCost>>] [--maximum-spot-price=<<maximumSpotPrice>>] [--maximum-spot-price-factor=<<maximumSpotPriceFactor>>] [--maximum-retrieval-rate-gb=<<maximumRetrievalRateGb>>] [--maximum-compute-instances=<<maximumComputeInstances>>] [--maximum-block-storage-size=<<maximumBlockStorageSize>>] [--maximum-file-storage-size=<<maximumFileStorageSize>>] [--maximum-block-snapshot-size=<<maximumBlockSnapshotSize>>] [--maximum-autostop-timeout=<<maximumAutostopTimeout>>] [--maximum-object-storage-size=<<maximumObjectStorageSize>>] [--maximum-instances-per-formation=<<maximumInstancesPerFormation>>]

Parameters:

Parameter	Description
`<<scopeUid>>`	Scope UID

Options:

Option	Description	Default
`--maximum-hourly-cost`	Maximum hourly cost
`--maximum-spot-price`	Maximum spot price
`--maximum-spot-price-factor`	Maximum spot price factor
`--maximum-retrieval-rate-gb`	Maximum retrieval rate in GB
`--maximum-compute-instances`	Maximum compute instances
`--maximum-block-storage-size`	Maximum block storage size
`--maximum-file-storage-size`	Maximum file storage size
`--maximum-block-snapshot-size`	Maximum block snapshot size
`--maximum-autostop-timeout`	Maximum autostop timeout
`--maximum-object-storage-size`	Maximum object storage size
`--maximum-instances-per-formation`	Maximum instances per formation

rh scope update-quotas¶

Update scope artifact quotas (admin)

rh scope update-quotas <<scopeUid>> [--portfolio-quota=<<portfolioQuota>>] [--api-keys-quota=<<apiKeysQuota>>] [--cron-task-quota=<<cronTaskQuota>>] [--rate-task-quota=<<rateTaskQuota>>] [--kubernetes-node-group-quota=<<kubernetesNodeGroupQuota>>] [--scope-quota=<<scopeQuota>>] [--cloud-account-pool-quota=<<cloudAccountPoolQuota>>] [--organization-quota=<<organizationQuota>>] [--organization-rule-quota=<<organizationRuleQuota>>] [--classroom-quota=<<classroomQuota>>] [--topup-quota=<<topupQuota>>] [--email-template-quota=<<emailTemplateQuota>>] [--key-set-quota=<<keySetQuota>>] [--engine-pool-quota=<<enginePoolQuota>>] [--token-request-quota=<<tokenRequestQuota>>] [--token-quota=<<tokenQuota>>] [--group-quota=<<groupQuota>>] [--ftp-storage-quota=<<ftpStorageQuota>>] [--file-storage-quota=<<fileStorageQuota>>] [--object-storage-quota=<<objectStorageQuota>>] [--block-storage-quota=<<blockStorageQuota>>] [--block-snapshot-quota=<<blockSnapshotQuota>>] [--formation-quota=<<formationQuota>>] [--project-quota=<<projectQuota>>] [--ip-address-quota=<<ipAddressQuota>>] [--domain-quota=<<domainQuota>>] [--ssl-certificate-quota=<<sslCertificateQuota>>] [--blacklistee-quota=<<blacklisteeQuota>>] [--startup-script-quota=<<startupScriptQuota>>] [--engine-session-quota=<<engineSessionQuota>>] [--image-quota=<<imageQuota>>] [--container-image-quota=<<containerImageQuota>>] [--container-repository-quota=<<containerRepositoryQuota>>] [--kubernetes-cluster-quota=<<kubernetesClusterQuota>>] [--view-quota=<<viewQuota>>] [--perspective-quota=<<perspectiveQuota>>] [--federated-iam-role-quota=<<federatedIamRoleQuota>>] [--federated-iam-user-quota=<<federatedIamUserQuota>>] [--federated-institution-registration-quota=<<federatedInstitutionRegistrationQuota>>] [--session-quota=<<sessionQuota>>]

Parameters:

Parameter	Description
`<<scopeUid>>`	Scope UID

Options:

Option	Description	Default
`--portfolio-quota`	Portfolio quota
`--api-keys-quota`	API keys quota
`--cron-task-quota`	Cron task quota
`--rate-task-quota`	Rate task quota
`--kubernetes-node-group-quota`	Kubernetes node group quota
`--scope-quota`	Scope quota
`--cloud-account-pool-quota`	Cloud account pool quota
`--organization-quota`	Organization quota
`--organization-rule-quota`	Organization rule quota
`--classroom-quota`	Classroom quota
`--topup-quota`	Topup quota
`--email-template-quota`	Email template quota
`--key-set-quota`	Key set quota
`--engine-pool-quota`	Engine pool quota
`--token-request-quota`	Token request quota
`--token-quota`	Token quota
`--group-quota`	Group quota
`--ftp-storage-quota`	FTP storage quota
`--file-storage-quota`	File storage quota
`--object-storage-quota`	Object storage quota
`--block-storage-quota`	Block storage quota
`--block-snapshot-quota`	Block snapshot quota
`--formation-quota`	Formation quota
`--project-quota`	Project quota
`--ip-address-quota`	IP address quota
`--domain-quota`	Domain quota
`--ssl-certificate-quota`	SSL certificate quota
`--blacklistee-quota`	Blacklistee quota
`--startup-script-quota`	Startup script quota
`--engine-session-quota`	Engine session quota
`--image-quota`	Image quota
`--container-image-quota`	Container image quota
`--container-repository-quota`	Container repository quota
`--kubernetes-cluster-quota`	Kubernetes cluster quota
`--view-quota`	View quota
`--perspective-quota`	Perspective quota
`--federated-iam-role-quota`	Federated IAM role quota
`--federated-iam-user-quota`	Federated IAM user quota
`--federated-institution-registration-quota`	Federated institution registration quota
`--session-quota`	Session quota

rh set-account-filter¶

Set engine cloud account filter

rh set-account-filter <<cloudAccountUid>>

Parameters:

Parameter	Description
`<<cloudAccountUid>>`	Cloud account UID

rh set-cloud¶

Set the default cloud of the default connection

rh set-cloud <<cloud>>

Parameters:

Parameter	Description
`<<cloud>>`	cloud, value can be: aws,gcp,azure or all

rh set-cloud-filter¶

Set engine cloud ID filter

rh set-cloud-filter <<cloudId>>

Parameters:

Parameter	Description
`<<cloudId>>`	Cloud ID

rh set-cloud-region¶

Set the default cloud and region of the default connection

rh set-cloud-region <<cloud>> <<region>>

Parameters:

Parameter	Description
`<<cloud>>`	cloud, value can be: aws,gcp,azure or all
`<<region>>`	region

rh set-default¶

Set the default RH connection

rh set-default <<username>>

Parameters:

Parameter	Description
`<<username>>`	Login or connection name to set as default

rh set-output¶

Set the output format for the default connection

rh set-output <<output>>

Parameters:

Parameter	Description
`<<output>>`	CLI output format, can be : table, json, yaml or csv

rh set-region¶

Set the default region of the default connection

rh set-region <<region>>

Parameters:

Parameter	Description
`<<region>>`	region

rh set-region-filter¶

Set engine region filter

rh set-region-filter <<regionId>>

Parameters:

Parameter	Description
`<<regionId>>`	Region ID

rh set-timezone¶

Set engine timezone

rh set-timezone <<timezoneId>>

Parameters:

Parameter	Description
`<<timezoneId>>`	Timezone ID

rh settings¶

Show current settings

rh single¶

Commands applied to default connection only

rh snapshot¶

Manage block snapshots

Subcommands:

clone — Clone a block snapshot
create — Create a block snapshot
create-volume — Create a volume from a snapshot
delete — Delete block snapshots
ls — List block snapshots
retrieve — Retrieve block snapshots from cloud
share — Share block snapshot
unshare — Unshare block snapshot

rh snapshot clone¶

Clone a block snapshot

rh snapshot clone <<blockSnapshotUid>> [--keys=<<keySetUid>>] [--deep-clone=<<deepCloning>>] [--encrypt=<<encrypt>>] [--encryption-key=<<encryptionKeyUid>>] --label=<<label>>

Parameters:

Parameter	Description
`<<blockSnapshotUid>>`	Block snapshot uid to clone

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--deep-clone`	Deep cloning	`false`
`--encrypt`	Encrypt the cloned snapshot	`false`
`--encryption-key`	Encryption key uid
`--label, -l`	Label for cloned snapshot

rh snapshot create¶

Create a block snapshot

rh snapshot create [--keys=<<keySetUid>>] [--volume=<<volumeId>>] [--block-storage=<<blockStorageUid>>] --label=<<label>> [--description=<<description>>]

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--volume, -v`	Volume id
`--block-storage, -bs`	Block storage uid
`--label, -l`	Label
`--description, -d`	Description

rh snapshot create-volume¶

Create a volume from a snapshot

rh snapshot create-volume <<blockSnapshotUid>> [--keys=<<keySetUid>>] [--az=<<availabilityZone>>] [--size=<<size>>] [--volume-type=<<volumeType>>] [--iops=<<iops>>] [--encrypt=<<encrypt>>] [--encryption-key=<<encryptionKeyUid>>] [--folder=<<folderPath>>] [--mount-point=<<defaultMountPoint>>] --label=<<label>> [--description=<<description>>]

Parameters:

Parameter	Description
`<<blockSnapshotUid>>`	Block snapshot uid

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--az, -z`	Availability zone
`--size, -s`	Volume size	`0`
`--volume-type, -vt`	Volume type
`--iops, -io`	IOPS	`0`
`--encrypt, -en`	Encrypt the volume	`false`
`--encryption-key, -ek`	Encryption key uid
`--folder, -fo`	Folder path
`--mount-point, -mp`	Default mount point
`--label, -l`	Label for the volume
`--description, -d`	Description

rh snapshot delete¶

Delete block snapshots

rh snapshot delete <<blockSnapshotUids>> [--destroy=<<destroy>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<blockSnapshotUids>>`	Block snapshot uids

Options:

Option	Description	Default
`--destroy`	Destroy underlying cloud snapshots	`false`
`--all, -a`	Delete all block snapshots	`false`

rh snapshot ls¶

List block snapshots

rh snapshot ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh snapshot retrieve¶

Retrieve block snapshots from cloud

rh snapshot retrieve <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

Share block snapshot

rh snapshot share <<blockSnapshotUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<blockSnapshotUid>>`	block snapshot uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`

rh snapshot unshare¶

Unshare block snapshot

rh snapshot unshare <<blockSnapshotUid>>

Parameters:

Parameter	Description
`<<blockSnapshotUid>>`	block snapshot uid

rh sso¶

Manage Sso

Subcommands:

prep — Prep Sso
records — List SSO records
records-by-batch — List SSO records by batch UID
suborgs — Upload Sso Suborgs

rh sso prep¶

Prep Sso

rh sso prep --dir=<<dir>> --locale=<<locale>> --reg-type=<<regType>> --institution-id=<<institutionId>> --org-name=<<organizationName>> --root-cloud-account-uid=<<rootCloudAccountUid>> --budget=<<budget>> [--preprocess=<<preprocess>>]

Options:

Option	Description	Default
`--dir, -d`	Directory
`--locale`	Locale
`--reg-type`	Reg Type
`--institution-id`	Institution Id
`--org-name`	Organization Name
`--root-cloud-account-uid`	Root Cloud Account Uid
`--budget`	Budget
`--preprocess`	Preprocess	`false`

rh sso records¶

List SSO records

rh sso records [--days=<<nbPastDays>>]

Options:

Option	Description	Default
`--days, -d`	Number of past days	`30`

rh sso records-by-batch¶

List SSO records by batch UID

rh sso records-by-batch <<ssoBatchUid>>

Parameters:

Parameter	Description
`<<ssoBatchUid>>`	SSO batch UID

rh sso suborgs¶

Upload Sso Suborgs

rh sso suborgs --dir=<<dir>> [--replace=<<replace>>]

Options:

Option	Description	Default
`--dir, -d`	Directory
`--replace, -rp`	Replace	`false`

rh startup-script¶

Manage startup scripts

Subcommands:

create — Create a startup script
delete — Delete startup scripts
ls — List startup scripts
share — Share a startup script
unshare — Unshare a startup script

rh startup-script create¶

Create a startup script

rh startup-script create [--process=<<process>>] [--commands=<<commands>>] [--label=<<label>>] [--description=<<description>>] [--detach=<<detach>>] [--tty=<<tty>>] [--privileged=<<privileged>>]

Options:

Option	Description	Default
`--process`	Process (e.g. /bin/bash)
`--commands`	Commands (comma separated)
`--label`	Label
`--description`	Description
`--detach`	Detach	`false`
`--tty`	TTY	`false`
`--privileged`	Privileged	`false`

rh startup-script delete¶

Delete startup scripts

rh startup-script delete <<startupScriptUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<startupScriptUids>>`	Startup Script Uids

Options:

Option	Description	Default
`--all, -a`	Delete all startup scripts	`false`

rh startup-script ls¶

List startup scripts

rh startup-script ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--set=<<varName>>] [--script-uid=<<startupScriptUid>>] [--approved=<<approved>>]

Options:

Option	Description	Default
`--filter, -f`	Startup script filter	`*`
`--all, -a`	include all startup scripts	`false`
`--private, -u`	include private startup scripts	`false`
`--shared, -s`	include shared startup scripts	`false`
`--public, -p`	include public startup scripts	`false`
`--set, -v`	assign command result to variable
`--script-uid`	Startup script uid
`--approved`	Approved

Share a startup script

rh startup-script share <<startupScriptUid>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<startupScriptUid>>`	Startup script uid

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`

rh startup-script unshare¶

Unshare a startup script

rh startup-script unshare <<startupScriptUid>>

Parameters:

Parameter	Description
`<<startupScriptUid>>`	Startup script uid

rh status¶

Check if the RosettaHub daemon is ready

rh storage¶

Manage storages

Subcommands:

browse — Browse storage
cdn-delete — Delete CDN hosting for object storage
cdn-disable — Disable CDN hosting for object storage
cdn-enable — Enable CDN hosting for object storage
cdn-invalidate — Invalidate CDN cache for object storage
clone — Clone object storage
copy — Copy object storage contents to another storage
create — Create storage
delete — delete storages
empty — Empty object storage
get-default — Get default object storage UID
locations — Get storage locations for key set
ls — List storages
put — Put object into storage
put-url — Put object from URL into storage
retrieve — Retrieve S3 storages from cloud
set-access-rights — Set object storage access rights
set-default — Set default object storage
set-sync — Set object storage sync mode
share — Share storage
sts — Get STS session for object storage
syncdown — Copy cloud storage to local folder
syncup — Copy local folder to cloud storage
unshare — Unshare storage
update — Update an S3 storage
website-disable — Disable static website hosting for object storage
website-enable — Enable static website hosting for object storage

rh storage browse¶

Browse storage

rh storage browse <<objectStorageUid>> [--duration=<<stsSessionDurationSeconds>>] [--no-selenium=<<noSelenium>>] [--browser-type=<<browserType>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	storage uid

Options:

Option	Description	Default
`--duration, -d`	session duration in seconds
`--no-selenium, -n`	no selenium	`false`
`--browser-type, -t`	Browser type (chrome\|firefox)	`chrome`

rh storage cdn-delete¶

Delete CDN hosting for object storage

rh storage cdn-delete <<objectStorageUid>> [--domain=<<domainName>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Object storage uid

Options:

Option	Description	Default
`--domain, -dn`	CDN domain name

rh storage cdn-disable¶

Disable CDN hosting for object storage

rh storage cdn-disable <<objectStorageUid>> [--domain=<<domainName>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Object storage uid

Options:

Option	Description	Default
`--domain, -dn`	CDN domain name

rh storage cdn-enable¶

Enable CDN hosting for object storage

rh storage cdn-enable <<objectStorageUid>> [--folder=<<folderName>>] [--allow=<<allowPattern>>] [--deny=<<denyPattern>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Object storage uid

Options:

Option	Description	Default
`--folder, -fo`	Folder name
`--allow, -a`	Allow patterns (comma-separated)
`--deny, -d`	Deny patterns (comma-separated)

rh storage cdn-invalidate¶

Invalidate CDN cache for object storage

rh storage cdn-invalidate <<objectStorageUid>> --paths=<<paths>>

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Object storage uid

Options:

Option	Description	Default
`--paths`	Comma-separated list of object paths to invalidate

rh storage clone¶

Clone object storage

rh storage clone <<objectStorageUid>> [--keys=<<keySetUid>>] [--deep=<<deepCloning>>] [--label=<<label>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Storage uid to clone

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--deep, -d`	Deep cloning	`false`
`--label, -l`	Label for cloned storage

rh storage copy¶

Copy object storage contents to another storage

rh storage copy <<sourceObjectStorageUid>> <<targetObjectStorageUid>>

Parameters:

Parameter	Description
`<<sourceObjectStorageUid>>`	Source storage uid
`<<targetObjectStorageUid>>`	Target storage uid

rh storage create¶

Create storage

rh storage create [--keys=<<keySetUid>>] [--bucket=<<bucketName>>] --label=<<label>> [--description=<<description>>] [--syncmode=<<syncMode>>] [--syncoptions=<<syncOptions>>] [--cloudsyncmode=<<cloudSyncMode>>] [--cloudsyncoptions=<<cloudSyncOptions>>] [--rights=<<accessRights>>] [--folder=<<folderPath>>]

Options:

Option	Description	Default
`--keys, -k`	key set uid
`--bucket, -b`	bucket name
`--label, -l`	label
`--description, -des`	description
`--syncmode, -sm`	sync mode	`0`
`--syncoptions, -so`	sync options
`--cloudsyncmode, -csm`	cloud sync mode	`0`
`--cloudsyncoptions, -cso`	cloud sync options
`--rights, -ri`	access rights	`rw`
`--folder, -fo`	folder path	`/`

rh storage delete¶

delete storages

rh storage delete <<storages>> [--destroy=<<destroy>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<storages>>`	Storage Uids

Options:

Option	Description	Default
`--destroy, -d`	delete underlying cloud bucket	`false`
`--all, -a`	Delete all storages	`false`

rh storage empty¶

Empty object storage

rh storage empty <<objectStorageUid>> [--include=<<includeFilter>>] [--exclude=<<excludeFilter>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Storage uid

Options:

Option	Description	Default
`--include, -i`	Include filter pattern
`--exclude, -e`	Exclude filter pattern

rh storage get-default¶

Get default object storage UID

rh storage locations¶

Get storage locations for key set

rh storage locations --key=<<keySetUid>>

Options:

Option	Description	Default
`--key, -k`	Key set uid

rh storage ls¶

List storages

rh storage ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Storage filter	`*`
`--all, -a`	include all storages	`false`
`--private, -u`	include private storages	`false`
`--shared, -s`	include shared storages	`false`
`--public, -p`	include public storages	`false`
`--region, -r`	storage region
`--cloud, -c`	storage cloud
`--set, -v`	assign command result to variable

rh storage put¶

Put object into storage

rh storage put <<objectStorageUid>> --key=<<objectKey>> [--value=<<objectValue>>] [--file=<<filePath>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Storage uid

Options:

Option	Description	Default
`--key, -k`	Object key/path
`--value, -v`	Object value (text content)
`--file, -f`	File path to upload

rh storage put-url¶

Put object from URL into storage

rh storage put-url <<objectStorageUid>> --key=<<objectKey>> --url=<<objectUrl>>

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Storage uid

Options:

Option	Description	Default
`--key, -k`	Object key/path
`--url, -u`	Source URL

rh storage retrieve¶

Retrieve S3 storages from cloud

rh storage retrieve <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

rh storage set-access-rights¶

Set object storage access rights

rh storage set-access-rights <<objectStorageUid>> --rights=<<accessRights>>

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Object storage uid

Options:

Option	Description	Default
`--rights, -r`	Access rights (private, public-read, public-read-write)

rh storage set-default¶

Set default object storage

rh storage set-default <<storageUid>>

Parameters:

Parameter	Description
`<<storageUid>>`	Storage uid

rh storage set-sync¶

Set object storage sync mode

rh storage set-sync <<objectStorageUid>> --sync=<<sync>>

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Object storage uid

Options:

Option	Description	Default
`--sync, -s`	Enable sync

Share storage

rh storage share <<objectStorageUid>> [--rights=<<rights>>] [--folder=<<folderPath>>] [--login=<<apppentTenantLoginToFolderPath>>] --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	storage uid

Options:

Option	Description	Default
`--rights, -ri`	rights	`r`
`--folder, -fo`	folder path	`/`
`--login, -lg`	append tenant login to folder path	`false`
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`

rh storage sts¶

Get STS session for object storage

rh storage sts <<objectStorageUid>> [--duration=<<durationSeconds>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Object storage UID

Options:

Option	Description	Default
`--duration, -d`	Session duration in seconds	`3600`

rh storage syncdown¶

Copy cloud storage to local folder

rh storage syncdown <<storageUid>> [--dir=<<dir>>] [--noaction=<<noaction>>] [--noprogress=<<noprogress>>] [--force=<<force>>] [--keepfiles=<<keepfiles>>] [--nodelete=<<nodelete>>] [--move=<<move>>] [--batch=<<batch>>] [--gzip=<<gzip>>] [--crypto=<<crypto>>] [--reportlevel=<<reportlevel>>]

Parameters:

Parameter	Description
`<<storageUid>>`	Storage Uid

Options:

Option	Description	Default
`--dir`	Local directory
`-n, --noaction`	No action taken. No files will be changed locally or on service, instead a report will be generating showing what will happen if the command is run without the -n option.	`false`
`-p, --noprogress`	Runs somewhat quietly, without displaying progress messages. The action report and overall summary are still displayed.	`false`
`-F, --force`	Force tool to perform synchronization even when files are up-to-date. This may be useful if you need to update metadata or timestamps online.	`false`
`-k, --keepfiles`	Keep outdated files on destination instead of reverting/removing them. This option cannot be used with --nodelete.	`false`
`-d, --nodelete`	Keep files on destination that have been removed from the source. This option is similar to --keepfiles except that files may be reverted. This option cannot be used with --keepfiles.	`false`
`-m, --move`	Move items rather than merely copying them. Files on the local computer will be deleted after they have been uploaded to service, or objects will be deleted from service after they have been downloaded. Be very careful with this option. This option cannot be used with --keepfiles.	`false`
`-b, --batch`	Download or upload files in batches, rather than all at once. Enabling this option will reduce the memory required to synchronize large buckets, and will ensure file transfers commence as soon as possible. When this option is enabled, the progress status lines refer only to the progress of a single batch.	`false`
`-g, --gzip`	Compress (GZip) files when backing up and Decompress gzipped files when restoring.	`false`
`-c, --crypto`	Encrypt files when backing up and decrypt encrypted files when restoring. If this option is specified the properties must contain a password.	`false`
`--reportlevel`	A number that specifies how much report information will be printed:
0 - no report items will be printed (the summary will still be printed)
1 - only actions are reported [Prefixes N, U, D, R, F, M]
2 - differences & actions are reported [Prefixes N, U, D, R, F, M, d, r]
3 - DEFAULT: all items are reported [Prefixes N, U, D, R, F, M, d, r, -]

rh storage syncup¶

Copy local folder to cloud storage

rh storage syncup <<storageUid>> [--dir=<<dir>>] [--noaction=<<noaction>>] [--noprogress=<<noprogress>>] [--force=<<force>>] [--keepfiles=<<keepfiles>>] [--nodelete=<<nodelete>>] [--move=<<move>>] [--batch=<<batch>>] [--gzip=<<gzip>>] [--crypto=<<crypto>>] [--reportlevel=<<reportlevel>>]

Parameters:

Parameter	Description
`<<storageUid>>`	Storage Uid

Options:

Option	Description	Default
`--dir`	Local directory
`-n, --noaction`	No action taken. No files will be changed locally or on service, instead a report will be generating showing what will happen if the command is run without the -n option.	`false`
`-p, --noprogress`	Runs somewhat quietly, without displaying progress messages. The action report and overall summary are still displayed.	`false`
`-F, --force`	Force tool to perform synchronization even when files are up-to-date. This may be useful if you need to update metadata or timestamps online.	`false`
`-k, --keepfiles`	Keep outdated files on destination instead of reverting/removing them. This option cannot be used with --nodelete.	`false`
`-d, --nodelete`	Keep files on destination that have been removed from the source. This option is similar to --keepfiles except that files may be reverted. This option cannot be used with --keepfiles.	`false`
`-m, --move`	Move items rather than merely copying them. Files on the local computer will be deleted after they have been uploaded to service, or objects will be deleted from service after they have been downloaded. Be very careful with this option. This option cannot be used with --keepfiles.	`false`
`-b, --batch`	Download or upload files in batches, rather than all at once. Enabling this option will reduce the memory required to synchronize large buckets, and will ensure file transfers commence as soon as possible. When this option is enabled, the progress status lines refer only to the progress of a single batch.	`false`
`-g, --gzip`	Compress (GZip) files when backing up and Decompress gzipped files when restoring.	`false`
`-c, --crypto`	Encrypt files when backing up and decrypt encrypted files when restoring. If this option is specified the properties must contain a password.	`false`
`--reportlevel`	A number that specifies how much report information will be printed:
0 - no report items will be printed (the summary will still be printed)
1 - only actions are reported [Prefixes N, U, D, R, F, M]
2 - differences & actions are reported [Prefixes N, U, D, R, F, M, d, r]
3 - DEFAULT: all items are reported [Prefixes N, U, D, R, F, M, d, r, -]

rh storage unshare¶

Unshare storage

rh storage unshare <<objectStorageUid>>

Parameters:

Parameter	Description
`<<objectStorageUid>>`	storage uid

rh storage update¶

Update an S3 storage

rh storage update <<objectStorageUid>> [--bucket=<<bucketName>>] [--sync-mode=<<syncMode>>] [--sync-options=<<syncOptions>>] [--cloud-sync-mode=<<cloudSyncMode>>] [--cloud-sync-options=<<cloudSyncOptions>>] [--access-rights=<<accessRights>>] [--folder=<<folderPath>>] [--mount-point=<<defaultMountPoint>>] [--deep-share=<<deepShare>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Storage UID

Options:

Option	Description	Default
`--bucket`	Bucket name
`--sync-mode`	Sync mode (0=none, 1=upload, 2=download, 3=both)
`--sync-options`	Sync options
`--cloud-sync-mode`	Cloud sync mode
`--cloud-sync-options`	Cloud sync options
`--access-rights`	Access rights
`--folder`	Folder path
`--mount-point`	Default mount point
`--deep-share`	Enable deep share	`false`

rh storage website-disable¶

Disable static website hosting for object storage

rh storage website-disable <<objectStorageUid>>

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Object storage uid

rh storage website-enable¶

Enable static website hosting for object storage

rh storage website-enable <<objectStorageUid>> [--folder=<<folderName>>] [--index-doc=<<indexDocName>>] [--error-doc=<<errorDocName>>] [--allow=<<allowPattern>>] [--deny=<<denyPattern>>]

Parameters:

Parameter	Description
`<<objectStorageUid>>`	Object storage uid

Options:

Option	Description	Default
`--folder, -fo`	Folder name
`--index-doc, -id`	Index document name	`index.html`
`--error-doc, -ed`	Error document name
`--allow, -a`	Allow patterns (comma-separated)
`--deny, -d`	Deny patterns (comma-separated)

rh token¶

Manage tokens

Subcommands:

consume — Consume a token
create — Create a token
delete — Delete tokens
ls — List owned tokens
ls-issued — List issued tokens
reallocate — Reallocate a token
update — Update a token

rh token consume¶

Consume a token

rh token consume <<tokenUid>>

Parameters:

Parameter	Description
`<<tokenUid>>`	Token UID

rh token create¶

Create a token

rh token create [--label=<<label>>] [--description=<<description>>] [--counter=<<counter>>] [--access-duration=<<accessDurationMinutes>>] [--location=<<location>>] [--immediate-sharing=<<immediateSharing>>] [--auto-activation=<<autoActivation>>] [--reallocatable=<<reallocatable>>]

Options:

Option	Description	Default
`--label, -l`	Token label
`--description, -d`	Token description
`--counter, -c`	Token counter (number of uses)	`1`
`--access-duration, -ad`	Access duration in minutes	`0`
`--location, -loc`	Token location
`--immediate-sharing, -is`	Enable immediate sharing	`false`
`--auto-activation, -aa`	Enable auto activation	`false`
`--reallocatable, -ra`	Allow reallocation	`false`

rh token delete¶

Delete tokens

rh token delete <<tokenUids>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<tokenUids>>`	Token UIDs

Options:

Option	Description	Default
`--all, -a`	Delete all tokens	`false`

rh token ls¶

List owned tokens

rh token ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh token ls-issued¶

List issued tokens

rh token ls-issued [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh token reallocate¶

Reallocate a token

rh token reallocate <<tokenUid>> --new-owner=<<newOwner>> [--counter=<<counterFraction>>] [--reallocatable=<<reallocatable>>] [--label=<<label>>] [--description=<<description>>] [--spec=<<spec>>]

Parameters:

Parameter	Description
`<<tokenUid>>`	Token UID

Options:

Option	Description	Default
`--new-owner, -o`	New owner login
`--counter, -c`	Counter fraction	`1`
`--reallocatable, -ra`	Allow further reallocation	`false`
`--label, -l`	Token label
`--description, -d`	Token description
`--spec, -s`	Token spec

rh token update¶

Update a token

rh token update <<tokenUid>> [--counter=<<counter>>] [--label=<<label>>]

Parameters:

Parameter	Description
`<<tokenUid>>`	Token uid

Options:

Option	Description	Default
`--counter, -c`	Token counter (number of uses)	`0`
`--label, -l`	Token label

rh topup¶

Manage top-up credits

Subcommands:

create — Create a top-up credit
delete — Delete top-up credits
ls — List top-up credits

rh topup create¶

Create a top-up credit

rh topup create --cloud-id=<<cloudId>> [--label=<<label>>] --duration=<<topupDurationDays>> --value=<<topupValue>> --price=<<topupPrice>>

Options:

Option	Description	Default
`--cloud-id, -ci`	Cloud ID
`--label, -l`	Label
`--duration, -du`	Duration in days
`--value, -val`	Top-up value
`--price, -pr`	Top-up price

rh topup delete¶

Delete top-up credits

rh topup delete <<topupUids>>

Parameters:

Parameter	Description
`<<topupUids>>`	Top-up UIDs

rh topup ls¶

List top-up credits

rh topup ls [--set=<<varName>>]

Options:

Option	Description	Default
`--set, -v`	Assign command result to variable

rh trail¶

Listen on the RH trail

rh trail [--username=<<username>>]

Options:

Option	Description	Default
`--username, -u`

rh update-description¶

Update artifact description

rh update-description <<artifactUid>> --description=<<description>>

Parameters:

Parameter	Description
`<<artifactUid>>`	Artifact UID to update

Options:

Option	Description	Default
`--description, -d`	New description

rh update-image¶

Update artifact image

rh update-image <<artifactUid>> --image=<<imageFileName>>

Parameters:

Parameter	Description
`<<artifactUid>>`	RH artifact uid

Options:

Option	Description	Default
`--image, -i`	Image file in png or jpeg format

rh update-label¶

Update artifact label

rh update-label <<artifactUid>> --label=<<label>>

Parameters:

Parameter	Description
`<<artifactUid>>`	Artifact UID to update

Options:

Option	Description	Default
`--label, -l`	New label

rh update-svg¶

Update artifact svg

rh update-svg <<artifactUid>> --svg=<<svgFileName>>

Parameters:

Parameter	Description
`<<artifactUid>>`	RH artifact uid

Options:

Option	Description	Default
`--svg, -s`	Svg file

rh user¶

Manage users

Subcommands:

add — Add users to organization
assign-account — Assign cloud accounts to users
assign-roles — Assign roles to users (cpoc)
clusters — Get federated user clusters
create — Create user
delete — Delete users
get-assignable-roles — Get roles that can be assigned to users
get-cloud-id — Get default cloud provider
get-ftp-account — Get default FTP account info
get-limits — Get current user limits as JSON (cpoc)
get-property — Get a user property
get-region-id — Get default region
get-rights — Get current user rights
get-roles — Get current user roles
get-screen-names — Get user screen names
instances — Get federated user instances
logins — Get federated user logins
lookup — Lookup users by filter
ls — List managed users
masquerade — Masquerade as user
remove — Remove users from organization
reset-settings — Reset user settings to defaults
set-allowed-capacities — Set allowed capacities for users by service type
set-allowed-regions — Set allowed regions for users
set-allowed-services — Set allowed services for users
set-autostop — Set autostop update allowed for user (cpoc)
set-autostop-enabled — Enable or disable autostop
set-autostop-timeout — Set autostop timeout in minutes
set-cloud-id — Set default cloud provider
set-limits — Set user limits from JSON config (cpoc). Only fields present in the JSON are updated; others keep their current values.
set-property — Set a user property
set-reg-type — Set registration type for users (cpoc)
set-region-id — Set default region
setemail — Set user email
setpwd — Set user password
setsecondaryemail — Set users secondary emails
sign-out — Sign out users
su-get-credentials — Get user credentials (superuser)
su-masquerade — Masquerade as another user (superuser)
su-masquerade-no-hide — Masquerade as another user without hiding (superuser)
su-reset-emails — Reset emails for users (superuser)
su-reset-passwords — Reset passwords for users (superuser)
su-set-data — Set user data (superuser)
unassign-roles — Unassign roles from users (cpoc)
unmasquerade — Stop masquerading
update-ftp-password — Update default FTP account password

rh user add¶

Add users to organization

rh user add <<logins>> --name=<<name>>

Parameters:

Parameter	Description
`<<logins>>`	logins

Options:

Option	Description	Default
`--name, -n`	organization name

rh user assign-account¶

Assign cloud accounts to users

rh user assign-account <<logins>> [--root-account=<<rootCloudAccountUid>>] --budget=<<budget>>

Parameters:

Parameter	Description
`<<logins>>`	logins

Options:

Option	Description	Default
`--root-account, -ra`	root cloud account uid
`--budget, -b`	budget

rh user assign-roles¶

Assign roles to users (cpoc)

rh user assign-roles --users=<<userLogins>> --roles=<<roleNames>> [--replace=<<replace>>]

Options:

Option	Description	Default
`--users, -u`
`--roles, -r`
`--replace`		`false`

rh user clusters¶

Get federated user clusters

rh user clusters <<userLogin>> [--cloud=<<cloudId>>] [--region=<<regionId>>] [--set=<<varName>>]

Parameters:

Parameter	Description
`<<userLogin>>`	User login

Options:

Option	Description	Default
`--cloud, -c`	Cloud ID
`--region, -r`	Region ID
`--set, -v`	Assign command result to variable

rh user create¶

Create user

rh user create --file=<<filePath>> --firstname=<<firstName>> --lastname=<<lastName>> --email=<<email>> --orgname=<<organizationName>> --regtype=<<regType>> [--root-account=<<rootCloudAccountUid>>] [--budget=<<budget>>] [--pwd=<<password>>]

Options:

Option	Description	Default
`--file, -fi`	file path
`--firstname, -fn`	first name
`--lastname, -ln`	last name
`--email, -e`	email
`--orgname, -on`	organization name
`--regtype, -t`	reg type
`--root-account, -ra`	root cloud account uid
`--budget, -b`	budget
`--pwd, -p`	password

rh user delete¶

Delete users

rh user delete <<logins>>

Parameters:

Parameter	Description
`<<logins>>`	logins

rh user get-assignable-roles¶

Get roles that can be assigned to users

rh user get-cloud-id¶

Get default cloud provider

rh user get-ftp-account¶

Get default FTP account info

rh user get-limits¶

Get current user limits as JSON (cpoc)

rh user get-limits <<userLogin>> [--file=<<outputFile>>]

Parameters:

Parameter	Description
`<<userLogin>>`	User login

Options:

Option	Description	Default
`--file, -o`	Write JSON to file

rh user get-property¶

Get a user property

rh user get-property <<propertyName>>

Parameters:

Parameter	Description
`<<propertyName>>`	Property name

rh user get-region-id¶

Get default region

rh user get-rights¶

Get current user rights

rh user get-roles¶

Get current user roles

rh user get-screen-names¶

Get user screen names

rh user get-screen-names <<emails>>

Parameters:

Parameter	Description
`<<emails>>`	Email addresses

rh user instances¶

Get federated user instances

rh user instances <<userLogin>> [--cloud=<<cloudId>>] [--region=<<regionId>>] [--set=<<varName>>]

Parameters:

Parameter	Description
`<<userLogin>>`	User login

Options:

Option	Description	Default
`--cloud, -c`	Cloud ID
`--region, -r`	Region ID
`--set, -v`	Assign command result to variable

rh user logins¶

Get federated user logins

rh user logins [--login=<<login>>] [--reg-type=<<regType>>] [--email=<<email>>] [--org-name=<<organizationName>>] [--group=<<groupName>>]

Options:

Option	Description	Default
`--login`	Filter by login
`--reg-type`	Filter by registration type
`--email`	Filter by email
`--org-name`	Filter by organization name
`--group`	Filter by group name

rh user lookup¶

Lookup users by filter

rh user lookup --filter=<<filter>>

Options:

Option	Description	Default
`--filter, -f`	Filter string (email or screen name)

rh user ls¶

List managed users

rh user ls [--filter=<<filter>>] [--includesuborgs=<<includeSubOrgs>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`
`--includesuborgs, -is`		`false`
`--set, -v`	assign command result to variable

rh user masquerade¶

Masquerade as user

rh user masquerade <<login>>

Parameters:

Parameter	Description
`<<login>>`	Login

rh user remove¶

Remove users from organization

rh user remove <<logins>> --name=<<name>>

Parameters:

Parameter	Description
`<<logins>>`	logins

Options:

Option	Description	Default
`--name, -n`	organization name

rh user reset-settings¶

Reset user settings to defaults

rh user set-allowed-capacities¶

Set allowed capacities for users by service type

rh user set-allowed-capacities <<userLogins>> --type=<<capacityType>> [--capacity=<<capacities>>]

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

Options:

Option	Description	Default
`--type, -t`	Capacity type: ec2, emr, rds, redshift, elasticache, elasticsearch
`--capacity`	Allowed capacities

rh user set-allowed-regions¶

Set allowed regions for users

rh user set-allowed-regions <<userLogins>> --cloud=<<cloudId>> [--region=<<regions>>]

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

Options:

Option	Description	Default
`--cloud, -c`	Cloud ID
`--region`	Allowed region IDs

rh user set-allowed-services¶

Set allowed services for users

rh user set-allowed-services <<userLogins>> --cloud=<<cloudId>> [--service=<<services>>]

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

Options:

Option	Description	Default
`--cloud, -c`	Cloud ID
`--service`	Allowed services

rh user set-autostop¶

Set autostop update allowed for user (cpoc)

rh user set-autostop <<userLogin>> --allowed=<<allowed>>

Parameters:

Parameter	Description
`<<userLogin>>`	User login

Options:

Option	Description	Default
`--allowed, -a`

rh user set-autostop-enabled¶

Enable or disable autostop

rh user set-autostop-enabled <<enabled>>

Parameters:

Parameter	Description
`<<enabled>>`	Enabled (true/false)

rh user set-autostop-timeout¶

Set autostop timeout in minutes

rh user set-autostop-timeout <<timeoutMinutes>>

Parameters:

Parameter	Description
`<<timeoutMinutes>>`	Timeout in minutes

rh user set-cloud-id¶

Set default cloud provider

rh user set-cloud-id <<cloudId>>

Parameters:

Parameter	Description
`<<cloudId>>`	Cloud id

rh user set-limits¶

Set user limits from JSON config (cpoc). Only fields present in the JSON are updated; others keep their current values.

rh user set-limits <<userLogin>> --config=<<configFile>> [--full=<<fullReplace>>]

Parameters:

Parameter	Description
`<<userLogin>>`	User login

Options:

Option	Description	Default
`--config, -c`	JSON file with limits to set (partial updates supported)
`--full`	Replace all limits (do not merge with current)	`false`

rh user set-property¶

Set a user property

rh user set-property <<propertyName>> <<propertyValue>>

Parameters:

Parameter	Description
`<<propertyName>>`	Property name
`<<propertyValue>>`	Property value

rh user set-reg-type¶

Set registration type for users (cpoc)

rh user set-reg-type --users=<<userLogins>> --type=<<regType>>

Options:

Option	Description	Default
`--users, -u`
`--type, -t`

rh user set-region-id¶

Set default region

rh user set-region-id <<regionId>>

Parameters:

Parameter	Description
`<<regionId>>`	Region id

rh user setemail¶

Set user email

rh user setemail <<login>> <<email>>

Parameters:

Parameter	Description
`<<login>>`	login
`<<email>>`	email

rh user setpwd¶

Set user password

rh user setpwd <<login>> <<password>>

Parameters:

Parameter	Description
`<<login>>`	login
`<<password>>`	password

rh user setsecondaryemail¶

Set users secondary emails

rh user setsecondaryemail --file=<<filePath>> [--login=<<logins>>] [--email=<<emails>>]

Options:

Option	Description	Default
`--file, -fi`	file path
`--login, -lg`	logins
`--email, -e`	emails

rh user sign-out¶

Sign out users

rh user sign-out <<userLogins>>

Parameters:

Parameter	Description
`<<userLogins>>`	userLogins

rh user su-get-credentials¶

Get user credentials (superuser)

rh user su-get-credentials <<userLogins>>

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

rh user su-masquerade¶

Masquerade as another user (superuser)

rh user su-masquerade <<userLogin>>

Parameters:

Parameter	Description
`<<userLogin>>`	User login

rh user su-masquerade-no-hide¶

Masquerade as another user without hiding (superuser)

rh user su-masquerade-no-hide <<userLogin>>

Parameters:

Parameter	Description
`<<userLogin>>`	User login

rh user su-reset-emails¶

Reset emails for users (superuser)

rh user su-reset-emails <<userLogins>>

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

rh user su-reset-passwords¶

Reset passwords for users (superuser)

rh user su-reset-passwords <<userLogins>>

Parameters:

Parameter	Description
`<<userLogins>>`	User logins

rh user su-set-data¶

Set user data (superuser)

rh user su-set-data <<userLogin>> [--first-name=<<firstName>>] [--last-name=<<lastName>>] [--email=<<email>>]

Parameters:

Parameter	Description
`<<userLogin>>`	User login

Options:

Option	Description	Default
`--first-name`
`--last-name`
`--email`

rh user unassign-roles¶

Unassign roles from users (cpoc)

rh user unassign-roles --users=<<userLogins>> --roles=<<roleNames>>

Options:

Option	Description	Default
`--users, -u`
`--roles, -r`

rh user unmasquerade¶

Stop masquerading

rh user update-ftp-password¶

Update default FTP account password

rh user update-ftp-password <<newPassword>>

Parameters:

Parameter	Description
`<<newPassword>>`	New FTP password

rh var¶

Manage CLI variables

Subcommands:

delete — Delete RosettaHub Variables
fields — List variable field names
get — List RosettaHub Variables
keys — List variable keys
ls — List RosettaHub Variables
lsf — List RosettaHub Variable fields
save — List RosettaHub Variables
set — Set RosettaHub Simple Variable

rh var delete¶

Delete RosettaHub Variables

rh var delete <<name>>

Parameters:

Parameter	Description
`<<name>>`

rh var fields¶

List variable field names

rh var fields <<name>>

Parameters:

Parameter	Description
`<<name>>`	variable name

rh var get¶

List RosettaHub Variables

rh var get <<name>> [--key=<<keyOnly>>] [--field-name=<<fieldName>>]

Parameters:

Parameter	Description
`<<name>>`	variable name

Options:

Option	Description	Default
`-k, --key`	show keys only	`false`
`-fn, --field-name`	show values for field

rh var keys¶

List variable keys

rh var keys <<name>>

Parameters:

Parameter	Description
`<<name>>`	variable name

rh var ls¶

List RosettaHub Variables

rh var ls [--all=<<all>>] [--key=<<keyOnly>>] [--field-name=<<fieldName>>]

Options:

Option	Description	Default
`-a, --all`	show all variable details	`false`
`-k, --key`	show keys only	`false`
`-fn, --field-name`	show values for field

rh var lsf¶

List RosettaHub Variable fields

rh var lsf <<name>>

Parameters:

Parameter	Description
`<<name>>`	variable name

rh var save¶

List RosettaHub Variables

rh var save <<name>> [--file=<<fileName>>] [--key=<<keyOnly>>] [--field-name=<<fieldName>>]

Parameters:

Parameter	Description
`<<name>>`	variable name

Options:

Option	Description	Default
`--file, -fi`	file name
`-k, --key`	show keys only	`false`
`-fn, --field-name`	show values for field

rh var set¶

Set RosettaHub Simple Variable

rh var set <<values>> [--name=<<name>>]

Parameters:

Parameter	Description
`<<values>>`	variable values

Options:

Option	Description	Default
`--name, -n`	variable name

rh view¶

Manage golden views

Subcommands:

create — Create a golden view
delete — Delete golden views
ls — List golden views
share — Share golden view
unshare — Unshare golden view
update — Update a golden view

rh view create¶

Create a golden view

rh view create --label=<<label>> [--description=<<description>>] --type=<<viewType>> [--content=<<viewContent>>] [--artifact=<<viewArtifactUid>>] [--event=<<viewEvents>>]

Options:

Option	Description	Default
`--label, -l`	View label
`--description, -d`	View description
`--type, -t`	View type
`--content, -ct`	View content
`--artifact, -ar`	View artifact uid
`--event, -ev`	View events

rh view delete¶

Delete golden views

rh view delete <<goldenViewIds>> [--all=<<all>>]

Parameters:

Parameter	Description
`<<goldenViewIds>>`	Golden view ids to delete

Options:

Option	Description	Default
`--all, -a`	Delete all golden views	`false`

rh view ls¶

List golden views

rh view ls [--filter=<<filter>>] [--type=<<viewType>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	View filter
`--type, -t`	View type filter
`--all, -a`	Include all views	`false`
`--private, -u`	Include private views	`false`
`--shared, -s`	Include shared views	`false`
`--public, -p`	Include public views	`false`
`--set, -v`	Assign command result to variable

Share golden view

rh view share <<goldenViewId>> --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--rights=<<rights>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<goldenViewId>>`	golden view id

Options:

Option	Description	Default
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--rights, -ri`	rights	`r`
`--replace, -d`	replace	`false`

rh view unshare¶

Unshare golden view

rh view unshare <<goldenViewId>>

Parameters:

Parameter	Description
`<<goldenViewId>>`	golden view id

rh view update¶

Update a golden view

rh view update <<goldenViewId>> [--type=<<viewType>>] [--content=<<viewContent>>] [--event=<<viewEvents>>]

Parameters:

Parameter	Description
`<<goldenViewId>>`	Golden view id

Options:

Option	Description	Default
`--type, -t`	View type
`--content, -ct`	View content
`--event, -ev`	View events

rh volume¶

Manage Images

Subcommands:

create — Create a volume
create-snapshot — Create a snapshot from a volume
delete — Delete volumes
ls — List volumes
retrieve — Retrieve block storages from cloud
share — Share a volume
unshare — Unshare a volume
update — Update a block storage volume

rh volume create¶

Create a volume

rh volume create --keys=<<keySetUid>> --volumetype=<<volumeType>> --size=<<size>> [--iops=<<iops>>] --az=<<availabilityZone>> [--encrypt=<<encrypt>>] [--encryptionkeyid=<<encryptionKeyId>>] [--snapshot=<<snapshotId>>] [--folder=<<folderPath>>] [--label=<<label>>] [--description=<<description>>]

Options:

Option	Description	Default
`--keys, -k`	Key set uid
`--volumetype, -t`	Volume type, values are: standard, gp3, gp2, io1, io2, sc1, st1
`--size, -s`	Size
`--iops, -i`	Size	`0`
`--az, -z`	Availability Zone
`--encrypt, -e`	Encrypt	`false`
`--encryptionkeyid, -eck`	Encrypt
`--snapshot, -sp`	Snapshot Id
`--folder, -fo`	folder path	`/`
`--label, -l`	Label
`--description, -des`	description

rh volume create-snapshot¶

Create a snapshot from a volume

rh volume create-snapshot <<blockStorageUid>> --label=<<label>>

Parameters:

Parameter	Description
`<<blockStorageUid>>`	Volume uid

Options:

Option	Description	Default
`--label, -l`	Label for the snapshot

rh volume delete¶

Delete volumes

rh volume delete <<blockStorageUids>> [--destroy=<<deleteCloudVolumes>>] [--all=<<all>>]

Parameters:

Parameter	Description
`<<blockStorageUids>>`	Ebs Storage Uids

Options:

Option	Description	Default
`--destroy, -d`	Delete underlying cloud volumes	`false`
`--all, -a`	Delete all volumes	`false`

rh volume ls¶

List volumes

rh volume ls [--filter=<<filter>>] [--all=<<includeAll>>] [--private=<<includePrivate>>] [--shared=<<includeShared>>] [--public=<<includePublic>>] [--region=<<region>>] [--cloud=<<cloud>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--filter, -f`	Image filter	`*`
`--all, -a`	include all images	`false`
`--private, -u`	include private images	`false`
`--shared, -s`	include shared images	`false`
`--public, -p`	include public images	`false`
`--region, -r`	region
`--cloud, -c`	cloud
`--set, -v`	assign command result to variable

rh volume retrieve¶

Retrieve block storages from cloud

rh volume retrieve <<keySetUid>>

Parameters:

Parameter	Description
`<<keySetUid>>`	Key set uid

Share a volume

rh volume share <<blockStorageUid>> [--rights=<<rights>>] [--folder=<<folderPath>>] [--login=<<apppentTenantLoginToFolderPath>>] --tenant=<<tenant>> [--tenantType=<<tenantType>>] [--replace=<<replace>>]

Parameters:

Parameter	Description
`<<blockStorageUid>>`	ebs storage uid

Options:

Option	Description	Default
`--rights, -ri`	rights	`r`
`--folder, -fo`	folder path	`/`
`--login, -lg`	append tenant login to folder path	`false`
`--tenant, -t`	tenant
`--tenantType, -p`	tenant type, u: user, o:organization, g: group, r: role	`u`
`--replace, -d`	replace	`false`

rh volume unshare¶

Unshare a volume

rh volume unshare <<blockStorageUid>>

Parameters:

Parameter	Description
`<<blockStorageUid>>`	ebs storage uid

rh volume update¶

Update a block storage volume

rh volume update <<blockStorageUid>> [--volume-id=<<volumeId>>] [--folder=<<folderPath>>] [--mount-point=<<defaultMountPoint>>]

Parameters:

Parameter	Description
`<<blockStorageUid>>`	Block storage UID

Options:

Option	Description	Default
`--volume-id, -vid`	Volume ID
`--folder, -fo`	Folder path
`--mount-point, -mp`	Default mount point

rh voucher¶

Manage vouchers

Subcommands:

ls — List vouchers
update — Update a voucher (cpoc)

rh voucher ls¶

List vouchers

rh voucher ls [--managed=<<managed>>] [--set=<<varName>>]

Options:

Option	Description	Default
`--managed, -mg`	List managed vouchers (admin/cpoc)	`false`
`--set, -v`	Assign command result to variable

rh voucher update¶

Update a voucher (cpoc)

rh voucher update --config=<<configFile>>

Options:

Option	Description	Default
`--config, -c`	JSON config file with voucher data

rh whoami¶

Show current identity and role flags

RosettaHub CLI Reference¶

Command Groups¶

Global Options¶

rh acc¶

rh acc assign-from-pool¶

rh acc block¶

rh acc browse¶

rh acc cleanup¶

rh acc configure-aws-cli¶

rh acc consoleurl¶

rh acc costs¶

rh acc cpoc-stop-all¶

rh acc create-key¶

rh acc delete-admin-key¶

rh acc detach¶

rh acc disable¶

rh acc enable¶

rh acc execute-aws-cli¶

rh acc get-default¶

rh acc has-accounts¶

rh acc issuevoucher¶

rh acc ls¶

rh acc ls-assignable¶

rh acc ls-machines¶

rh acc ls-owned¶

rh acc purge-aws-cli¶

rh acc quarantine¶

rh acc refresh-billing¶

rh acc refresh-compute¶

rh acc regeneratevpc¶

rh acc resetallkeys¶

rh acc resetbillingdate¶

rh acc resetbudget¶

rh acc reversetransfer¶

rh acc set-console-target¶

rh acc set-default¶

rh acc set-enabled¶

rh acc set-sharing-duration¶

rh acc setbudget¶

rh acc stopall¶

rh acc sts-session¶

rh acc su-assign¶

rh acc su-console-url¶

rh acc su-detach¶

rh acc su-import¶

rh acc su-new-generic-accounts¶

rh acc su-reset-all-keys¶

rh acc su-set-cleanup-protected¶

rh acc su-set-governance-level¶

rh acc su-set-metacloud-level¶

rh acc terminateall¶

rh acc transfer¶

rh acc unquarantine¶

rh acc update-billing¶

rh acc update-compute-quotas¶

rh all¶

rh api-key¶

rh api-key create¶

rh api-key delete¶

rh api-key ls¶

rh blacklist¶

rh blacklist add¶

rh blacklist delete¶

rh blacklist ls¶

rh bookmark¶

rh bookmark add¶

rh bookmark folders¶

rh bookmark ls¶

rh bookmark remove¶

rh bookmark remove-folder¶

rh browse¶

rh bucket¶

rh bucket clone¶

rh bucket delete¶

rh bucket empty¶

rh bucket ls¶

rh bucket share¶

rh bucket sync¶

rh bucket unshare¶

rh budget-transfer¶