-
Notifications
You must be signed in to change notification settings - Fork 4
/
_config.yml
406 lines (340 loc) · 25.8 KB
/
_config.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
repository: qumulo/docs
output: web
# this property is useful for conditional filtering of content that is separate from the PDF.
topnav_title: Qumulo Documentation
# this appears on the top navigation bar next to the home button
site_title: Qumulo Documentation
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
company_name: Qumulo, Inc.
# this appears in the footer
github_editme_path: qumulo/docs/blob/gh-pages/
# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
#gitlab_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/
# if you're using GitLab, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank.
# google_analytics: UA-66296557-1
# if you have google-analytics ID, put it in. if not, edit this value to blank.
host: localhost
# the preview server used. Leave as is.
port: 4000
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.
exclude:
- .gitignore
- .idea
- .ignore-error
- .spelling-allowlist
- .spelling-ignorefiles
- tools/
- "*.sh"
- "*.rb"
- "*.yml"
- "*.drawio"
- "*.lua"
- docker/
- Gemfile
- Gemfile.lock
- createtag
- var # Deleting this line will cause tests to fail
- vendor # Deleting this line will cause tests to fail
# these are the files and directories that jekyll will exclude from the build
feedback_subject_line: Qumulo Documentation
feedback_email: qontent-feedback@qumulo.com
# used as a contact email for the Feedback link in the top navigation bar
feedback_disable: true
# if you uncomment the previous line, the Feedback link gets removed
# feedback_text: "Need help?"
# if you uncomment the previous line, it changes the Feedback text
# feedback_link: "http://helpy.io/"
# if you uncomment the previous line, it changes where the feedback link points to
highlighter: rouge
# library used for syntax highlighting
markdown: kramdown
kramdown:
input: GFM
auto_ids: true
hard_wrap: false
syntax_highlighter: rouge
# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways
defaults:
-
scope:
path: ""
type: "pages"
values:
layout: "page"
comments: false
# if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
search: true
sidebar: home_sidebar
topnav: topnav
-
scope:
path: ""
type: "tooltips"
values:
layout: "page"
search: true
tooltip: true
-
scope:
path: "qq-cli-command-guide"
type: "pages"
values:
layout: "cli"
comments: false
# if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
search: true
sidebar: home_sidebar
topnav: topnav
-
scope:
path: ""
type: "posts"
values:
layout: "post"
comments: false
# if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property
search: true
sidebar: home_sidebar
topnav: topnav
# these are defaults used for the frontmatter for these file types
sidebars:
- home_sidebar
- hardware_guide_sidebar
- cloud_guide_sidebar
- administrator_guide_sidebar
- qumulo_alerts_guide_sidebar
description: "This site is a new documentation portal for Qumulo that uses docs-as-code principles. As we continue to add new content to this portal, we want you to ask questions and share your ideas with us—click Edit on GitHub on any page."
# the description is used in the feed.xml file
# needed for sitemap.xml and jekyll-redirect-from
url: https://docs.qumulo.com
baseurl: /
github: [metadata]
# Enable relative_links and enable it on collections as well to allow relative links to be processed in subdirectories
relative_links:
enabled: true
collections: true
# Enable server-side redirects. For more information, see https://github.com/jekyll/jekyll-redirect-from
plugins:
- jekyll-redirect-from
# BEGIN SPELLCHECK HERE
loginRequired: <span class="emoji">🔒</span>
nexusDownloads: For downloads, release notes, and upgrade paths for on-premises and cloud releases of Qumulo Core, see <a target="_blank" href="https://nexus.qumulo.com/downloads">Qumulo Nexus</a>
contactQumuloCare: <a href="https://docs.qumulo.com/contacting-qumulo-care-team.html">contact the Qumulo Care team</a>
exampleUsernameUppercase1: JSMITH
exampleClusterNameUppercase1: MYCLUSTER
exampleAWSaccessKeyID: AKIAIOSFODNN7EXAMPLE
exampleAWSsecretKey: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
examplePassword: HTEj0kGIOsNOAA0
exampleKeyID: abcd-1234-efgh-5678
exampleIP0: 203.0.113.0
exampleIP1: 203.0.113.1
exampleIP2: 203.0.113.2
exampleIP42: 203.0.113.42
exampleIP84: 203.0.113.84
exampleIPv60: 2001:db8:60e0:7352:e9d2:e180:e7e8:cdb8
exampleIPv61: 2001:db8:8560:26eb:19f2:fe28:c49f:7f4c
exampleIPv62: 2001:db8:2ebf:276a:375:a593:5c3a:d4c4
exampleIPrange1: 203.0.113.0-203.0.113.10
exampleIPrange2: 203.0.113.0-10
exampleIPrange3: 203.0.113.10-20
exampleIPv6range1: 2001:db8:0:0:1::1-2001:db8:0:0:1::ffff
exampleIPv6range2: 2001:db8:0:0:2::1-2001:db8:0:0:2::ffff
exampleIPv6range3: 2001:db8::/64
exampleNetworkSegment0: 203.0.113.0/16
exampleNetworkSegment1: 203.0.113.0/24
exampleNetworkSegment2: 203.0.113.0/255.255.255.0
exampleNetworkSegmentIPv60: 2001:db8::/33
exampleNetworkSegmentIPv61: 2001:db8::/48
exampleNetworkSegmentIPv62: 2001:db8::/64
exampleNetMask1: 255.255.255.0
exampleSubnet1: 255.0.0.1
exampleGateway1: 192.168.0.1
exampleGatewayRange1: 192.168.0.1-10
exampleGatewayRange2: 192.168.0.11-21
exampleDNSserver1: 8.8.8.8
exampleUUID41: 12345a6b-7c89-0d12-3456-78fe9012f345
exampleUUID42: abcde1f2-g3hi-j4kl-mnop-qr56stuv7wxy
exampleUUID43: c3a7be37-d65b-42ec-831a-1d0e94a171de
exampleUUID44: 31b43286-2b03-4dc7-af27-a8c4c35719ab
exampleMAC1: d0:82:77:72:01:1f
exampleMAC2: a0:2c:55:a3:3d:ce
exampleMAC3: ec:fd:7d:3f:0b:e5
exampleMAC4: c4:e9:73:89:7c:76
adp:
before612AddOnly: Qumulo Core 6.1.0.1 and 6.1.1 support Adaptive Data Protection by letting you reconfigure your cluster's fault tolerance level and storage efficiency only when you add nodes to your cluster.
before612Description: Depending on your cluster, Qumulo Core shows configuration options that offer better fault tolerance levels, better storage efficiency, or both benefits. To enable Adaptive Data Protection for your cluster, you must
after612AddReplace: In Qumulo Core 6.1.2 (and higher), you can change your cluster's data protection configuration when you add or replace nodes by using the <code>qq</code> CLI.
determineUUIDs: 1. To determine the UUIDs of the nodes to add to your cluster, run the <code>qq unconfigured_nodes_list</code> command.
noteDownUUIDs: 1. Write down the UUIDs of the nodes that you want to add to the cluster, in the order that you want to add them.
rackNewNodes: 1. Rack and wire your new nodes and then power them on.
cannotReorderNodes: it isn't possible to revert this operation or reorder nodes after adding them to a cluster.
hardware:
ipmiConfig:
smc: To configure the IPMI port, you must use the IPMI Management Utility installed on the motherboard. For more information, see <a href="https://www.supermicro.com/manuals/other/BMC_Users_Guide_X12_H12.pdf">Supermicro BMC User Guide X12</a>.
ipmiCreds:
hpe: The default username, password, and DNS name are printed on a serial label pull tab attached to the node.
quiver: The default IMPI username is <code>ADMIN</code> and the default password is <code>Admin123</code>.
smc: The default IPMI username is <code>ADMIN</code> and the default password is printed on a label on the node's motherboard.
smcNote: As of November 2019, <a href="https://www.supermicro.com/en/support/BMC_Unique_Password">Supermicro no longer uses the default <code>ADMIN</code> password.</a>
smcMoreInfo1014S: For more information, see <a href="https://www.supermicro.com/manuals/superserver/1U/MNL-2436.pdf#page=67">IPMI</a> in the Supermicro documentation.
smcMoreInfo2015S: For more information, see <a href="https://www.supermicro.com/manuals/superserver/1U/MNL-2628.pdf#page=87">BMC</a> in the Supermicro documentation.
smcMoreInfo1114S: For more information, see <a href="https://www.supermicro.com/manuals/superserver/1U/MNL-2295.pdf#page=64">IPMI</a> in the Supermicro documentation.
ethDiff: The <code>eth</code> port labels vary depending on the NIC manufacturer.
irmcCreds:
fprx: The default iRMC username is <code>admin</code> and the default password is printed on the System ID Card attached to the node.
led:
red: <span class="emoji">🔴</span>
brown: <span class="emoji">🟤</span>
orange: <span class="emoji">🟠</span>
yellow: <span class="emoji">🟡</span>
green: <span class="emoji">🟢</span>
blue: <span class="emoji">🔵</span>
purple: <span class="emoji">🟣</span>
black: <span class="emoji">⚫️</span>
white: <span class="emoji">⚪️</span>
splitIlo: We strongly recommend separating your iLO access network from your client-facing network.
partReplaceDefine: When you replace a component such as the motherboard or a NIC card in your node, you must ensure that the firmware version and configuration are correct for your new components. To do this, you must perform the part replacement procedure by using the FVT.
partReplaceDcms: Before you replace the motherboard, you must request a new Data Center Management Suite (DCMS) license key from Supermicro and apply it before you run the FVT. (The license key uses the BMC MAC address which changes with the motherboard.) If you don't install a DCMS license on your node, the Field Verification Tool (FVT) fails, preventing you from running the part replacement procedure in the FVT, which normalizes the firmware and BIOS configuration for your new motherboard.
fsSecurityCommands: The response of the <code>qq fs_security_add_key</code> command includes the <em>key identifier.</em> When you use <code>qq fs_security</code> commands, you can specify either the key identifier (by using the <code>--id</code> flag) or the key name (by using the <code>--name</code> flag).
varKerberosDns: Kerberos relies on DNS to identify machines involved in authentication. NFS clients and servers require DNS <code>A</code> records for forward-DNS look-ups and <code>PTR</code> records for reverse-DNS look-ups.
varNfsConf: In versions of Ubuntu lower than 22.04 (and possibly on other Linux distributions), you can't use the <code>/etc/nfs.conf</code> file to configure <code>gssd</code>. If this is the case for your system, we recommend starting the <code>rpc.gssd</code> service by using the <code>-n</code> flag.
unifySplitDepends: Depending on its [technical specifications](technical-specifications.html), your node uses _unified_ or _split networking configuration_.
splitNetDefine: This platform uses a _split networking configuration_ in which different NICs handle back-end and front-end traffic. You can connect the front-end and back-end NICs to the same switch or to different switches.
splitNetLACP: For all connection speeds, the default behavior is that of an LACP with 1,500 MTU for the front-end and 9,000 MTU for the back-end interfaces.
dontMixSingleDualNodes: Never network single-NIC and and dual-NIC nodes within the same cluster.
splitNetDualNICmustUseSplit: Never configure a dual-NIC platform with a unified networking configuration.
splitNetDontConnectSingleNIC: We don't recommend connecting to a single back-end NIC port because the node becomes unavailable if the single connection fails.
unifyNetDefine: This platform uses a _unified networking configuration_ in which the same NIC handles back-end and front-end traffic. In this configuration, each networking port provides communication with clients and between nodes. You can connect the NIC's ports to the same switch or to different switches.
use40gbps: You can use 40 Gbps connections with 40 Gbps transceivers.
jumboFramesPrereq: Before you create your Qumulo cluster, if your client environment requires Jumbo Frames (9,000 MTU), configure your switch to support a higher MTU.
noNIC: For this platform, all models ship without NICs.
seeTechSpecs: Some components may vary between node types. For information about your node, see <a href="technical-specifications.html">Technical Specifications</a>.
unusedEthPorts: The two rightmost Ethernet ports on the back of your node are unused.
dualNICfrontBackEnd: For dual-NIC nodes, the left NIC is for the front end and the right NIC is for the back end.
doNotWarpChassis: To avoid warping the chassis frame, always keep it level while you insert it into the server rack. Never insert the chassis at an angle and don't apply excessive pressure to it.
twoPeopleOrLift: We strongly recommend using a server lift or that two people perform this task.
varBearerTokenRecommend: As soon as you receive your bearer token, record it in a safe place.
varBearerTokenWarning: If you misplace the bearer token, you can't retrieve it at a later time. You must create a new access token.
a4200g9: HPE Apollo 4200 Gen9
a4200g10: HPE Apollo 4200 Gen10
a4200g10p: HPE Apollo 4200 Gen10 Plus
dl325g10p: HPE ProLiant DL325 Gen10 Plus
all4110: HPE Alletra 4110
sm1114sLong: Supermicro A+ WIO 1114S-WN10RT
sm1114s: Supermicro 1114S
sm1014sLong: Supermicro A+ ASG-1014S-ACR12N4H
sm1014s: Supermicro 1014S
sm2015sLong: Supermicro A+ ASG-2015S-E1CR24L
sm2015s: Supermicro 2015S
q1uhg2Long: Quiver 1U Hybrid Gen2
q1uhg2: Quiver 1UH Gen2
q1uag1Long: Quiver 1U All-NVMe Gen1
q1uag1: Quiver 1UA Gen1
fprx2540m7Long: Fujitsu PRIMERGY RX2540 M7
fprx2540m7: Fujitsu RX2540 M7
fprx2540m7followDocs: "Follow the instructions in the Fujitsu Upgrade and Maintenance Manual:"
q1uag1Drives:
frontStorageBays: There are 12 2.5" hot-swap NVMe drives attached with four screws to trays in front storage bays. For more information, see <a href="https://dlcdnets.asus.com/pub/ASUS/server/RS500A-E12-RS12U/Manual/E21507_RS500A-E12-RS12U_UM_V2_WEB.pdf?model=RS500A-E12-RS12U#page=45">Installing a 2.5-Inch Storage Device to a Front Storage Bay</a> in the ASUS documentation.
internalStorageBays: There are 4 2.5" NVMe drives in snap-in, toolless trays in internal storage bays. For more information, see <a href="https://dlcdnets.asus.com/pub/ASUS/server/RS500A-E12-RS12U/Manual/E21507_RS500A-E12-RS12U_UM_V2_WEB.pdf?model=RS500A-E12-RS12U#page=46">Installing a 2.5-Inch Storage Device to an Internal Storage Bay</a> in the ASUS documentation.
internalBootDrive: The boot drive is located at the M.2 expansion slot at connector NGFF1. For more information, see <a href="https://dlcdnets.asus.com/pub/ASUS/server/RS500A-E12-RS12U/Manual/E21507_RS500A-E12-RS12U_UM_V2_WEB.pdf?model=RS500A-E12-RS12U#page=58">Installing M.2 (NGFF) Cards</a> in the ASUS documentation.
qumuloalerts:
consTrans: The consumer processes for <a href="../configuring-integrations/email-server.html">email</a>, <a href="../configuring-integrations/ifttt.html">IFTTT</a>, and <a href="../configuring-integrations/sms-clicksend.html">SMS (ClickSend)</a> integrations translate messages into the recipient's native language.
locale: For the <code>--language</code> flag, see <a href="../getting-started/supported-language-locales.html">What Language Locales Qumulo Alerts Supports</a>.
tz: For the <code>--timezone</code> flag, see <a href="../getting-started/supported-language-locales.html#converting-time-zones">Converting Time Zones</a>.
testSuccess: A successful response returns the <code>[{ "ok": true }]</code> JSON output.
warningThreshold: For the <code>--warning</code> flag, the threshold must be lower than the thresholds of both the <code>--error</code> and <code>--critical</code> flags.
errorThreshold: For the <code>--error</code> flag, the threshold must be lower than the threshold of the <code>--critical</code> flag.
criticalThreshold: For the <code>--critical</code> flag, the threshold must be greater than the thresholds of both the <code>--warning</code> and <code>--error</code> flags.
shutdownQA: 1. To shut down Qumulo Alerts, navigate to its directory and run the <code>./stop-docker-qumulo-alerts.sh</code> command.
jsonNotTable: The output displays information in a table format. To view the output in JSON format, use the <code>--json</code> flag.
exampleOutput: The following is example output.
logIntoWebUI: Log in to the Qumulo Core Web UI.
protectingData:
contactQumuloCare: We strongly recommend contacting the <a href="/contacting-qumulo-care-team.html">Qumulo Care team</a> before proceeding with cluster expansion.
followAddNodeInstructions: 1. Follow the instructions in <a href="https://care.qumulo.com/hc/en-us/articles/360001070307">Add a New Node to an Existing Qumulo Cluster</a> on Qumulo Care.
checkCapacity: 1. Before you click **Yes** in the **Add <N> nodes to cluster <MyCluster>?** dialog box, check that the projected capacity matches the expected capacity.
monitorProcess: 1. To monitor this process, click **Cluster > Overview**. On the **Cluster** page, in the protection status section, you can view the rebalance phase status and the estimated time to completion.
mustHaveCryptoLib: To use this method, you must install the <a target="_blank" href="https://pypi.org/project/cryptography/">Python `cryptography` library</a>.
storeKeysProtectResources: In Qumulo Core 6.1.0 (and higher), you can store multiple ECDSA public keys in the Qumulo file system key store and use these keys to protect file system resources.
supportedKeys: Currently, Qumulo Core supports only 256-bit ECDSA keys in <code>.pem</code> and <code>.der</code> formats. Qumulo Core doesn't support storing ECDSA keys of other lengths and formats.
s3:
permissions:
APIorCLI: by using the Qumulo REST API or <code>qq</code> CLI
directAPI: You can also use the S3 API directly.
bucketsRead: the <code>PRIVILEGE_S3_BUCKETS_READ</code> privilege
bucketsWrite: the <code>PRIVILEGE_S3_BUCKETS_WRITE</code> privilege
timesUTC: All times are in the UTC time zone.
secretAccessKeys: After Qumulo Core initially creates your secret access keys, it never logs or displays them again. If you lose your secret access key, it isn't possible to recover it and you must create a new access key pair.
docs:
actions: https://docs.aws.amazon.com/AmazonS3/latest/API/API_Operations.html
bucketNamingRules: https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html
cli: https://aws.amazon.com/cli
multipartUpload: https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html
pathStyleAddressing: https://docs.aws.amazon.com/AmazonS3/latest/userguide/VirtualHosting.html#path-style-access
s3: https://docs.aws.amazon.com/AmazonS3/latest/userguide/Welcome.html
signatureV4: https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html
actions:
AbortMultipartUpload: https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html
CompleteMultipartUpload: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html
CopyObject: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html
CreateBucket: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html
CreateMultipartUpload: https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html
DeleteBucket: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html
DeleteObject: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html
DeleteObjects: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html
GetBucketLocation: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLocation.html
GetObject: https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html
HeadBucket: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html
HeadObject: https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html
ListBuckets: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html
ListMultipartUploads: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html
ListObjects: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html
ListObjectsV2: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html
ListParts: https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html
PutObject: https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html
UploadPart: https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html
azure:
qumuloOnAzureLong: Azure Native Qumulo
qumuloOnAzureShort: ANQ
emailAzure: email <a href="mailto:azure@qumulo.com">Azure Native Qumulo Support</a>
pricingCalculator: For more information about pay-as-you-go price estimates, see the <a href="https://azure.qumulo.com/calculator">Pricing and Performance Calculator</a>.
detailedDeploymentInstructions: For detailed instructions, see <a href="deploying-instance-azure-native-qumulo.html">Deploying and Viewing Information about Your Azure Native Qumulo Instance</a>.
anqColdImpact: The storage class has an impact on billing, metering, and how the system stores data.
varonis:
separateMachine: Deploy Qumulo Broker on a stand-alone machine (or virtual machine) so that it sits between your Qumulo cluster and Varonis.
restartRsyslog: To restart the rsyslog service, run the `systemctl restart rsyslog` command.
monitoring:
cloudBasedMonitoringEnabled: If your configuration is valid, the Qumulo Core Web UI shows the status **Enabled | Connected**.
changeNotify:
useRESTnotSMB: Qumulo provides REST access to the same [change notification system](how-file-system-change-notifications-work.html) that backs SMB2 `CHANGE_NOTIFY`. Because the notification interface and types are easier to work with compared to SMB2, we recommend programming by using REST rather than SMB `CHANGE_NOTIFY`.
RBACoverrides: For the S3 API and Qumulo REST API, if a user has the <a href="https://care.qumulo.com/hc/en-us/articles/360036591633">role-based access control privilege (RBAC)</a> to perform an API action, Qumulo Core <a href="#rbac-overrides">ignores the access policy</a> and permits the API action.
udm:
t: User-Defined Metadata
s: User-defined metadata
l: user-defined metadata
hex: To specify a non-text value for the user-defined metadata, use the <code>--base64-value</code> or <code>--hex-value</code> flag.
snap: To access the user-defined metadata within a file snapshot, use the <code>--snapshot</code> flag and specify the shapshot ID.
guides:
anq: Azure Native Qumulo Administrator Guide
onprem: Qumulo On-Premises Administrator Guide
alert: Qumulo Alerts Administrator Guide
cli: Qumulo <code>qq</code> CLI Command Guide
hard: Qumulo-Certified Hardware Servicing Guide
integ: Qumulo Integration Guide
xrefUSBinstaller: <a href="https://docs.qumulo.com/hardware-guide/getting-started/creating-usb-drive-installer.html" class="no_icon">Qumulo Core USB Drive Installer</a>
xref:
adminANQ:
manageVersioningS3: <a href="https://docs.qumulo.com/azure-administrator-guide/s3-api/managing-s3-bucket-versioning.html">Managing S3 Bucket Versioning in a Qumulo Cluster</a> in the Azure Native Qumulo Administrator Guide
manageAccessS3: <a href="https://docs.qumulo.com/azure-administrator-guide/s3-api/managing-access-policies-for-s3-buckets.html">Managing Access Policies for an S3 Bucket in a Qumulo Cluster</a> in the Azure Native Qumulo Administrator Guide
manageRBAC: <a href="https://docs.qumulo.com/azure-administrator-guide/authorization-qumulo-core/managing-role-based-access-control-rbac.html">Managing Role-Based Access Control (RBAC) for Users and Groups in Qumulo Core</a> in the Azure Native Qumulo Administrator Guide
usingSMBhostRestrict: <a href="https://docs.qumulo.com/azure-administrator-guide/authorization-qumulo-core/using-smb-host-restrictions.html">Using SMB Host Restrictions in Qumulo Core</a> in the Azure Native Qumulo Administrator Guide
manageSMB3encrypt: <a href="https://docs.qumulo.com/azure-administrator-guide/encryption-data-security/managing-smb3-encryption-in-transit.html">Managing SMB3 Encryption in Transit in Qumulo Core</a> in the Azure Native Qumulo Administrator Guide
adminOnPrem:
manageVersioningS3: <a href="https://docs.qumulo.com/administrator-guide/s3-api/managing-s3-bucket-versioning.html">Managing S3 Bucket Versioning in a Qumulo Cluster</a> in the Qumulo On-Premises Administrator Guide
manageAccessS3: <a href="https://docs.qumulo.com/administrator-guide/s3-api/managing-access-policies-for-s3-buckets.html">Managing Access Policies for an S3 Bucket in a Qumulo Cluster</a> in the Qumulo On-Premises Administrator Guide
manageRBAC: <a href="https://docs.qumulo.com/administrator-guide/authorization-qumulo-core/managing-role-based-access-control-rbac.html">Managing Role-Based Access Control (RBAC) for Users and Groups in Qumulo Core</a> in the Qumulo On-Premises Administrator Guide
usingSMBhostRestrict: <a href="https://docs.qumulo.com/administrator-guide/authorization-qumulo-core/using-smb-host-restrictions.html">Using SMB Host Restrictions in Qumulo Core</a> in the Qumulo On-Premises Administrator Guide
manageSMB3encrypt: <a href="https://docs.qumulo.com/administrator-guide/encryption-data-security/managing-smb3-encryption-in-transit.html">Managing SMB3 Encryption in Transit in Qumulo Core</a> in the Qumulo On-Premises Administrator Guide
smbCLI:
addModSameFlag: The <code>qq smb_add_share</code> and <code>qq smb_mod_share</code> commands use the same flags.
addModCommand: specify the path, share name, and <a href="https://docs.qumulo.com/administrator-guide/authorization-qumulo-core/using-smb-host-restrictions.html#how-smb-host-restriction-precedence-works">host restriction level</a>.