Skip to content

Commit

Permalink
Use the foo command -> Run the foo command
Browse files Browse the repository at this point in the history
  • Loading branch information
shefulloflight committed Mar 12, 2024
1 parent 54dea1c commit 39072ec
Show file tree
Hide file tree
Showing 24 changed files with 62 additions and 62 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This section explains how to generate a 256-bit ECDSA private key by using Linux
### To Generate a Private Key by Using Linux CLI Tools
To generate a key in the `.pem` format, use the `openssl` or `ssh-keygen` tools.

* Use the `openssl` command and specify the path to the private key. For example:
* Run the `openssl` command and specify the path to the private key. For example:

```bash
openssl ecparam \
Expand All @@ -23,7 +23,7 @@ To generate a key in the `.pem` format, use the `openssl` or `ssh-keygen` tools.
-out /private-key-path
```

* Use the `ssh-keygen` command and specify the path to the private key. For example:
* Run the `ssh-keygen` command and specify the path to the private key. For example:

```bash
ssh-keygen \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This section explains how to add a public key to the Qumulo file system key stor
{% capture cryptoLib %}{{site.protectingData.mustHaveCryptoLib}}{% endcapture %}
{% include note.html content=cryptoLib %}

Use the `qq fs_security_add_key` command and specify the key name, the path to the private key file, and an optional comment. For example:
Run the `qq fs_security_add_key` command and specify the key name, the path to the private key file, and an optional comment. For example:

```bash
qq fs_security_add_key \
Expand All @@ -29,7 +29,7 @@ qq fs_security_add_key \
```

### If You Don't Have Direct Access to the Private Key
Use the `qq fs_security_add_key` command and specify the key name, the public key contents, the Base64-encoded verification signature (the key name signed with the private key), and an optional comment. For example:
Run the `qq fs_security_add_key` command and specify the key name, the public key contents, the Base64-encoded verification signature (the key name signed with the private key), and an optional comment. For example:

```bash
qq fs_security_add_key \
Expand All @@ -52,7 +52,7 @@ For more information, see [Extracting the Public Key from an ECDSA Private Key](

<a id="retrieve-key-usage"></a>
## Retrieving Public Key Usage Information
Use the `qq fs_security_get_usage` command and specify the key identifier or name.
Run the `qq fs_security_get_usage` command and specify the key identifier or name.

{{site.jsonNotTable}}

Expand All @@ -74,7 +74,7 @@ This section explains how to rotate a public key in the Qumulo file system key s
### If You Have Access to the Existing and Replacement Private Keys
{% include note.html content=cryptoLib %}

Use the `qq fs_security_replace_key` command and specify the key identifier or name, the path to the existing private key, and the path to the replacement private key. For example:
Run the `qq fs_security_replace_key` command and specify the key identifier or name, the path to the existing private key, and the path to the replacement private key. For example:

```bash
qq fs_security_replace_key \
Expand Down Expand Up @@ -121,7 +121,7 @@ When you add a key to the Qumulo file system key store, Qumulo Core enables it a


## Deleting a Public Key
Use the `qq fs_security_delete_key` command and specify the key identifier or name.
Run the `qq fs_security_delete_key` command and specify the key identifier or name.

{% capture unlockBeforeDelete %}It isn't possible to delete a key that a Qumulo file system resource uses. {{page.varXrefUsage}}{% endcapture %}
{% include note.html content=unlockBeforeDelete %}
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Access tokens are long-lived. They provide an alternative to session-based authe
{{page.varPrereqWrite}} This section explains how to create access tokens without or with an expiration time by using the `qq` CLI.

### To Create an Access Token without an Expiration Time
Use the `auth_create_access_token` command and specify the user. For example:
Run the `auth_create_access_token` command and specify the user. For example:

```bash
$ qq auth_create_access_token jane
Expand Down Expand Up @@ -130,7 +130,7 @@ $ qq --credentials-store ./qumulo_credentials who_am_i
{{page.varPrereqRead}} This section explains how to get metadata for a specific access token or all access tokens by using the `qq` CLI.

### To Get Metadata for a Specific Access Token
Use the `auth_get_access_token` command and specify the access token ID. For example:
Run the `auth_get_access_token` command and specify the access token ID. For example:

```bash
$ qq auth_get_access_token 1234567890123456789012
Expand Down Expand Up @@ -167,7 +167,7 @@ For example:
```

### To Get Metadata for All Access Tokens
Use the `qq auth_list_access_tokens` command.
Run the `qq auth_list_access_tokens` command.

{{site.data.alerts.important}}
Listing access tokens <em>doesn't</em> return the bearer token required for authentication. {{site.varBearerTokenWarning}}
Expand Down Expand Up @@ -197,7 +197,7 @@ To filter the command's output by user, use the `--user` flag and use the same f
## Modifying the Expiration Time for an Access Token
{{page.varPrereqWrite}} This section explains how to modify access tokens by using the `qq` CLI.

Use the `auth_modify_access_token` command and specify the access token ID and the expiration time. For example:
Run the `auth_modify_access_token` command and specify the access token ID and the expiration time. For example:

```bash
$ qq auth_modify_access_token 1234567890123456789012 --expiration-time 'Jan 01 2023'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Managing {{site.udm.l}} requires the following privileges:
* `WRITE_EA`: Write to, or delete, the {{site.udm.l}} of a file

### To Create a Generic {{site.udm.t}} Entry for a File by Using the qq CLI
Use the `fs_set_user_metadata` command and specify the path to the file, the key, and the value. For example:
Run the `fs_set_user_metadata` command and specify the path to the file, the key, and the value. For example:

```bash
qq fs_set_user_metadata \
Expand Down Expand Up @@ -62,7 +62,7 @@ qq fs_get_user_metadata \
For more information, see [`qq fs_get_user_metadata`](https://docs.qumulo.com/qq-cli-command-guide/fs/fs_get_user_metadata.html) in the {{site.guides.cli}}.

### To List All Generic {{site.udm.t}} Entries for a File by Using the qq CLI
Use the `fs_list_user_metadata` command and specify the path to the file. For example:
Run the `fs_list_user_metadata` command and specify the path to the file. For example:

```bash
qq fs_list_user_metadata \
Expand All @@ -75,7 +75,7 @@ qq fs_list_user_metadata \
For more information, see [`qq fs_list_user_metadata`](https://docs.qumulo.com/qq-cli-command-guide/fs/fs_list_user_metadata.html) in the {{site.guides.cli}}.

### To Delete a Generic {{site.udm.t}} Entry for a File by Using the qq CLI
Use the `fs_delete_user_metadata` command and specify the path to the file and the key. For example:
Run the `fs_delete_user_metadata` command and specify the path to the file and the key. For example:

```bash
qq fs_delete_user_metadata \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Qumulo Core applies the host access rule to the NFS export.
}
```

1. Use the `qq nfs_mod_export` command and specify the export path and the file with the host access rules. For example:
1. Run the `qq nfs_mod_export` command and specify the export path and the file with the host access rules. For example:

```bash
qq nfs_mod_export \
Expand Down Expand Up @@ -191,7 +191,7 @@ This section describes the troubleshooting steps for a scenario in which an NFS

To reset your Qumulo cluster's DNS cache, use the `qq dns_clear_lookup_cache` command.

* Use the `qq dns_resolve_hostnames` command and specify the hostname to perform a lookup for `user1.accounting.example.com`.
* Run the `qq dns_resolve_hostnames` command and specify the hostname to perform a lookup for `user1.accounting.example.com`.

{{site.commandOutput}}

Expand All @@ -203,7 +203,7 @@ This section describes the troubleshooting steps for a scenario in which an NFS
}]
```

* Use the `qq dns_resolve_ips` command to find the hostname for your client's IP address and:
* Run the `qq dns_resolve_ips` command to find the hostname for your client's IP address and:

* If the NFS client can't access a share, but should be able to, add the IP address to the NFS export's host access rules.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ To create and manage S3 buckets, you must configure AWS CLI to work with your Qu
## Step 5: Create an S3 Bucket
{% include note.html content="Creating buckets requires the `PRIVILEGE_S3_BUCKETS_WRITE` [role-based access control (RBAC)](https://care.qumulo.com/hc/en-us/articles/360036591633) privilege and permission to create a directory under the cluster's root directory." %}
Use the `aws s3api create-bucket` command and specify the bucket name. For example:
Run the `aws s3api create-bucket` command and specify the bucket name. For example:
```bash
$ aws s3api create-bucket \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ To revoke an S3 access key, you must delete the access key from your Qumulo clus
To revoke an access key, you must have {{site.s3.permissions.bucketsWrite}}.
### To Delete an S3 Access Key by Using the qq CLI
Use the `qq s3_delete_access_key` command and specify the access key ID. For example:
Run the `qq s3_delete_access_key` command and specify the access key ID. For example:
```bash
$ qq s3_delete_access_key \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ When you use the `qq` CLI to create a bucket, you can use a new or existing dire
```

