Skip to content

Commit

Permalink
Hyperlinked commands to qq CLI guide.
Browse files Browse the repository at this point in the history
  • Loading branch information
shefulloflight committed Mar 22, 2024
1 parent 20a37f7 commit b68be06
Show file tree
Hide file tree
Showing 12 changed files with 27 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ The `auth_create_access_token` command returns a JSON response that contains the

<a id="create-token-expiration-time"></a>
### To Create an Access Token with an Expiration Time
In Qumulo Core 5.3.2 (and higher), you can use the `auth_create_access_token --expiration-time` command and specify the expiration time. You can specify the expiration time in different formats. For example:
In Qumulo Core 5.3.2 (and higher), you can use the {% include qq.html command="auth_create_access_token" %} command and specify the expiration time. You can specify the expiration time in different formats. For example:

```bash
$ qq auth_create_access_token jane --expiration-time 'Jan 01 2023'
Expand Down Expand Up @@ -219,13 +219,13 @@ To help you check your system's security posture, Qumulo Core lets you disable a
{% capture content_disable_token %}After you disable an access token, {{page.varBearerToken}}{% endcapture %}
{% include important.html content=content_disable_token %}

To disable an access token, use the `auth_modify_access_token` command, specify the access token ID, and use the `-d` flag. For example:
To disable an access token, use the {% include qq.html command="auth_modify_access_token" %} command, specify the access token ID, and use the `-d` flag. For example:

```bash
$ qq auth_modify_access_token 1234567890123456789012 -d
```

To enable an access token, use the `auth_modify_access_token` command, specify the access token ID, and use the `-e` flag. For example:
To enable an access token, use the {% include qq.html command="auth_modify_access_token" %} command, specify the access token ID, and use the `-e` flag. For example:

```bash
$ qq auth_modify_access_token 1234567890123456789012 -e
Expand All @@ -238,7 +238,7 @@ $ qq auth_modify_access_token 1234567890123456789012 -e
{% capture content_disable_token %}After you delete an access token, {{page.varBearerToken}}{% endcapture %}
{% include important.html content=content_disable_token %}

To delete an access token, use the `auth_delete_access_token` command and specify the access token ID. For example:
To delete an access token, use the {% include qq.html command="auth_delete_access_token" %} command and specify the access token ID. For example:

```bash
$ qq auth_delete_access_token 1234567890123456789012
Expand Down
2 changes: 1 addition & 1 deletion _includes/content-reuse/admin-guides/nfs/nfsv4.1-acls.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ For more information about NFSv4.1, see [Enabling and Using NFSv4.1 on a Qumulo
In most Linux distributions, the `nfs-acl-tools` package contains the NFSv4.1 commands that let you manage ACLs for files.

### Showing the ACL of a File
To show the ACL of a file, use the `nfs4_getfacl` command. In the following example, we create the file `my-file` and then show the ACL for it.
To show the ACL of a file, use the {% include qq.html command="nfs4_getfacl" %} command. In the following example, we create the file `my-file` and then show the ACL for it.

```bash
$ touch /mnt/qumulo/my-file
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ This section describes how to use the Qumulo Core Web UI 4.2.5 (and higher) to c
This section describes how to use the Qumulo CLI to copy files from Amazon S3 to a Qumulo cluster, review Shift relationship details, stop a running copy job, repeat a completed copy job, and delete a relationship.

### Copying Files to Amazon S3
To copy files, use the `replication_create_object_relationship` command and specify the following:
To copy files, use the {% include qq.html command="replication_create_object_relationship" %} command and specify the following:
* Local directory path on Qumulo cluster
* Copy direction (copy-from)
* S3 object folder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ This section describes how to use the Qumulo Core Web UI 3.2.5 (and higher) to c
This section describes how to use the Qumulo CLI 3.2.5 (and higher) to copy files from a Qumulo cluster to Amazon S3, review Shift relationship details, stop a running copy job, repeat a completed copy job, and delete a relationship.

### Copying Files from Amazon S3
To copy files, use the `replication_create_object_relationship` command and specify the following:
To copy files, use the {% include qq.html command="replication_create_object_relationship" %} command and specify the following:
* Local directory path on Qumulo cluster
* Copy direction (copy-to)
* S3 object folder
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ You can list the incomplete multipart uploads for a single S3 bucket by using th
</ul>
{{site.data.alerts.end}}

