Skip to content

Commit

Permalink
Normalizing nomenclature; fixing links.
Browse files Browse the repository at this point in the history
  • Loading branch information
shefulloflight committed Mar 22, 2024
1 parent 2a8cff5 commit a9b37e6
Show file tree
Hide file tree
Showing 12 changed files with 23 additions and 23 deletions.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{% capture differentTerms %}It is possible to confuse the terms _access token_ and _session token_. Unlike access tokens, session tokens are short-lived and require a password to refresh, for example, to authenticate by using the {% include qq.html command="qq login" %} command. Access tokens are the focus of this section.{% endcapture %}
{% capture differentTerms %}It is possible to confuse the terms _access token_ and _session token_. Unlike access tokens, session tokens are short-lived and require a password to refresh, for example, to authenticate by using the {% include qq.html command="login" %} command. Access tokens are the focus of this section.{% endcapture %}
{% include tip.html content=differentTerms %}

In Qumulo Core 5.3.0 (and higher), you can use _access tokens_ to let a user authenticate to the Qumulo Core REST API without having to complete repetitive login procedures.

Access tokens are long-lived. They provide an alternative to session-based authentication that the `qq login` command and the Qumulo Core Web UI use. They also support support authentication for services, long-lived automation processes, and programmatic REST API access that doesn't require user input.
Access tokens are long-lived. They provide an alternative to session-based authentication that the {% include qq.html command="login" %} command and the Qumulo Core Web UI use. They also support support authentication for services, long-lived automation processes, and programmatic REST API access that doesn't require user input.