### Creating an S3 Bucket by Using the S3 API
Use the `aws s3api create-bucket` command and specify the bucket name. This command uses the [`CreateBucket`]({{site.s3.actions.CreateBucket}}) S3 API action. For example:
Run the `aws s3api create-bucket` command and specify the bucket name. This command uses the [`CreateBucket`]({{site.s3.actions.CreateBucket}}) S3 API action. For example:

```bash
$ aws s3api create-bucket \
Expand All @@ -191,7 +191,7 @@ Although you can configure global settings, such as the {{page.varDefaultPrefix}
* To change the bucket configuration, you need {{site.s3.permissions.bucketsWrite}}.

### Viewing the Current S3 Bucket Configuration by Using the qq CLI
Use the `qq s3_get_bucket` command and specify the bucket name. For example:
Run the `qq s3_get_bucket` command and specify the bucket name. For example:

```bash
$ qq s3_get_bucket \
Expand All @@ -216,7 +216,7 @@ You can list all S3 buckets in your Qumulo cluster {{site.s3.permissions.APIorCL
### To List S3 Buckets by Using the qq CLI
To list your S3 buckets {{site.s3.permissions.APIorCLI}}, you need {{site.s3.permissions.bucketsRead}}.

* Use the `qq s3_list_buckets` command.
* Run the `qq s3_list_buckets` command.

{{site.s3.permissions.commandOutput}} {{site.s3.permissions.timesUTC}}

Expand Down Expand Up @@ -244,7 +244,7 @@ To list your S3 buckets {{site.s3.permissions.APIorCLI}}, you need {{site.s3.per
```

### To List S3 Buckets by Using the S3 API
Use the `aws s3api list-buckets` command. This command uses the [`ListBuckets`]({{site.s3.actions.ListBuckets}}) S3 API action.
Run the `aws s3api list-buckets` command. This command uses the [`ListBuckets`]({{site.s3.actions.ListBuckets}}) S3 API action.

{{site.s3.permissions.commandOutput}} {{site.s3.permissions.timesUTC}} {{page.varListJSON}}

Expand Down Expand Up @@ -306,7 +306,7 @@ When you use the `qq` CLI to delete a bucket, you can choose to also delete the
* {{page.varRootDirNotEmpty}}

### Deleting an S3 Bucket by Using the S3 API
Use the `aws s3api delete-bucket` command and specify the bucket name. This command uses the [`DeleteBucket`]({{site.s3.actions.DeleteBucket}}) S3 API action. For example:
Run the `aws s3api delete-bucket` command and specify the bucket name. This command uses the [`DeleteBucket`]({{site.s3.actions.DeleteBucket}}) S3 API action. For example:

```bash
$ aws s3api delete-bucket \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ To add ACEs to a directory, use the `qq` CLI or use the File Explorer on a Windo
The following sections show how to use the `qq` CLI to imitate bucket-level permissions by adding inheritable ACEs.

### Imitating Bucket-Level Read-Write Access
Use the `qq fs_modify_acl` command. In the following example, we add the access control entry (ACE) to the bucket whose root directory is `/buckets/my-bucket` for the user group `MyWriters`.
Run the `qq fs_modify_acl` command. In the following example, we add the access control entry (ACE) to the bucket whose root directory is `/buckets/my-bucket` for the user group `MyWriters`.

```bash
$ qq fs_modify_acl \
Expand All @@ -146,7 +146,7 @@ Allowed Object inherit, Container inherit Delete child, Execute/Traverse, Read

<a id="bucket-level-read-access"></a>
### Imitating Bucket-Level Read-Only Access
Use the `qq fs_modify_acl` command. In the following example, we add the access control entry (ACE) to the bucket whose root directory is `/buckets/my-bucket` for the user group `MyReaders`:
Run the `qq fs_modify_acl` command. In the following example, we add the access control entry (ACE) to the bucket whose root directory is `/buckets/my-bucket` for the user group `MyReaders`:

```bash
$ qq fs_modify_acl
Expand All @@ -166,7 +166,7 @@ Allowed Object inherit, Container inherit Execute/Traverse, Read
```

### Imitating Bucket-Level List-Only Access
Use the `qq fs_modify_acl` command. In the following example, we add two access control entries (ACEs) to the bucket whose root directory is `/buckets/my-bucket` for the user group `MyListers`.
Run the `qq fs_modify_acl` command. In the following example, we add two access control entries (ACEs) to the bucket whose root directory is `/buckets/my-bucket` for the user group `MyListers`.

```bash
$ qq fs_modify_acl
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ In Qumulo Core 6.1.0.3 (and higher), you can [lock a snapshot by using a key loc
In Qumulo Core 6.1.1 (and higher), you can [ensure that a replication target relationship locks all new policy snapshots with a specific key](#replication-target-locking) by associating the key with the replication target.

### To Lock a Snapshot by Using the qq CLI
Use the `qq snapshot_lock_snapshot` command and specify the snapshot ID and either the key ID or key name. For example:
Run the `qq snapshot_lock_snapshot` command and specify the snapshot ID and either the key ID or key name. For example:

```bash
qq snapshot_lock_snapshot \
Expand All @@ -30,7 +30,7 @@ Unlocking a snapshot requires proving that you can sign a challenge by using the
{% capture cryptoLib %}{{site.protectingData.mustHaveCryptoLib}}{% endcapture %}
{% include note.html content=cryptoLib %}

Use the `qq snapshot_unlock_snapshot` command and specify the snapshot ID and the path to the private key file. For example:
Run the `qq snapshot_unlock_snapshot` command and specify the snapshot ID and the path to the private key file. For example:

```bash
qq snapshot_unlock_snapshot \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ This section explains how to create snapshots on a schedule, create a snapshot w

<a id="create-snapshot-with-policy"></a>
### Creating Snapshots on a Schedule by Using a Snapshot Policy
Use the `qq snapshot_create_policy` command to create a snapshot policy and specify the interval at which Qumulo Core takes and deletes snapshots.
Run the `qq snapshot_create_policy` command to create a snapshot policy and specify the interval at which Qumulo Core takes and deletes snapshots.

In the following example, we create a policy named `every_day` that takes a snapshot every midnight in the Pacific time zone and retains the snapshot for two days. Every new snapshot that this policy creates is locked with a key named `my-key-name`. {{page.varSeeLockUnlock}}

Expand Down Expand Up @@ -127,7 +127,7 @@ qq snapshot_modify_policy change_to_hourly_or_less \
```

### Creating an On-Demand Snapshot with an Expiration Time
Use the `qq_snapshot_create_snapshot` command to specify an expiration date or expiration time before Qumulo Core deletes the snapshot.
Run the `qq_snapshot_create_snapshot` command to specify an expiration date or expiration time before Qumulo Core deletes the snapshot.

{% include note.html content="If you don't specify an expiration date or expiration time before deletion, Qumulo Core never deletes the snapshot." %}

Expand All @@ -146,7 +146,7 @@ qq snapshot_create_snapshot \
```

### Modifying a Snapshot's Expiration Time
Use the `qq snapshot_modify_snapshot` command and specify the snapshot ID from the **Saved Snapshots** page in the Qumulo Core Web UI (for example, for the `1234567_replication_from_prod` snapshot, the ID is `1234567`).
Run the `qq snapshot_modify_snapshot` command and specify the snapshot ID from the **Saved Snapshots** page in the Qumulo Core Web UI (for example, for the `1234567_replication_from_prod` snapshot, the ID is `1234567`).

In the following example, the snapshot with ID `1234567` never expires.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ The following is a list of available notification types in [SSE event payloads](


## Streaming Change Notifications by Using the qq CLI
Use the `qq fs_notify` command and specify the path to a directory. For example:
Run the `qq fs_notify` command and specify the path to a directory. For example:

```bash
qq fs_notify --path /my/directory
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ This section explains how to retrieve the status or detailed information about a

<a id="encryption-get-status"></a>
### To View the Status of an Active Encryption Configuration
Use the `qq encryption_get_status` command.
Run the `qq encryption_get_status` command.

{{page.varLocalKey}}

Expand All @@ -60,7 +60,7 @@ Use the `qq encryption_get_status` command.

<a id="encryption-get-key-store"></a>
### To View Detailed Information for an Active Encryption Configuration
Use the `qq encryption_get_key_store` command.
Run the `qq encryption_get_key_store` command.

{{page.varLocalKey}}

Expand Down Expand Up @@ -144,14 +144,14 @@ This section explains how to rotate the master key and check the encryption stat
{% include caution.html content="[Qumulo Care](https://docs.qumulo.com/contacting-qumulo-care-team.html) team members can help you [rotate your master keys](#rotate-master-key). However, they don't have access to your encryption keys and can't retrieve them for you." %}

### To Rotate Master Keys Stored Locally
1. Use the `qq rotate_encryption_keys` command.
1. Run the `qq rotate_encryption_keys` command.

When the process is complete, the command shows the `Key rotation complete` message.

1. To view your cluster's encryption status and the last key rotation time, [use the `qq encryption_get_status` command](#encryption-get-status).

### To Rotate Master Keys Stored in a Key Management Server (KMS)
1. Use the `qq rotate_encryption_keys` command and specify the key ID. For example:
1. Run the `qq rotate_encryption_keys` command and specify the key ID. For example:

```bash
qq rotate_encryption_keys --key-id {{page.varExampleKeyID}}
Expand Down
Loading

0 comments on commit 39072ec

Please sign in to comment.