* To list incomplete uploads by using the `qq` CLI, use the `s3_list_uploads` command and specify the bucket name. For example:
* To list incomplete uploads by using the `qq` CLI, use the {% include qq.html command="s3_list_uploads" %} command and specify the bucket name. For example:

```bash
$ qq s3_list_uploads \
Expand Down Expand Up @@ -121,7 +121,7 @@ Qumulo Core automatically aborts and cleans up an incomplete multipart S3 if the

When Qumulo Core removes a multipart upload, it frees up the space that the upload uses on the cluster. You can configure the expiry interval by using the Qumulo Core REST API or `qq` CLI.

To configure the expiry interval for all current and future multipart uploads by using the `qq` CLI, use the `s3_modify_settings` command and the `--multipart-upload-expiry-interval` flag and specify one of the following:
To configure the expiry interval for all current and future multipart uploads by using the `qq` CLI, use the {% include qq.html command="s3_modify_settings" %} command and the `--multipart-upload-expiry-interval` flag and specify one of the following:

* The string `never`.

Expand Down Expand Up @@ -154,7 +154,7 @@ Use the Qumulo Core REST API or `qq` CLI to abort and clean up the upload. You n

{% include note.html content="If you are an administrative user or the user who initiated the upload, you can use the `AbortMultipartUpload` S3 API action. In addition to the bucket name and upload ID, you also need the object key for the upload." %}

* To abort an upload by using the `qq` CLI, use the `s3_abort_upload` command and specify the upload ID. For example:
* To abort an upload by using the `qq` CLI, use the {% include qq.html command="s3_abort_upload" %} command and specify the upload ID. For example:

```bash
$ qq s3_abort_upload \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@ In Qumulo Core 5.1.0 (and higher), clusters have an optional _inactivity timeout
{% include note.html content="During the final minute of the timeout period, the **Your Session is About to Expire** dialog box appears. The dialog box shows a countdown and lets the user renew the session or log out immediately. When deciding on the timeout length, take your users' needs into consideration." %}

## To Set the Qumulo Core Web UI Inactivity Timeout
To set an inactivity timeout, use the `web_ui_modify_settings` command. Specify the timeout in minutes by using the `--inactivity-timeout` flag. For example:
To set an inactivity timeout, use the {% include qq.html command="web_ui_modify_settings" %} command and use the `--inactivity-timeout` flag to specify the timeout in minutes. For example:

```bash
qq web_ui_modify_settings --inactivity-timeout 15
```

## To Clear the Qumulo Core Web UI Inactivity Timeout
To clear an inactivity timeout, use the `web_ui_modify_settings` command with the `--disable-inactivity-timeout` flag.
To clear an inactivity timeout, use the {% include qq.html command="web_ui_modify_settings" %} command and use the `--disable-inactivity-timeout` flag.

```bash
qq web_ui_modify_settings --disable-inactivity-timeout
```

## To View the Current Web UI Inactivity Timeout
To view the current inactivity timeout, use the `web_ui_get_settings` command:
To view the current inactivity timeout, use the {% include qq.html command="web_ui_get_settings" %} command:

```bash
qq web_ui_get_settings
Expand Down
6 changes: 3 additions & 3 deletions _includes/content-reuse/admin-guides/web-ui/login-banner.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
In Qumulo Core 5.2.1 (and higher), clusters have an optional login banner that users must acknowledge before being they can log in to the Qumulo Core Web UI.

## To Set the Qumulo Core Web UI Login Banner
To set the login banner, use the `web_ui_modify_settings` command. To specify the Markdown file to use for the banner, use the `--login-banner` flag. For example:
To set the login banner, use the {% include qq.html command="web_ui_modify_settings" %} command. To specify the Markdown file to use for the banner, use the `--login-banner` flag. For example:

```bash
qq web_ui_modify_settings --login-banner my-banner.html
```

## To Clear the Qumulo Core Web UI Login Banner
To clear the login banner, use the `web_ui_modify_settings` command with the `--disable-login-banner` flag.
To clear the login banner, use the {% include qq.html command="web_ui_modify_settings" %} command and use the `--disable-login-banner` flag.

```bash
qq web_ui_modify_settings --disable-login-banner
```

## To View the Current Web UI Login Banner
To view the current login banner, use the `web_ui_get_settings` command with the `--login-banner` flag.
To view the current login banner, use the {% include qq.html command="web_ui_get_settings" %} command and use the `--login-banner` flag.

```bash
qq web_ui_get_settings --login-banner
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
### Viewing Configuration Details and Status of Shift Relationships
* To view configuration details for all Shift relationships, use the `replication_list_object_relationships` command.
* To view configuration details for all Shift relationships, use the {% include qq.html command="replication_list_object_relationships" %} command.

