Skip to main content

Use CloudShell in BlueXP workload factory

Contributors netapp-rlithman
PDFs

Open CloudShell to execute AWS or ONTAP CLI commands from anywhere in the BlueXP workload factory user interface.

About this task

CloudShell allows you to execute AWS CLI commands or ONTAP CLI commands in a shell-like environment from within the BlueXP workload factory user interface. It simulates terminal sessions in the browser, providing terminal features and proxying messages through workload factory's backend. It allows you to use the AWS credentials and ONTAP credentials that you have provided in your BlueXP account.

CloudShell features include:

  • Multiple CloudShell sessions: deploy multiple CloudShell sessions at one time to issue several sequences of commands in parallel,

  • Multiple views: split CloudShell tab sessions so you can view two or more tabs horizontally or vertically at the same time

  • Session renaming: rename sessions as needed

  • Last session content persistence: re-open the last session if you close it by mistake

  • Settings preferences: change the font size and output type

  • AI-generated error responses for ONTAP CLI commands

CloudShell commands

Within the CloudShell GUI interface, you can enter help to view available CloudShell commands. After you issue the help command, the following reference appears.

Description

NetApp CloudShell is a GUI interface built into BlueXP workload factory enables you to execute AWS CLI commands or ONTAP CLI commands in a shell-like environment. It simulates terminal sessions in the browser, providing terminal features and proxying messages through the backend in workload factory. It enables you to use the AWS credentials and ONTAP credentials that you have provided in your BlueXP Account.

Available commands

  • clear

  • help

  • [--fsx <fsxId>] <ontap-command> [parameters]

  • aws <aws-command> <aws-sub-command> [parameters]

Context

Each terminal session runs in a specific context: credentials, region, and optionally FSx for ONTAP file system.

All AWS commands execute in the provided context. AWS commands will only succeed if the provided credentials have permissions in the specified region.

You can specify ONTAP commands with an optional fsxId. If you provide an fsxId with an individual ONTAP command, then this ID overrides the ID in the context. If the terminal session doesn't have an FSx for ONTAP file system ID context, then you must provide fsxId with each ONTAP command.

To update different context specifics, do the following: * To change credentials: "using credentials <credentialId>" * To change region: "using region <regionCode>" * To change FSx for ONTAP file system: "using fsx <fileSystemId>"

Showing Items

  • To show available credentials: "show credentials"

  • To show available regions: "show regions"

  • To show command history: "show history"

Variables

The following are examples of setting and using variables. If a variable value contains spaces, you should set it inside quotes.

  • To set a variable: $<variable> = <value>

  • To use a variable: $<variable>

  • Example setting a variable: $svm1 = svm123

  • Example using a variable: --fsx FileSystem-1 volumes show --vserver $svm1

  • Example setting a variable with string value $comment1 = "A comment with spaces"

Operators

Shell operators such as pipe |, background execution &, and redirection > aren't supported. Command execution fails if you include these operators.

Before you begin

CloudShell works in the context of your AWS credentials. To use CloudShell, you must provide at least one AWS credential.

Note CloudShell is available for you to execute any AWS or ONTAP CLI command. However, if you want to work within the context of an FSx for ONTAP file system, make sure you issue the following command: using fsx <file-system-name>.

Deploy CloudShell

You can deploy CloudShell from anywhere in the BlueXP workload factory console. You can also deploy CloudShell from Storage from within an FSx for ONTAP file system.

Deploy from workload factory console
Steps

  1. Log in using one of the console experiences.

  2. Open CloudShell Screenshot of the cloudshell icon from the top navigation bar.

  3. In the CloudShell window, select credentials and region for the CloudShell session and then select the arrow to continue.

    Screenshot that shows a new CloudShell session.

  4. Enter help to view available CloudShell commands and instructions or refer to the following CLI reference documents for available commands:

  5. Issue commands within the CloudShell session.

    If an error occurs after issuing an ONTAP CLI command, select the light bulb icon to get a brief AI-generated error response with a description of the failure, the cause of the failure, and a detailed resolution. Select Read more for more details.

Deploy from Storage
Steps

  1. Log in using one of the console experiences.

  2. In Storage, select Go to storage inventory.

  3. In the FSx for ONTAP tab, select the three-dot menu of the file system and then select Open CloudShell.

    A CloudShell session opens in the context of the selected file system.

  4. Enter help to view available CloudShell commands and instructions or refer to the following CLI reference documents for available commands:

  5. Issue commands within the CloudShell session.

    If an error occurs after issuing an ONTAP CLI command, select the light bulb icon to get a brief AI-generated error response with a description of the failure, the cause of the failure, and a detailed resolution. Select Read more for more details.

The CloudShell tasks shown in this screenshot can be completed by selecting the three-dot menu of an open CloudShell session tab. The instructions for each of these tasks follows.

Screenshot that shows CloudShell tab three-dot menu with options like rename, duplicate, close other tabs, and close all.

Rename a CloudShell session tab

You can rename a CloudShell session tab to help you identify the session.

Steps

  1. Select the three-dot menu of the CloudShell session tab.

  2. Select Rename.

  3. Enter a new name for the session tab and then click outside the tab name to set the new name.

Result

The new name appears in the CloudShell session tab.

Duplicate CloudShell session tab

You can duplicate a CloudShell session tab to create a new session with the same name, credentials, and region. The code from the original tab isn't duplicated in the duplicated tab.

Steps

  1. Select the three-dot menu of the CloudShell session tab.

  2. Select Duplicate.

Result

The new tab appears with the same name as the original tab.

Close CloudShell session tabs

You can close CloudShell tabs one at a time, close other tabs you're not working on, or close all tabs at once.

Steps

  1. Select the three-dot menu of the CloudShell session tab.

  2. Select one of the following:

    • Select "X" in the CloudShell tab window to close one tab at a time.

    • Select Close other tabs to close all other tabs that are open except the one you're working on.

    • Select Close all tabs to close all tabs.

Result

The selected CloudShell session tabs close.

Split CloudShell session tabs

You can split CloudShell session tabs to view two or more tabs at the same time.

Step

Drag and drop CloudShell session tabs to the top, bottom, left, or right of the CloudShell window to split the view.

Screenshot that shows two CloudShell tabs split horizontally. The tabs appear side by side.

Re-open your last CloudShell session

If by accident you close your CloudShell session, you can re-open it.

Step

Select the CloudShell icon Screenshot of the cloudshell icon from the top navigation bar.

Result

The latest CloudShell sessions open.

Update settings for a CloudShell session

You can update font and output type settings for CloudShell sessions.

Steps

  1. Deploy a CloudShell session.

  2. In the CloudShell tab, select the settings icon.

    The settings dialog appears.

  3. Update font size and output type as needed.

    Note Enriched output applies to JSON objects and table formatting. All other output appears as plain text.

  4. Select Apply.

Result

The CloudShell settings are updated.