{{site.data.alerts.important}}
<ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ For more information, see [Extracting the Public Key from an ECDSA Private Key](


## Retrieving Public Key Information
* To retrieve information for a single public key, run the {% include qq.html command="fs_security_key" %} and specify the key identifier or name.
* To retrieve information for a single public key, run the {% include qq.html command="fs_security_get_key" %} and specify the key identifier or name.

* To retrieve information for all public keys, run the {% include qq.html command="fs_security_list_keys" %} command.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -302,4 +302,4 @@ In environments where Linux systems map exactly to end users that have `kinit`-b
## Network Time Protocol (NTP) Server
{% include content-reuse/kerberos-ntp-server.md %}

There are many NTP d&aelig;mons for Linux. For example, Ubuntu uses the [NTP functionality in systemd](https://ubuntu.com/server/docs/network-ntp) (`timedatectl` and `timesyncd`).
There are many NTP d&aelig;mons for Linux. For example, Ubuntu uses the [NTP functionality in systemd](https://ubuntu.com/server/docs/use-timedatectl-and-timesyncd) (`timedatectl` and `timesyncd`).
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ This section describes the troubleshooting steps for a scenario in which an NFS

* Ensure that your Qumulo cluster's DNS cache isn't out of date, for example, if `{{site.exampleIP2}}` should resolve to `user1.accounting.example.com`.

To reset your Qumulo cluster's DNS cache, run the {% include qq.html command="dns_clear_lookup_cache" %} command.
To reset your Qumulo cluster's DNS cache, run the {% include qq.html command="dns_clear_cache" %} command.

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

Expand Down
4 changes: 2 additions & 2 deletions _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, run 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.
To show the ACL of a file, run the `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 All @@ -27,7 +27,7 @@ $ stat -c %a /mnt/qumulo/my-file
```

### Editing the ACL of a File
To edit the ACL of a file (by using the text editor specified in the `$EDITOR` environment variable), run the {% include qq.html command="nfs4_editfacl" %} command (or the {% include qq.html command="nfs4_setfacl" %} command with the `-e` flag). For more information, see the [nfs4_editfacl](https://linux.die.net/man/1/nfs4_editfacl) and [nfs4_setfacl](https://linux.die.net/man/1/nfs4_setfacl) in the Linux documentation.
To edit the ACL of a file (by using the text editor specified in the `$EDITOR` environment variable), run the [nfs4_editfacl](https://linux.die.net/man/1/nfs4_editfacl) command (or the [nfs4_setfacl](https://linux.die.net/man/1/nfs4_setfacl) command with the `-e` flag).

### Setting the ACL of a File
To set the ACL of a file, you can use one of the following commands:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For this operation, you must run the {% include qq.html command="auth_list_privi
grep WRITE > privileges.txt
```

2. Run the {% include qq.html command="qq auth_create_role" %} command and specify the `privileges.txt` file to create a custom role. For example:
2. Run the {% include qq.html command="auth_create_role" %} command and specify the `privileges.txt` file to create a custom role. For example:

```bash
qq auth_create_role -r "Write-Everything" \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ For this operation, you must run the {% include qq.html command="fs_walk_tree" %

{% include note.html content="For very large directories, we recommend running the following command [in a screen session](https://linuxize.com/post/how-to-use-linux-screen/)." %}

1. Ensure that the `jq` utility is installed on your system.
1. Ensure that the `jq` tool is installed on your system.

1. Run the {% include qq.html command="fs_walk_tree" %} command and use the `--path` flag to specify the path for the ACL. To extract the path for each item into an array, pipe the command to `jq`. To modify the ACL for each path, pipe the command to `xargs` which in turn runs the {% include qq.html command="fs_set_acl" %} command on each path. For example:
1. Run the {% include qq.html command="fs_walk_tree" %} command and use the `--path` flag to specify the path for the ACL. To extract the path for each item into an array, pipe the command to the `jq` tool. To modify the ACL for each path, pipe the command to `xargs` which in turn runs the {% include qq.html command="fs_set_acl" %} command on each path. For example:

```bash
qq fs_walk_tree --path /my_path | \
Expand All @@ -21,7 +21,7 @@ For this operation, you must run the {% include qq.html command="fs_walk_tree" %
### To Recursively Apply a Permissions Template
For this operation, you must run the {% include qq.html command="fs_walk_tree" %} and {% include qq.html command="fs_modify_acl" %} commands.

1. Ensure that the `jq` utility is installed on your system.
1. Ensure that the `jq` tool is installed on your system.

1. Use a new or existing file with the necessary permissions to capture the ACL and save it in JSON format by using the {% include qq.html command="fs_get_acl" %} command. For example:

Expand All @@ -30,7 +30,7 @@ For this operation, you must run the {% include qq.html command="fs_walk_tree" %
--json >/history/new_permissions.json
```

1. To apply the captured ACL, run the {% include qq.html command="fs_walk_tree" %} command and use the `--path` flag to specify the path for the ACL. To extract the path for each item into an array, pipe the command to `jq`. To modify the ACL for each path, pipe the command to `xargs` which in turn runs the {% include qq.html command="fs_set_acl" %} command on each path.
1. To apply the captured ACL, run the {% include qq.html command="fs_walk_tree" %} command and use the `--path` flag to specify the path for the ACL. To extract the path for each item into an array, pipe the command to the `jq` tool. To modify the ACL for each path, pipe the command to `xargs` which in turn runs the {% include qq.html command="fs_set_acl" %} command on each path.

```bash
qq fs_walk_tree --path /my_target_path | \
Expand All @@ -43,7 +43,7 @@ For this operation, you must run the {% include qq.html command="fs_walk_tree" %
### To Recursively Modify SMB Attributes
For this operation, you must run the {% include qq.html command="fs_walk_tree" %} and {% include qq.html command="fs_modify_acl" %} commands.

Run the {% include qq.html command="fs_walk_tree" %} command and use the `--path` flag to specify the path for the ACL. To extract the path for each item into an array, pipe the command to `jq`. To modify the ACL for each path, pipe the command to `xargs` which in turn runs the {% include qq.html command="qq fs_set_acl" %} command on each path.
Run the {% include qq.html command="fs_walk_tree" %} command and use the `--path` flag to specify the path for the ACL. To extract the path for each item into an array, pipe the command to the `jq` tool. To modify the ACL for each path, pipe the command to `xargs` which in turn runs the {% include qq.html command="fs_set_acl" %} command on each path.

```bash
qq fs_walk_tree --path /my_path | \
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
### Stopping a Copy Job in Progress
To stop a copy job already in progress, run the {% include qq.html command="replication_abort_object_relationship" %} command and use the `--id` flag to specify the Shift relationship ID.
To stop a copy job already in progress, run the {% include qq.html command="replication_abort_object_replication" %} command and use the `--id` flag to specify the Shift relationship ID.

### Repeating a Completed Copy Job
To repeat a completed copy job, run the {% include qq.html command="replication_start_object_relationship" %} command and use the `--id` flag to specify the Shift relationship ID.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ This section explains how to configure Qumulo Core to use a master key stored lo

{{site.data.alerts.note}}
<ul>
<li>The <code>qq</code> CLI command <code>encryption_set_key_store</code> requires the <code>PRIVILEGE_ENCRYPTION_WRITE</code> privilege.</li>
<li>The <code>qq</code> CLI command {% include qq.html command="encryption_set_key_store" %} requires the <code>PRIVILEGE_ENCRYPTION_WRITE</code> privilege.</li>
<li>To be able to configure an external KMS, the KMS must support Key Management Interoperability Protocol (KMIP) 1.0.</li>
</ul>
{{site.data.alerts.end}}
Expand All @@ -106,7 +106,7 @@ This section explains how to configure Qumulo Core to use a master key stored lo
</ul>
{{site.data.alerts.end}}

1. To configure the system to use a local key store, run the {% include qq.html command="encryption_set_key_store local" %}.
1. To configure the system to use a local key store, run the {% include qq.html command="encryption_set_key_store" %} with the `local` subcommand.

1. To confirm that the system is configured correctly, {% include qq.html command="encryption_get_status" %}.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ $ qq multitenancy_modify_tenant \
```

### Configuring the NFS Protocol Globally or for a Tenant
You can use _global settings_ that apply to all tenants. For example, to enable NFSv4.1 for all tenants, run the {% include qq.html command="nfs_modify_settings --enable-v4" %}. For more information about NFS settings see [Enabling and Using NFSv4.1 on a Qumulo Cluster](../nfs/nfsv4.1-enabling-using.html) and [How NFSv4.1 works with Kerberos in Qumulo Core](../kerberos/kerberos-with-qumulo-core.html).
You can use _global settings_ that apply to all tenants. For example, to enable NFSv4.1 for all tenants, run the {% include qq.html command="nfs_modify_settings" %} command and use the `--enable-v4` flag. For more information about NFS settings see [Enabling and Using NFSv4.1 on a Qumulo Cluster](../nfs/nfsv4.1-enabling-using.html) and [How NFSv4.1 works with Kerberos in Qumulo Core](../kerberos/kerberos-with-qumulo-core.html).

To override this global setting, run the {% include qq.html command="multitenancy_nfs_modify_settings" %} to disable NFSv4.1 on a specific tenant, specify the tenant ID, and use the `--disable-v4` flag. In the following example, despite the global setting, the specified tenant no longer accepts NFSv4.1 traffic on port 2049, on all networks assigned to the tenant.
To override this global setting, run the {% include qq.html command="multitenancy_nfs_modify_settings" %} command to disable NFSv4.1 on a specific tenant, specify the tenant ID, and use the `--disable-v4` flag. In the following example, despite the global setting, the specified tenant no longer accepts NFSv4.1 traffic on port 2049, on all networks assigned to the tenant.

```bash
$ qq multitenancy_nfs_modify_settings \
Expand Down Expand Up @@ -149,7 +149,7 @@ $ qq smb_add_share \

{% include important.html content=mustSpecifyID %}

To move an SMB share from one tenant to another, run the {% include qq.html command="smb_mode_share" %} command. In then following example, while the cluster denies access to clients in tenant 2, it lets clients in tenant 1 access the share `/my-share`.
To move an SMB share from one tenant to another, run the {% include qq.html command="smb_mod_share" %} command. In then following example, while the cluster denies access to clients in tenant 2, it lets clients in tenant 1 access the share `/my-share`.

```bash
$ qq smb_mod_share -–tenant-id 2 \
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For each tenant, you can specify individual [management protocol access and conf


## Prerequisites
{% capture lowerThan6103 %}If your cluster runs a version of Qumulo Core lower than 6.1.0.3, you must run the {% include qq.html command="multitenancy_enable" %} to enable multitenancy for your cluster.{% endcapture %}
{% capture lowerThan6103 %}If your cluster runs a version of Qumulo Core lower than 6.1.0.3, you must run the `qq multitenancy_enable` command to enable multitenancy for your cluster.{% endcapture %}
{% include important.html content=lowerThan6103 %}

To manage network multitenancy and tenants, your user must have membership in a Qumulo role with the following privileges.
Expand Down Expand Up @@ -126,7 +126,7 @@ $ qq network_mod_network \
To determine a tenant's network assignments and enabled management and file system protocols, you can view the tenant information.

#### Viewing Information for a Single Tenant
To view the information for a single tenant, run the {% include qq.html command="multitenancy_get_tenants" %} command.
To view the information for a single tenant, run the {% include qq.html command="multitenancy_get_tenant" %} command.

```bash
$ qq multitenancy_get_tenant \
Expand Down
4 changes: 2 additions & 2 deletions integration-guide/varonis/deploying-qumulo-broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ You can now configure Varonis to communicate with your Qumulo cluster.
## Step 3: Configure Qumulo Audit Logging by Using the qq CLI
This section explains how to configure audit logging on your Qumulo cluster.

1. To configure audit logging on your Qumulo cluster, run the {% include qq.html command="qq audit_set_syslog_config" %} command with the `--enable` flag, use the `--json` flag to request logging in JSON format, and specify the IP address or hostname and port number for your Qumulo Broker machine. For example:
1. To configure audit logging on your Qumulo cluster, run the {% include qq.html command="audit_set_syslog_config" %} command with the `--enable` flag, use the `--json` flag to request logging in JSON format, and specify the IP address or hostname and port number for your Qumulo Broker machine. For example:

```bash
qq audit_set_syslog_config \
Expand All @@ -93,7 +93,7 @@ This section explains how to configure audit logging on your Qumulo cluster.
}
```

1. To confirm the connection between the Qumulo Broker and the rsyslog instance, run the {% include qq.html command="qq audit_get_syslog_status" %} command.
1. To confirm the connection between the Qumulo Broker and the rsyslog instance, run the {% include qq.html command="audit_get_syslog_status" %} command.

The command returns one of three possible values for the `connection_status` field:

Expand Down

0 comments on commit a9b37e6

Please sign in to comment.