UNPKG

hana-cli

Version:
147 lines (99 loc) 3.71 kB
# containers > Command: `containers` > Category: **HDI Management** > Status: Production Ready ## Description List all HDI Containers ## Syntax ```bash hana-cli containers [containerGroup] [container] [options] ``` ## Aliases - `cont` - `listContainers` - `listcontainers` ## Command Diagram ```mermaid flowchart TD A["hana-cli containers [containerGroup] [container]"] --> B["List all HDI Containers"] A --> CG["[containerGroup]\nHDI Container Group (string)"] A --> C["[container]\nHDI Container (string)"] A --> CP{"Connection Parameters"} CP --> CP1["-a, --admin\nConnect via admin (default-env-admin.json)\nDefault: false"] CP --> CP2["--conn\nConnection filename to override default-env.json"] A --> T{"Troubleshooting"} T --> T1["--disableVerbose, --quiet\nDisable verbose/extra human-readable output\nUseful for scripting commands\nDefault: false"] T --> T2["-d, --debug\nDebug hana-cli with lots of intermediate details\nDefault: false"] A --> O{"Options"} O --> O1["-h, --help\nShow help"] O --> O2["-c, --container\nContainer Name\nDefault: *"] O --> O3["-g, --containerGroup, --group, --containergroup\nContainer Group\nDefault: *"] O --> O4["-l, --limit\nLimit results\nDefault: 200"] ``` ## Parameters | Option | Type | Default | Group | Description | | --- | --- | --- | --- | --- | | `[containerGroup]` | `string` | _(none)_ | Positional Argument | HDI Container Group. | | `[container]` | `string` | _(none)_ | Positional Argument | HDI Container. | | `-a`, `--admin` | `boolean` | `false` | Connection Parameters | Connect via admin (`default-env-admin.json`). | | `--conn` | `string` | _(none)_ | Connection Parameters | Connection filename to override `default-env.json`. | | `--disableVerbose`, `--quiet` | `boolean` | `false` | Troubleshooting | Disable verbose output by removing extra human-readable output. Useful for scripting commands. | | `-d`, `--debug` | `boolean` | `false` | Troubleshooting | Debug `hana-cli` itself by adding lots of intermediate details. | | `-h`, `--help` | `boolean` | _(none)_ | Options | Show help. | | `-c`, `--container` | `string` | `*` | Options | Container Name. | | `-g`, `--containerGroup`, `--group`, `--containergroup` | `string` | `*` | Options | Container Group. | | `-l`, `--limit` | `number` | `200` | Options | Limit results. | For a complete list of parameters and options, use: ```bash hana-cli containers --help ``` ## Examples ### List All HDI Containers ```bash hana-cli containers ``` Lists all HDI containers in the system. ### Filter by Container Name ```bash hana-cli containers --container myContainer ``` Lists HDI containers matching the name `myContainer`. ### Filter by Container Group ```bash hana-cli containers --containerGroup myGroup ``` Lists all HDI containers in the specified container group. ### With Custom Limit ```bash hana-cli containers --limit 50 ``` Limits the results to 50 containers. --- ## containersUI (UI Variant) > Command: `containersUI` > Status: Production Ready **Description:** Execute containersUI command - UI version for listing HDI containers **Syntax:** ```bash hana-cli containersUI [containerGroup] [container] [options] ``` **Aliases:** - `containersui` - `contUI` - `listContainersUI` - `listcontainersui` **Parameters:** For a complete list of parameters and options, use: ```bash hana-cli containersUI --help ``` **Example Usage:** ```bash hana-cli containersUI ``` Execute the command ## Related Commands See the [Commands Reference](../all-commands.md) for other commands in this category. ## See Also - [Category: HDI Management](..) - [All Commands A-Z](../all-commands.md)