> For the complete documentation index, see [llms.txt](https://docs.weka.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.weka.io/getting-started-with-weka/weka-cli-overview/cli-reference-guide/weka-nfs.md).

# weka nfs

Manage the WEKA NFS service.

Manage the NFS service.

```sh
weka nfs
```

## weka nfs access

Inspect which NFS exports a client reaches.

```sh
weka nfs access
```

### weka nfs access lookup

Report every export an NFS client can mount, at what access level, and which entry grants it.

```sh
weka nfs access lookup <target> [--exact] [--host]
```

| Parameter  | Description                                                                           |
| ---------- | ------------------------------------------------------------------------------------- |
| `target`\* | Hostname, IP address or subnet to look up.                                            |
| `--exact`  | Treat only the name as spelled as a related name.                                     |
| `--host`   | Treat only the same host, in either short or fully-qualified form, as a related name. |

**Columns:** `target`, `kind`, `address`, `dns_name`, `match_mode`, `precedence`, `resolver_hostname`

## weka nfs client-group

Manage NFS client groups.

```sh
weka nfs client-group [--name <nfs-client-group>]
```

| Parameter                    | Description                         |
| ---------------------------- | ----------------------------------- |
| `--name` \<nfs-client-group> | NFS client group name to filter by. |

**Columns:** `id`, `uid`, `name`, `rules`

### weka nfs client-group add

Create an NFS client group.

```sh
weka nfs client-group add <name>
```

| Parameter | Description                      |
| --------- | -------------------------------- |
| `name`\*  | Name of the NFS group to create. |

**Columns:** `id`, `uid`, `name`, `rules`

### weka nfs client-group case-report

List DNS client-group rules that differ from another rule only by letter case, or that contain uppercase letters.

```sh
weka nfs client-group case-report
```

**Columns:** `client_group_id`, `client_group`, `rule_id`, `rule`, `kind`, `colliding_rule`

### weka nfs client-group remove

Remove an NFS client group.

```sh
weka nfs client-group remove <name> [--force]
```

| Parameter       | Description                                                     |
| --------------- | --------------------------------------------------------------- |
| `name`\*        | Name of the NFS group to delete.                                |
| `-f`, `--force` | Force action. Perform this action without further confirmation. |

## weka nfs clients

NFS clients usage information.

```sh
weka nfs clients
```

### weka nfs clients show

NFS clients usage information. If no options are given, all NFS-W containers will be selected.

```sh
weka nfs clients show [--container-id <container-id>] [--fip <ip>] [--fsnames <strings>…] [--interface-group <string>]
```

| Parameter                        | Description                                                                                                            |
| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `--container-id` \<container-id> | Specify container ID.                                                                                                  |
| `--fip` \<ip>                    | Specify floating IP.                                                                                                   |
| `--fsnames` \<strings>…          | Specify exported filesystem names. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--interface-group` \<string>    | Specify NFS interface group.                                                                                           |

**Columns:** `container`, `fsname`, `client_ip`, `idle_time`, `num_v3_ops`, `num_v4_ops`, `num_v4_open_ops`, `num_v4_close_ops`

## weka nfs custom-options

Manage NFS custom global, permission, and client config options.

```sh
weka nfs custom-options
```

**Columns:** `global_options`, `export_options`, `client_options`

### weka nfs custom-options update

Update custom options.

```sh
weka nfs custom-options update [--client-options <string>] [--export-options <string>] [--global-options <string>]
```

| Parameter                    | Description             |
| ---------------------------- | ----------------------- |
| `--client-options` \<string> | Set client NFS options. |
| `--export-options` \<string> | Set export NFS options. |
| `--global-options` \<string> | Set global NFS options. |

## weka nfs debug-level

Manage NFS debug level.

```sh
weka nfs debug-level
```

### weka nfs debug-level list

List NFS server supported components or levels for setting debug levels.

```sh
weka nfs debug-level list <what> [--full-list]
```

| Parameter     | Description                                       |
| ------------- | ------------------------------------------------- |
| `what`\*      | Specify the available debug components or levels. |
| `--full-list` | Show the full list of names or levels.            |

**Columns:** `name`

### weka nfs debug-level reset

Clear persisted NFS debug levels. A component returns to the level persisted for all components, or to the default. Requires Cluster Admin role.

```sh
weka nfs debug-level reset [--nfs-components <strings>…]
```

| Parameter                      | Description                                                                                                      |
| ------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
| `--nfs-components` \<strings>… | Only reset these components. Multiple values may be supplied separated by commas, or the option may be repeated. |

### weka nfs debug-level set

Set NFS debug level. A cluster-wide level persists across restarts and requires Cluster Admin role; with --transient or --nfs-hosts it applies only to the running servers and requires Tenant Admin role.

```sh
weka nfs debug-level set <level> [--full-list] [--nfs-components <strings>…] [--nfs-hosts <container-ids>…] [--transient]
```

| Parameter                       | Description                                                                                                         |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `level`\*                       | One of the supported debug levels.                                                                                  |
| `--full-list`                   | Set log level for all components.                                                                                   |
| `--nfs-components` \<strings>…  | List of component names. Multiple values may be supplied separated by commas, or the option may be repeated.        |
| `--nfs-hosts` \<container-ids>… | Only apply to these containers. Multiple values may be supplied separated by commas, or the option may be repeated. |
| `--transient`                   | Apply to the running NFS servers only, without persisting across restarts.                                          |

### weka nfs debug-level show

Show NFS debug level settings information.

```sh
weka nfs debug-level show [--full-list] [--nfs-components <strings>…] [--nfs-hosts <container-ids>…]
```

| Parameter                       | Description                                                                                                            |
| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `--full-list`                   | Show the full list of components.                                                                                      |
| `--nfs-components` \<strings>…  | List of component names. Multiple values may be supplied separated by commas, or the option may be repeated.           |
| `--nfs-hosts` \<container-ids>… | Only return from these containers. Multiple values may be supplied separated by commas, or the option may be repeated. |

**Columns:** `container`, `debug_level`, `component`, `persisted`

## weka nfs global-config

Manage NFS global config parameters.

```sh
weka nfs global-config
```

### weka nfs global-config set

Set NFS global config parameters.

```sh
weka nfs global-config set [--acl <on-off>] [--config-fs <string>] [--default-acl-type <acl-type>] [--default-supported-versions <nfs-versions>…] [--direct-io <on-off>] [--enable-auth-types <nfs-auth-types>…] [--enable-multi-tenant <on-off>] [--extended-stats <on-off>] [--force] [--force-config-fs <on-off>] [--lockmgr-port <uint16>] [--max-client-connections <uint>] [--max-memory <capacity>] [--max-open-fds <uint>] [--mountd-port <uint16>] [--no-restart] [--notify-port <uint16>] [--statmon-port <uint16>]
```

| Parameter                                       | Description                                                                                                                                                                                                                                                                                                             |
| ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--acl` \<on-off>                               | Enable or disable ACL.                                                                                                                                                                                                                                                                                                  |
| `--config-fs` \<string>                         | Config filesystem name. Use empty string to invalidate.                                                                                                                                                                                                                                                                 |
| `--default-acl-type` \<acl-type>                | Default ACL type. Valid values: none, posix, nfsv4, hybrid.                                                                                                                                                                                                                                                             |
| `--default-supported-versions` \<nfs-versions>… | NFS versions for new permissions. Multiple values may be supplied separated by commas, or the option may be repeated. Valid values: v3, v4.                                                                                                                                                                             |
| `--direct-io` \<on-off>                         | Disable readcache and writecache.                                                                                                                                                                                                                                                                                       |
| `--enable-auth-types` \<nfs-auth-types>…        | List of NFS authentication types. Multiple values may be supplied separated by commas, or the option may be repeated. Valid values: none, sys, krb5, krb5i, krb5p.                                                                                                                                                      |
| `--enable-multi-tenant` \<on-off>               | Enable or disable NFS multi-tenant support (default: Off).                                                                                                                                                                                                                                                              |
| `--extended-stats` \<on-off>                    | Enable or disable extended stats.                                                                                                                                                                                                                                                                                       |
| `-f`, `--force`                                 | Force action. Perform this action without further confirmation.                                                                                                                                                                                                                                                         |
| `--force-config-fs` \<on-off>                   | Force config-fs update when locks are on.                                                                                                                                                                                                                                                                               |
| `--lockmgr-port` \<uint16>                      | Port for NFS lock manager. Default 0 selects any available port.                                                                                                                                                                                                                                                        |
| `--max-client-connections` \<uint>              | Maximum number of concurrent NFS client connections. 0 means auto-tune based on cluster size.                                                                                                                                                                                                                           |
| `--max-memory` \<capacity>                      | Override the NFS container's memory ceiling, in whole GiB (e.g. 32GiB). Left unset, the compiled default applies. On a running cluster, applies to each NFS-Ganesha container at its next start.                                                                                                                        |
| `--max-open-fds` \<uint>                        | Maximum number of files each NFS server may hold open. From WEKA 6.1, 0 restores the default of 500000; earlier releases require a value between 10000 and 10000000. The derived process descriptor limit (connections + open files + reserve) and the NFS server's file-cache thresholds both apply without a restart. |
| `--mountd-port` \<uint16>                       | Port number for mountd service.                                                                                                                                                                                                                                                                                         |
| `--no-restart`                                  | Prevent NFS-W containers from restarting when changes are applied.                                                                                                                                                                                                                                                      |
| `--notify-port` \<uint16>                       | Port for NFSv3 notification. Default 0 means any available port.                                                                                                                                                                                                                                                        |
| `--statmon-port` \<uint16>                      | Port for NFS status monitor. Default 0 means any available port.                                                                                                                                                                                                                                                        |

### weka nfs global-config show

Show NFS global configuration information.

```sh
weka nfs global-config show
```

**Columns:** `acl`, `config_fs`, `container_memory_ceiling`, `container_memory_ceiling_effective`, `default_acl_type`, `default_auth_types`, `default_supported_versions`, `direct_io`, `enabled_auth_types`, `enable_multi_tenant`, `extended_stats`, `grace_period`, `lease_lifetime`, `lock_recovery_period`, `lockmgr_port`, `locks`, `maxClientConnections`, `maxOpenFiles`, `fdRlimit`, `mountd_port`, `notify_port`, `statmon_port`, `supported_auth_types`

## weka nfs interface-group

Manage NFS interface groups.

```sh
weka nfs interface-group [--name <string>]
```

| Parameter          | Description               |
| ------------------ | ------------------------- |
| `--name` \<string> | NFS interface group name. |

**Columns:** `uid`, `name`, `type`, `netmask`, `gateway`, `status`, `ips`, `ports`, `tenant_ids`, `allow_manage_gids`

### weka nfs interface-group add

Add an NFS interface group.

```sh
weka nfs interface-group add <name> [--gateway <ip>] [--netmask <uint8>]
```

| Parameter            | Description             |
| -------------------- | ----------------------- |
| `name`\*             | Interface group name.   |
| `--gateway` \<ip>    | Gateway IP address.     |
| `--netmask` \<uint8> | Netmask length in bits. |

**Columns:** `uid`, `name`, `netmask`, `gateway`, `status`, `ips`, `ports`, `allow_manage_gids`

### weka nfs interface-group assignment

List NFS interface group assignments.

```sh
weka nfs interface-group assignment [--name <string>]
```

| Parameter          | Description               |
| ------------------ | ------------------------- |
| `--name` \<string> | NFS interface group name. |

**Columns:** `ip`, `container`, `port`, `group`

### weka nfs interface-group ip-range

Manage NFS interface group IP ranges.

```sh
weka nfs interface-group ip-range
```

#### weka nfs interface-group ip-range add

Add an IP range to an interface group.

```sh
weka nfs interface-group ip-range add <name> <ips>
```

| Parameter | Description                      |
| --------- | -------------------------------- |
| `name`\*  | Name of the NFS interface group. |
| `ips`\*   | IP range to add.                 |

#### weka nfs interface-group ip-range remove

Remove an IP range from an interface group.

```sh
weka nfs interface-group ip-range remove <name> <ips> [--force]
```

| Parameter       | Description                                                     |
| --------------- | --------------------------------------------------------------- |
| `name`\*        | Name of the NFS interface group.                                |
| `ips`\*         | IP range to remove.                                             |
| `-f`, `--force` | Force action. Perform this action without further confirmation. |

### weka nfs interface-group ns-assignment

List the currently assigned container for each namespace. Optionally filter by interface group name or tenant.

```sh
weka nfs interface-group ns-assignment [--name <string>] [--tenant <tenant>]
```

| Parameter            | Description                     |
| -------------------- | ------------------------------- |
| `--name` \<string>   | Filter by interface group name. |
| `--tenant` \<tenant> | Filter by tenant name.          |

**Columns:** `uid`, `netspace_id`, `tenant_id`, `container`, `hostname`, `vlan`, `fip_range`, `interface_group`

### weka nfs interface-group port

Manage NFS interface group ports.

```sh
weka nfs interface-group port
```

#### weka nfs interface-group port add

Add a port to an NFS interface group.

```sh
weka nfs interface-group port add <name> <container> <port>
```

| Parameter     | Description                             |
| ------------- | --------------------------------------- |
| `name`\*      | Name of the NFS interface group.        |
| `container`\* | Container ID on which the port resides. |
| `port`\*      | Port device name (e.g. eth1).           |

#### weka nfs interface-group port remove

Remove a port from an NFS interface group.

```sh
weka nfs interface-group port remove <name> <container> <port> [--force]
```

| Parameter       | Description                                                     |
| --------------- | --------------------------------------------------------------- |
| `name`\*        | Name of the NFS interface group.                                |
| `container`\*   | Container on which the port resides.                            |
| `port`\*        | Port device name (e.g. eth1).                                   |
| `-f`, `--force` | Force action. Perform this action without further confirmation. |

### weka nfs interface-group remove

Delete an NFS interface group.

```sh
weka nfs interface-group remove <name> [--force]
```

| Parameter       | Description                                                     |
| --------------- | --------------------------------------------------------------- |
| `name`\*        | Name of the NFS interface group to delete.                      |
| `-f`, `--force` | Force action. Perform this action without further confirmation. |

### weka nfs interface-group tenant

List tenants assigned to NFS interface groups.

```sh
weka nfs interface-group tenant [--name <string>]
```

| Parameter          | Description                     |
| ------------------ | ------------------------------- |
| `--name` \<string> | Filter by interface group name. |

**Columns:** `id`, `name`, `interface_group`

#### weka nfs interface-group tenant add

Assign a tenant to an NFS interface group. Fails if the tenant is already assigned to a different group; use "tenant move" to reassign.

```sh
weka nfs interface-group tenant add <name> <tenant>
```

| Parameter  | Description           |
| ---------- | --------------------- |
| `name`\*   | Interface group name. |
| `tenant`\* | Tenant name or ID.    |

#### weka nfs interface-group tenant delete

Remove a tenant from its assigned NFS interface group.

```sh
weka nfs interface-group tenant delete <name> <tenant>
```

| Parameter  | Description           |
| ---------- | --------------------- |
| `name`\*   | Interface group name. |
| `tenant`\* | Tenant name or ID.    |

#### weka nfs interface-group tenant move

Move a tenant from its current NFS interface group to a different one.

```sh
weka nfs interface-group tenant move <name> <tenant>
```

| Parameter  | Description               |
| ---------- | ------------------------- |
| `name`\*   | New interface group name. |
| `tenant`\* | Tenant name or ID.        |

### weka nfs interface-group update

Update an NFS interface group.

```sh
weka nfs interface-group update <name> [--gateway <ip>] [--netmask <uint8>]
```

| Parameter            | Description                          |
| -------------------- | ------------------------------------ |
| `name`\*             | Interface group name.                |
| `--gateway` \<ip>    | Gateway IP address (e.g. 192.0.2.0). |
| `--netmask` \<uint8> | Netmask length in bits.              |

## weka nfs kerberos

Manage NFS Kerberos configuration.

```sh
weka nfs kerberos
```

### weka nfs kerberos registration

Manage Kerberos registration.

```sh
weka nfs kerberos registration
```

#### weka nfs kerberos registration setup-ad

Configure Active Directory Kerberos.

```sh
weka nfs kerberos registration setup-ad <nfs-fqdn-service-name> <realm-admin-name> [<realm-admin-passwd>] [--base-ou <string>] [--force] [--restart]
```

| Parameter                 | Description                                         |
| ------------------------- | --------------------------------------------------- |
| `nfs-fqdn-service-name`\* | NFS FQDN service name.                              |
| `realm-admin-name`\*      | Realm admin user name.                              |
| `realm-admin-passwd`      | Realm admin password. If omitted, will be prompted. |
| `--base-ou` \<string>     | LDAP base OU to use (e.g. OU=Servers).              |
| `--force`                 | Perform this action without further confirmation.   |
| `--restart`               | Restart the NFS-W containers to apply changes.      |

#### weka nfs kerberos registration setup-mit

Configure MIT Kerberos.

```sh
weka nfs kerberos registration setup-mit <nfs-fqdn-service-name> <keytab-path> [--force] [--restart]
```

| Parameter                 | Description                                       |
| ------------------------- | ------------------------------------------------- |
| `nfs-fqdn-service-name`\* | NFS FQDN service name.                            |
| `keytab-path`\*           | Path to keytab file.                              |
| `--force`                 | Perform this action without further confirmation. |
| `--restart`               | Restart the NFS-W containers to apply changes.    |

#### weka nfs kerberos registration show

Show NFS Kerberos registration information.

```sh
weka nfs kerberos registration show
```

**Columns:** `kdc_type`, `nfs_service_name`, `registration_generation_id`, `registration_status`

### weka nfs kerberos reset

Wipe out NFS Kerberos configuration information.

```sh
weka nfs kerberos reset [--force] [--no-restart]
```

| Parameter       | Description                                                     |
| --------------- | --------------------------------------------------------------- |
| `-f`, `--force` | Force action. Perform this action without further confirmation. |
| `--no-restart`  | Don't restart the NFS-W containers to apply changes.            |

### weka nfs kerberos service

Manage Kerberos service configuration.

```sh
weka nfs kerberos service
```

#### weka nfs kerberos service setup

Configure Kerberos service.

```sh
weka nfs kerberos service setup <kdc-realm-name> <kdc-primary-server> <kdc-admin-server> [--force] [--kdc-secondary-server <string>] [--restart]
```

| Parameter                          | Description                                       |
| ---------------------------------- | ------------------------------------------------- |
| `kdc-realm-name`\*                 | KDC realm name.                                   |
| `kdc-primary-server`\*             | KDC primary server.                               |
| `kdc-admin-server`\*               | KDC admin server.                                 |
| `--force`                          | Perform this action without further confirmation. |
| `--kdc-secondary-server` \<string> | KDC secondary server.                             |
| `--restart`                        | Restart the NFS-W containers to apply changes.    |

#### weka nfs kerberos service show

Show NFS Kerberos configuration information.

```sh
weka nfs kerberos service show
```

**Columns:** `kdc_admin_server`, `kdc_primary_server`, `kdc_secondary_server`, `realm_name`, `service_generation_id`, `service_status`

## weka nfs ldap

Manage NFS LDAP and AD configuration.

```sh
weka nfs ldap
```

### weka nfs ldap export-ad

Export Active Directory LDAP configuration.

```sh
weka nfs ldap export-ad <server-name> <ldap-domain> <sssd-conf-file> <idmapd-conf-file> [<ca-cert-file>]
```

| Parameter            | Description                        |
| -------------------- | ---------------------------------- |
| `server-name`\*      | AD server name.                    |
| `ldap-domain`\*      | AD domain.                         |
| `sssd-conf-file`\*   | Path to sssd configuration file.   |
| `idmapd-conf-file`\* | Path to idmapd configuration file. |
| `ca-cert-file`       | Path to CA Certificate file.       |

### weka nfs ldap export-openldap

Export OpenLDAP configuration.

```sh
weka nfs ldap export-openldap <server-name> <ldap-domain> <sssd-conf-file> <idmapd-conf-file> [<ca-cert-file>]
```

| Parameter            | Description                        |
| -------------------- | ---------------------------------- |
| `server-name`\*      | OpenLDAP server name.              |
| `ldap-domain`\*      | OpenLDAP domain.                   |
| `sssd-conf-file`\*   | Path to sssd configuration file.   |
| `idmapd-conf-file`\* | Path to idmapd configuration file. |
| `ca-cert-file`       | Path to CA Certificate file.       |

### weka nfs ldap import-ad

Import Active Directory LDAP configuration.

```sh
weka nfs ldap import-ad <server-name> <ldap-domain> <sssd-conf-file> <idmapd-conf-file> [<ca-cert-file>] [--force] [--no-restart]
```

| Parameter            | Description                                          |
| -------------------- | ---------------------------------------------------- |
| `server-name`\*      | AD server name.                                      |
| `ldap-domain`\*      | AD domain.                                           |
| `sssd-conf-file`\*   | Path to sssd configuration file.                     |
| `idmapd-conf-file`\* | Path to idmapd configuration file.                   |
| `ca-cert-file`       | Path to CA Certificate file.                         |
| `--force`            | Perform this action without further confirmation.    |
| `--no-restart`       | Don't restart the NFS-W containers to apply changes. |

### weka nfs ldap import-openldap

Import OpenLDAP configuration.

```sh
weka nfs ldap import-openldap <server-name> <ldap-domain> <sssd-conf-file> <idmapd-conf-file> [<ca-cert-file>] [--force] [--no-restart] [--verify]
```

| Parameter            | Description                                          |
| -------------------- | ---------------------------------------------------- |
| `server-name`\*      | OpenLDAP server name.                                |
| `ldap-domain`\*      | OpenLDAP domain.                                     |
| `sssd-conf-file`\*   | Path to sssd configuration file.                     |
| `idmapd-conf-file`\* | Path to idmapd configuration file.                   |
| `ca-cert-file`       | Path to CA Certificate file.                         |
| `--force`            | Perform this action without further confirmation.    |
| `--no-restart`       | Don't restart the NFS-W containers to apply changes. |
| `--verify`           | Verify connectivity with the OpenLDAP server.        |

### weka nfs ldap reset

Wipe out NFS LDAP configuration information.

```sh
weka nfs ldap reset [--force] [--no-restart]
```

| Parameter      | Description                                          |
| -------------- | ---------------------------------------------------- |
| `--force`      | Perform this action without further confirmation.    |
| `--no-restart` | Don't restart the NFS-W containers to apply changes. |

### weka nfs ldap setup-ad

Set up configuration for NFS to use Active Directory LDAP. Running this command without the no-restart option can disrupt I/O service for connected NFS clients.

```sh
weka nfs ldap setup-ad [--force] [--no-restart]
```

| Parameter      | Description                                           |
| -------------- | ----------------------------------------------------- |
| `--force`      | Perform this action even when LDAP is already set up. |
| `--no-restart` | Don't restart the NFS-W containers to apply changes.  |

### weka nfs ldap setup-ad-nokrb

Set up configuration for NFS to use Active Directory LDAP for ACL only when Kerberos is not used. Running this command without the no-restart option can disrupt I/O service for connected NFS clients.

```sh
weka nfs ldap setup-ad-nokrb <server-name> <ldap-domain> <nfs-service-name> <admin-user-name> [<admin-user-password>] [--base-ou <string>] [--force] [--no-restart]
```

| Parameter             | Description                                           |
| --------------------- | ----------------------------------------------------- |
| `server-name`\*       | AD server name.                                       |
| `ldap-domain`\*       | AD domain.                                            |
| `nfs-service-name`\*  | NFS FQDN service name.                                |
| `admin-user-name`\*   | AD admin name.                                        |
| `admin-user-password` | AD admin password.                                    |
| `--base-ou` \<string> | LDAP OU (default: CN=Computers).                      |
| `--force`             | Perform this action even when LDAP is already set up. |
| `--no-restart`        | Don't restart the NFS-W containers to apply changes.  |

### weka nfs ldap setup-onhostldap

Configure NFS to use on-host LDAP service.

```sh
weka nfs ldap setup-onhostldap <ldap-domain> [--force] [--no-restart]
```

| Parameter       | Description                                           |
| --------------- | ----------------------------------------------------- |
| `ldap-domain`\* | LDAP domain.                                          |
| `--force`       | Perform this action even when LDAP is already set up. |
| `--no-restart`  | Don't restart the NFS-W containers to apply changes.  |

### weka nfs ldap setup-openldap

Configure OpenLDAP.

```sh
weka nfs ldap setup-openldap <server-name> <ldap-domain> <reader-user-name> [<reader-user-password>] [--base-dn <string>] [--force] [--ldap-port-number <uint16>] [--no-restart]
```

| Parameter                      | Description                                           |
| ------------------------------ | ----------------------------------------------------- |
| `server-name`\*                | OpenLDAP server name.                                 |
| `ldap-domain`\*                | OpenLDAP domain.                                      |
| `reader-user-name`\*           | OpenLDAP reader user name.                            |
| `reader-user-password`         | OpenLDAP reader user password.                        |
| `--base-dn` \<string>          | LDAP Base DN (e.g. dc=myldapdom,dc=ex,dc=com).        |
| `--force`                      | Perform this action even when LDAP is already set up. |
| `--ldap-port-number` \<uint16> | OpenLDAP port number (default: 389).                  |
| `--no-restart`                 | Don't restart the NFS-W containers to apply changes.  |

### weka nfs ldap show

NFS LDAP configuration information.

```sh
weka nfs ldap show
```

**Columns:** `ldap_server_type`, `ldap_domain`, `ldap_server`, `ldap_port`, `ldap_base_dn`, `ldap_reader_user_name`, `ldap_reader_user_password`, `ldap_generation_id`, `ldap_status`

## weka nfs netgroup

Manage NFS netgroups: named sets of hosts that client group rules can reference in place of individual addresses.

```sh
weka nfs netgroup
```

### weka nfs netgroup add

Create an empty NFS netgroup.

```sh
weka nfs netgroup add <name>
```

| Parameter | Description                     |
| --------- | ------------------------------- |
| `name`\*  | Name of the netgroup to create. |

**Columns:** `id`, `uid`, `name`, `member_count`, `unresolved`, `generation`

### weka nfs netgroup list

List NFS netgroups with their member counts and the number of client groups referencing each.

```sh
weka nfs netgroup list [--name <nfs-netgroup>]
```

| Parameter                | Description                 |
| ------------------------ | --------------------------- |
| `--name` \<nfs-netgroup> | Netgroup name to filter by. |

**Columns:** `id`, `uid`, `name`, `member_count`, `unresolved`, `client_group_count`, `generation`

### weka nfs netgroup member

Add and remove the member hosts of an NFS netgroup.

```sh
weka nfs netgroup member
```

#### weka nfs netgroup member add

Add member hosts to an NFS netgroup in one configuration commit. A host already in the netgroup is counted, not refused.

```sh
weka nfs netgroup member add <name> [--from-file <string>] [--hosts <hostnames>…]
```

| Parameter               | Description                                                                                                                                     |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`\*                | Name of the netgroup.                                                                                                                           |
| `--from-file` \<string> | Read the hostnames from a file: one per line, '#' comments and blank lines ignored.                                                             |
| `--hosts` \<hostnames>… | Member hostnames, comma-separated or by repeating the flag. Multiple values may be supplied separated by commas, or the option may be repeated. |

**Columns:** `netgroup`, `added`, `already_present`, `member_count`, `generation`

#### weka nfs netgroup member remove

Remove member hosts from an NFS netgroup in one configuration commit. A host the netgroup does not hold is reported, not refused.

```sh
weka nfs netgroup member remove <name> [--from-file <string>] [--hosts <hostnames>…]
```

| Parameter               | Description                                                                                                                                     |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| `name`\*                | Name of the netgroup.                                                                                                                           |
| `--from-file` \<string> | Read the hostnames from a file: one per line, '#' comments and blank lines ignored.                                                             |
| `--hosts` \<hostnames>… | Member hostnames, comma-separated or by repeating the flag. Multiple values may be supplied separated by commas, or the option may be repeated. |

**Columns:** `netgroup`, `removed`, `not_found`, `member_count`, `generation`

### weka nfs netgroup remove

Remove an NFS netgroup and its members. A netgroup that a client group rule references cannot be removed.

```sh
weka nfs netgroup remove <name>
```

| Parameter | Description                     |
| --------- | ------------------------------- |
| `name`\*  | Name of the netgroup to remove. |

### weka nfs netgroup rename

Rename an NFS netgroup. Client group rules that reference it follow the new name.

```sh
weka nfs netgroup rename <name> <new-name>
```

| Parameter    | Description                |
| ------------ | -------------------------- |
| `name`\*     | Current netgroup name.     |
| `new-name`\* | New name for the netgroup. |

**Columns:** `id`, `uid`, `name`, `member_count`, `unresolved`, `generation`

### weka nfs netgroup show

Show an NFS netgroup, its member hosts, and the client groups and exports that reference it.

```sh
weka nfs netgroup show <name>
```

| Parameter | Description                   |
| --------- | ----------------------------- |
| `name`\*  | Name of the netgroup to show. |

**Columns:** `id`, `uid`, `name`, `member_count`, `unresolved`, `generation`

## weka nfs permission

Manage NFS permissions.

```sh
weka nfs permission [--filesystem <string>]
```

| Parameter                | Description      |
| ------------------------ | ---------------- |
| `--filesystem` \<string> | Filesystem name. |

**Columns:** `acl_type`, `anon_gid`, `anon_uid`, `enabled_auth_types`, `filesystem`, `group`, `manage_gids`, `obs_direct`, `path`, `permission_type`, `privileged_port`, `squash_mode`, `supported_versions`

### weka nfs permission add

Allow a client group to access a file system.

```sh
weka nfs permission add <filesystem> <group> [--acl-type <acl-type>] [--anon-gid <uint32>] [--anon-uid <uint32>] [--enable-auth-types <nfs-auth-types>…] [--force] [--force-acl-type <on-off>] [--manage-gids <on-off>] [--no-restart] [--obs-direct <on-off>] [--path <string>] [--permission-type <permission-type>] [--privileged-port <on-off>] [--squash <squash-mode>] [--supported-versions <nfs-versions>…]
```

| Parameter                                | Description                                                                                                                                                                                        |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filesystem`\*                           | Filesystem name.                                                                                                                                                                                   |
| `group`\*                                | Client group name.                                                                                                                                                                                 |
| `--acl-type` \<acl-type>                 | Type of ACL. Default is determined by the NFS global configuration. Valid values: none, posix, nfsv4, hybrid.                                                                                      |
| `--anon-gid` \<uint32>                   | GID to be used instead of root when root squashing is enabled.                                                                                                                                     |
| `--anon-uid` \<uint32>                   | UID to be used instead of root when root squashing is enabled.                                                                                                                                     |
| `--enable-auth-types` \<nfs-auth-types>… | NFS authentication types. Multiple values may be supplied separated by commas, or the option may be repeated. Valid values: none, sys, krb5, krb5i, krb5p.                                         |
| `-f`, `--force`                          | Force action. Perform this action without further confirmation.                                                                                                                                    |
| `--force-acl-type` \<on-off>             | Force a change to the ACL type for existing permissions on the same filesystem.                                                                                                                    |
| `--manage-gids` \<on-off>                | List of group IDs received from the client will be replaced by a list of group IDs determined by an appropriate lookup on the server. Only works with an interface group which allows manage-gids. |
| `--no-restart`                           | Don't restart the NFS-W containers to apply changes.                                                                                                                                               |
| `--obs-direct` \<on-off>                 | OBS direct.                                                                                                                                                                                        |
| `--path` \<string>                       | Filesystem path. Default is '/'.                                                                                                                                                                   |
| `--permission-type` \<permission-type>   | Permission type. Valid values: ro, rw.                                                                                                                                                             |
| `--privileged-port` \<on-off>            | Privileged port.                                                                                                                                                                                   |
| `--squash` \<squash-mode>                | Permission squashing. The option 'all' can be used only on interface groups with --allow-manage-gids=on. Valid values: none, root, all.                                                            |
| `--supported-versions` \<nfs-versions>…  | NFS versions for new permissions. Multiple values may be supplied separated by commas, or the option may be repeated. Valid values: v3, v4.                                                        |

**Columns:** `export_id`, `container_restart_needed`

### weka nfs permission remove

Delete filesystem permission.

```sh
weka nfs permission remove <filesystem> <group> [--force] [--path <string>]
```

| Parameter          | Description                                                     |
| ------------------ | --------------------------------------------------------------- |
| `filesystem`\*     | Filesystem name.                                                |
| `group`\*          | Client group name.                                              |
| `-f`, `--force`    | Force action. Perform this action without further confirmation. |
| `--path` \<string> | Filesystem path. Default is '/'.                                |

### weka nfs permission update

Edit a file system permission.

```sh
weka nfs permission update <filesystem> <group> [--acl-type <acl-type>] [--anon-gid <uint32>] [--anon-uid <uint32>] [--enable-auth-types <nfs-auth-types>…] [--force] [--force-acl-type <on-off>] [--manage-gids <on-off>] [--no-restart] [--obs-direct <on-off>] [--path <string>] [--permission-type <permission-type>] [--privileged-port <on-off>] [--squash <squash-mode>] [--supported-versions <nfs-versions>…]
```

| Parameter                                | Description                                                                                                                                                                                        |
| ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `filesystem`\*                           | Filesystem name.                                                                                                                                                                                   |
| `group`\*                                | Client group name.                                                                                                                                                                                 |
| `--acl-type` \<acl-type>                 | ACL type. Default is determined by the NFS global configuration. Valid values: none, posix, nfsv4, hybrid.                                                                                         |
| `--anon-gid` \<uint32>                   | GID to be used instead of root when root squashing is enabled.                                                                                                                                     |
| `--anon-uid` \<uint32>                   | UID to be used instead of root when root squashing is enabled.                                                                                                                                     |
| `--enable-auth-types` \<nfs-auth-types>… | NFS authentication types. Multiple values may be supplied separated by commas, or the option may be repeated. Valid values: none, sys, krb5, krb5i, krb5p.                                         |
| `-f`, `--force`                          | Force action. Perform this action without further confirmation.                                                                                                                                    |
| `--force-acl-type` \<on-off>             | Force a change to the ACL type for existing permissions on the same filesystem.                                                                                                                    |
| `--manage-gids` \<on-off>                | List of group IDs received from the client will be replaced by a list of group IDs determined by an appropriate lookup on the server. Only works with an interface group which allows manage-gids. |
| `--no-restart`                           | Don't restart the NFS-W containers to apply changes.                                                                                                                                               |
| `--obs-direct` \<on-off>                 | OBS direct.                                                                                                                                                                                        |
| `--path` \<string>                       | Filesystem path. Default is '/'.                                                                                                                                                                   |
| `--permission-type` \<permission-type>   | Permission type. Valid values: ro, rw.                                                                                                                                                             |
| `--privileged-port` \<on-off>            | Privileged port.                                                                                                                                                                                   |
| `--squash` \<squash-mode>                | Permission squashing. The option 'all' can be used only on interface groups with --allow-manage-gids=on. Valid values: none, root, all.                                                            |
| `--supported-versions` \<nfs-versions>…  | NFS versions for new permissions. Multiple values may be supplied separated by commas, or the option may be repeated. Valid values: v3, v4.                                                        |

## weka nfs resource-usage

Show NFS server resource usage per container.

```sh
weka nfs resource-usage [--container-id <container-id>]
```

| Parameter                        | Description           |
| -------------------------------- | --------------------- |
| `--container-id` \<container-id> | Specify container ID. |

**Columns:** `container`, `hostname`, `connections`, `max_connections`, `connections_percent`, `connections_state`, `connections_refused_rate`, `open_files`, `max_open_files`, `files_percent`, `files_state`, `memory_usage_bytes`, `memory_limit_bytes`, `memory_percent`, `memory_state`, `source`, `sample_age_secs`, `fd_state`, `pinned_fd_count`, `reapable_fd_count`, `open_state_count`, `fd_hwmark`, `fd_lwmark`, `process_fd_count`, `socket_fd_count`, `fd_rlimit`, `listeners`, `server_memory_total_bytes`

## weka nfs rules

Manage NFS rules, or list with no arguments.

```sh
weka nfs rules
```

### weka nfs rules add

Add an NFS rule.

```sh
weka nfs rules add
```

#### weka nfs rules add dns

Add an NFS rule with a DNS wildcard.

```sh
weka nfs rules add dns <name> <dns>
```

| Parameter | Description                                               |
| --------- | --------------------------------------------------------- |
| `name`\*  | Name of the NFS client group in which to create the rule. |
| `dns`\*   | DNS rule with \*?\[] wildcards.                           |

**Columns:** `id`, `uid`, `type`, `rule`

#### weka nfs rules add ip

Add an IP rule to an NFS client group.

```sh
weka nfs rules add ip <name> <ip>
```

| Parameter | Description                                               |
| --------- | --------------------------------------------------------- |
| `name`\*  | Name of the NFS client group in which to create the rule. |
| `ip`\*    | IPv4 address with a prefix length (e.g. 1.1.1.0/16).      |

**Columns:** `id`, `uid`, `type`, `rule`

#### weka nfs rules add netgroup

Add a netgroup rule to an NFS client group.

```sh
weka nfs rules add netgroup <name> <netgroup>
```

| Parameter    | Description                                                 |
| ------------ | ----------------------------------------------------------- |
| `name`\*     | Name of the NFS client group in which to create the rule.   |
| `netgroup`\* | Name of the netgroup whose member hosts are granted access. |

**Columns:** `id`, `uid`, `type`, `rule`

### weka nfs rules remove

Remove NFS rules.

```sh
weka nfs rules remove
```

#### weka nfs rules remove dns

Remove a DNS rule from an NFS client group.

```sh
weka nfs rules remove dns <name> <dns>
```

| Parameter | Description                                                 |
| --------- | ----------------------------------------------------------- |
| `name`\*  | Name of the NFS client group from which to delete the rule. |
| `dns`\*   | DNS rule with \*?\[] wildcards.                             |

#### weka nfs rules remove ip

Remove an IP rule from an NFS client group.

```sh
weka nfs rules remove ip <name> <ip>
```

| Parameter | Description                                                 |
| --------- | ----------------------------------------------------------- |
| `name`\*  | Name of the NFS client group from which to delete the rule. |
| `ip`\*    | IPv4 address with a prefix length (e.g. 1.1.1.0/16).        |

#### weka nfs rules remove netgroup

Remove a netgroup rule from an NFS client group.

```sh
weka nfs rules remove netgroup <name> <netgroup>
```

| Parameter    | Description                                                 |
| ------------ | ----------------------------------------------------------- |
| `name`\*     | Name of the NFS client group from which to delete the rule. |
| `netgroup`\* | Name of the netgroup whose rule to remove.                  |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.weka.io/getting-started-with-weka/weka-cli-overview/cli-reference-guide/weka-nfs.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
