Windows
ad-discover
ad-discover [options]
Discover Active Directory realm
Options
--help
Display this help and exit
--realm
Active Directory realm name (Required)
ad-config
ad-config [options]
View and modify Active Directory configuration.
Options
--ad-servers
An ordered, comma-separated list of Active Directory servers to be used when authenticating. This may be used to prefer closer, or faster servers first. Values may be in IP or DNS form and may optionally have a colon port suffix.
192.168.5.5:389,my.ad.net
--ad-servers-clear
Removes the list of ad_servers.
--anvil-dns-name
Specifies a DNS name for this anvil to be known by in AD.
Specifies a separate DNS name for the Anvil, distinct from the data portals' name set with --portal-dns-name. Required for NFS v4.2 clients that mount with Kerberos security (sec=krb5) — if it cannot be resolved, those mounts hang and eventually time out or fail. See Joining an Active Directory Domain for how the Anvil and Portal DNS names differ and what each defaults to.
--computer-ou
The distinguished name of an organizational unit in which to create the computer account.
--dns-auto-register-floating-ips-disable
Prevents the product from automatically keeping floating IPs registered with Active Directory’s DNS. When disabled, only IPs in the list of DNS configured IPs are registered.
--dns-auto-register-floating-ips-enable
Causes the product to automatically keep floating IPs registered with Active Directory’s DNS. When enabled, there is no need to specify floating IPs in the list of DNS configured IPs. Note that this functionality requires that the username be an account with privileges to manage DNS records.
--dns-configured-ip-add
Add an address (which is listed among the DNS available IPs) to be registered with Active Directory’s DNS. This parameter may be repeated.
Add an address (which is listed among the DNS available IPs) to be registered with Active Directory’s DNS. Only portal floating IPs and Data Portal IPs in the DATA role may be specified. This parameter may be repeated.
--dns-configured-ip-remove
Remove a value from the list DNS configured IPs. This parameter may be repeated.
--dns-configured-ips
A manually-specified, comma-separated list of IP addresses to register with Active Directory’s DNS. Valid IPs include portal floating IPs, cluster floating IPs, and Data Portal IPs in the DATA role.
--dns-configured-ips-clear
Remove all values from the list of IP addresses to register with Active Directory’s DNS.
--flush-cache
Flush Active Directory cache.
--help
Display this help and exit
--id-mapping-domains
An ordered, comma-separated list of local domains for use with ID mapping. This can be used to configure the order in which domains will be used when resolving a user.
example.local,example.internal,corp.example.com,forest.example.com
--id-mapping-domains-clear
Clear customized local domains and use the default list for ID mapping.
--identity-mapping-schema
The schema used to map Active Directory SIDs to uids and gids. When AD (which is the default) is specified, no cross-protocol user mapping between NFS and SMB takes place. Possible values: RFC2307 | RFC2307BIS | AD.
--join
Join Active Directory domain.
--leave
Leave from Active Directory domain.
--password
Password for the username.
--portal-dns-name
Specifies a DNS name for the data portals to be known by in AD. Sometimes referred to as the NetBIOS name. May only be specified when joining. When not specified, the current cluster name is used, or if portal-dns-name was previously set, it is used.
Specifies the DNS/NetBIOS name the data portals are known by in AD. May only be specified when joining. When not specified, the current cluster name is used, or if a portal DNS name was previously set, it is used. In Hammerspace 5.2 this option was named --smb-server-name; scripts using the old name must switch to --portal-dns-name.
--realm
Active Directory realm.
--recreate-nfs-spns
Recreate NFS SPNs.
--remove-computer
Attempt to remove the computer from the domain (password required if specified).
--username
Active directory account name with privileges to add or remove workstations to or from a domain.
--view
View Active Directory configuration.
domain-idmap-add
domain-idmap-add [options]
Create domain ID mapping rule
Options
--attribute
Rule attribute (Required)
--bidirectional
Create bidirectional rule
--from
Domain to map from (Required)
--help
Display this help and exit
--inherit-from
Inherit by subtrees of domain to map from
--inherit-to
Inherit by subtrees of domain to map to
--no-inherit-from
Don’t Inherit by subtrees of domain to map from
--no-inherit-to
Don’t Inherit by subtrees of domain to map to
--order
Rule order
--to
Domain to map to (Required)
domain-idmap-delete
domain-idmap-delete [options]
Delete domain ID mapping rule
Options
--from
Domain to map from
--help
Display this help and exit
--id
Domain mapping ID
--to
Domain to map to
domain-idmap-list
domain-idmap-list [options]
List domain ID mapping rules
Options
--full
Print extra information for each element
--help
Display this help and exit
--id
domain ID mapping ID
domain-idmap-reload
domain-idmap-reload [options]
Reload domain ID mapping rules
Options
--help
Display this help and exit
smb-config
smb-config [options]
Configures and views SMB parameters.
|
These options set System Management configuration values. For most options the effect on SMB services follows directly from the option name, but not in every case. Where the effect differs from what the name implies, it is called out on the individual option — read the option description before changing a setting on a production cluster. |
Options
--acl
Access Control List for the SMB autohome directory. Possible values: PUBLIC | GROUP | PRIVATE.
Access control list to apply to the autohome entry. Requires --autohome-create or --autohome-update.
--autohome-create
Create a new SMB autohome entry
Create an SMB autohome entry. Requires a share selector (--share-id, --share-name, or --share-internal-id), --home-share-name, and exactly one of --username or --default.
--autohome-delete
Delete an SMB autohome entry
Delete an SMB autohome entry. Requires one of --id, --internal-id, --default, or --username.
--autohome-disable
Disable SMB autohome feature system-wide
--autohome-enable
Enable SMB autohome feature system-wide
--autohome-update
Update an existing SMB autohome entry
Update an existing SMB autohome entry. Requires one of --id, --internal-id, --default, or --username.
--create-homedir
Whether to auto-create the autohome directory if missing. The parent path must exist, or the autohome share won’t be published.
Create the home directory for the autohome entry. Requires --autohome-create or --autohome-update.
--default
Indicates this is the default SMB autohome entry
Applies the autohome operation to the default entry rather than to a named user. Mutually exclusive with --username, --id, and --internal-id.
--distributed-lock-manager-disable
Disable the distributed lock manager for SMB data access. Only use when file locking, including byte-range locking is not required. This setting applies to all shares.
--distributed-lock-manager-enable
Enable the distributed lock manager for SMB data access.
--help
Display this help and exit
--home-share-name
Home share name presented to the SMB user
Name of the home share created for the autohome entry. Requires --autohome-create or --autohome-update.
--id
The ID of the SMB autohome entry to update, or delete
Identifier of the autohome entry to update or delete. Mutually exclusive with --username and --default.
--internal-id
The internal ID of the SMB autohome entry to update, or delete
Internal identifier of the autohome entry to update or delete. Mutually exclusive with --username and --default.
--min-smb-client
The minimal SMB client protocol (SMB1, SMB2, SMB2_10, SMB3, SMB3_11).
Sets the minimum SMB dialect (SMB1, SMB2, SMB2_10, SMB3, SMB3_11). Requires an argument.
|
Do not use this option. It does not take effect, and Hammerspace does not support using it to change the minimum SMB dialect. |
--multichannel-disable
Disable multichannel support
--multichannel-enable
Enable multichannel support
--path
The path to the SMB autohome directory
Path used for the autohome entry. Requires --autohome-create or --autohome-update.
--share-id
The ID of the share to be used for the SMB autohome
Identifies the share the autohome entry applies to, by ID. Requires --autohome-create or --autohome-update.
--share-internal-id
The internal ID of the share to be used for the SMB autohome
Identifies the share the autohome entry applies to, by internal ID. Requires --autohome-create or --autohome-update.
--share-name
The name of the share to be used for the SMB autohome
Identifies the share the autohome entry applies to, by name. Requires --autohome-create or --autohome-update.
--username
Username for which this SMB autohome is created
Applies the autohome operation to the entry for this user. Mutually exclusive with --default, --id, and --internal-id.
--view
View current Active Directory configuration.