Skip to content

Commit c9232d2

Browse files
fern-api[bot]fern-api[bot]
authored
docs: Add tenant show command documentation (#20)
* Fern Editor: Update * Fern Editor: Update --------- Co-authored-by: fern-api[bot] <115122769+fern-api[bot]@users.noreply.github.com>
1 parent d97a1ee commit c9232d2

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

‎fern/docs/pages/test-section.mdx‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,3 +45,61 @@ Protection| Level of data endurance
4545
Availability| Which failure data will survive, for example, device, instance, rack, or site
4646
MinStripe| Minimum data targeted per device - 32768 bytes
4747
MaxStripe| Maximum data targeted per device in bytes
48+
49+
## Show Details of a Tenant
50+
51+
As a realm or tenant admin, show details of a single tenant using `redcli tenant show` and specifying the name of the tenant. Note that tenant admins can show details of their own tenant only.
52+
53+
```bash
54+
redcli tenant show <tenant_name> [flags]
55+
```
56+
57+
<Card title="Example">
58+
This example shows details for the `red` tenant.
59+
60+
```none
61+
$ redcli tenant show red
62+
5:51PM INF Auto Selecting cluster: cluster-gray
63+
64+
┌──────┬────┬────────────────────┬────────────────┬────────────────────┬─────────────┬───────────────┬──────────────┐
65+
│ NAME │ ID │ ALLOCATED CAPACITY │ USAGE │ PROVISIONING RATIO │ IO PRIORITY │ PRIMARY ADMIN │ XATTRS │
66+
│ │ │ │ │ │ │ ├──────┬───────┤
67+
│ │ │ │ │ │ │ │ KEY │ VALUE │
68+
├──────┼────┼────────────────────┼────────────────┼────────────────────┼─────────────┼───────────────┼──────┼───────┤
69+
│ red │ 17 │ 250 GB │ 32.21 GB (13%) │ 2.40 │ medium │ DDNtenant1 │ -- │ -- │
70+
└──────┴────┴────────────────────┴────────────────┴────────────────────┴─────────────┴───────────────┴──────┴───────┘
71+
```
72+
</Card>
73+
<Card title="Example">
74+
```none maxLines=0
75+
┌───────────────────────────────────────────────────┬──────────────────────────────────────────────────┬──────┬──────────┬───────┐
76+
│ DEVICE │ LOCATION │ NUMA │ CAPACITY │ ERROR │
77+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
78+
│ Phison X200 91L00369 01 │ server-03-01.company.com slot 2 │ N/A │ 3.841 TB │ │
79+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
80+
│ Phison X200 91L0036H 01 │ server-03-04.company.com slot 18 │ N/A │ 3.841 TB │ │
81+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
82+
│ Phison X200 91L0036T 01 │ server-03-04.company.com slot 7 │ N/A │ 3.841 TB │ │
83+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
84+
│ Phison X200 91L0036V 01 │ server-03-04.company.com slot 16 │ N/A │ 3.841 TB │ │
85+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
86+
│ Phison X200 91L00376 01 │ server-03-04.company.com slot 6 │ N/A │ 3.841 TB │ │
87+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
88+
│ Phison X200 91L0037E 01 │ server-03-01.company.com slot 13 │ N/A │ 3.841 TB │ │
89+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
90+
│ Phison X200 91L0037G 01 │ server-03-04.company.com slot 17 │ N/A │ 3.841 TB │ │
91+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
92+
│ Phison X200 91L0037J 01 │ server-03-01.company.com slot 1 │ N/A │ 3.841 TB │ │
93+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
94+
│ Phison X200 91L0037N 01 │ server-03-01.company.com slot 3 │ N/A │ 3.841 TB │ │
95+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
96+
│ Phison X200 91L0037R 01 │ server-03-04.company.com slot 9 │ N/A │ 3.841 TB │ │
97+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
98+
│ Phison X200 91L0037T 01 │ server-03-01.company.com slot 4 │ N/A │ 3.841 TB │ │
99+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
100+
│ Phison X200 91L0037V 01 │ server-03-01.company.com slot 5 │ N/A │ 3.841 TB │ │
101+
├───────────────────────────────────────────────────┼──────────────────────────────────────────────────┼──────┼──────────┼───────┤
102+
│ Phison X200 91L00381 01 │ server-03-01.company.com slot 12 │ N/A │ 3.841 TB │ │
103+
└───────────────────────────────────────────────────┴──────────────────────────────────────────────────┴──────┴──────────┴───────┘
104+
```
105+
</Card>

0 commit comments

Comments
 (0)