* To view configuration details for a specific relationship, use the `replication_get_object_relationship` command followed by the `--id` and the Shift relationship ID (GUID), for example:
* To view configuration details for a specific relationship, use the {% include qq.html command="replication_get_object_relationship" %} command followed by the `--id` and the Shift relationship ID (GUID), for example:

```bash
qq replication_get_object_relationship --id 1c23b4ed-5c67-8f90-1e23-a4f5f6ceff78
```

* To view the status of a specific relationship, use the `replication_get_object_relationship_status` command followed by the `--id` and the Shift relationship ID.
* To view the status of a specific relationship, use the {% include qq.html command="replication_get_object_relationship_status" %} command followed by the `--id` and the Shift relationship ID.

* To view the status of all relationships, use the `replication_list_object_relationship_statuses` command.
* To view the status of all relationships, use the {% include qq.html command="replication_list_object_relationship_statuses" %} command.

The CLI returns the details of all relationships in JSON format, for example:
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
### Stopping a Copy Job in Progress
To stop a copy job already in progress, use the `replication_abort_object_relationship` command followed by the `--id` and the Shift relationship ID.
To stop a copy job already in progress, use the {% include qq.html command="replication_abort_object_relationship" %} command and use the `--id` flag to specify the Shift relationship ID.

### Repeating a Completed Copy Job
To repeat a completed copy job, use the `replication_start_object_relationship` command followed by the `--id` and the Shift relationship ID.
To repeat a completed copy job, use the {% include qq.html command="replication_start_object_relationship" %} command and use the `--id` flag to specify the Shift relationship ID.

This command begins a new job for the existing relationship and downloads any content that changed in the S3 bucket or on the Qumulo cluster since the time the previous job ran.

### Deleting a Shift Relationship
After your copy job is complete, you can delete your Shift relationship. To do this, run the `replication_delete_object_relationship` command followed by the `--id` and the Shift relationship ID.
After your copy job is complete, you can delete your Shift relationship. To do this, run the `replication_delete_object_relationship` command and use the `--id` flag to specify the Shift relationship ID.

{% include note.html content="You can run this command only against a relationship that doesn't have any active jobs running." %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ redirect_from:
- /administrator-guide/qumulo-core/installing-vpn-keys-on-cluster.html
sidebar: administrator_guide_sidebar
varCopyFile: 1. Copy the `.zip` file from Qumulo Care to a computer on the same network as your cluster, and decompress the file.
varVerifyKeys: 1. To verify that the VPN keys installed correctly, use the `get_vpn_keys` command. For example&#58;
varVerifyKeys: 1. To verify that the VPN keys installed correctly, use the {% include qq.html command="get_vpn_keys" %} command. For example&#58;
---

{% capture dontDoIt %}Follow these steps only if a member of the Qumulo Care team instructs you to do so. Performing these steps incorrectly can cause network performance, connectivity, and data integrity issues. It can also expose your cluster to unauthorized access. For help with this task, {{site.contactQumuloCare}}.{% endcapture %}
Expand Down Expand Up @@ -99,7 +99,7 @@ Before you begin, make sure that you have done the following.

## To Register Cluster with Cloud-Based Monitoring

1. To retrieve your cluster ID, use the `node_state_get` command.
1. To retrieve your cluster ID, use the {% include qq.html command="node_state_get" %} command.

1. Send the output of the command to Qumulo Care.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ $ qq multitenancy_get_tenant \

* Click **Cluster > Network Multitenancy**.

* In the `qq` CLI, use the `multitenancy_list_tenants` command.
* In the `qq` CLI, use the {% include qq.html command="multitenancy_list_tenants" %} command.

#### Determining the Tenant Assignment for Networks
* To view the information for a single network, use the `qq network_get_network` command.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ To be able to generate access tokens, you must create a local user for Qumulo Al

1. Use SSH to log in to any node in your cluster.

1. To create a local user, use the `auth_add_user` command and specify a name and password.
1. To create a local user, use the {% include qq.html command="auth_add_user" %} command and specify a name and password.

```bash
qq auth_add_user --name QumuloAlerts \
Expand Down

0 comments on commit b68be06

Please sign in to comment.