QQ CLI: Comprehensive List of Commands

The list below reflects qq commands available the latest version of Qumulo Core. Certain commands may be unavailable if you are running a previous version and will require upgrading to a later release.

REQUIREMENTS

Cluster is in quorum and qfsd process is running on the selected node
Command line (CLI) tools installed via API & Tools in the Web UI
Admin privileges on the Qumulo cluster

COMPREHENSIVE LIST OF COMMANDS

qq ad_cancel	Cancel current AD join/leave operation and clear errors
qq ad_clear_cache	Clear the AD ID mapping cache
qq ad_distinguished_ name_to_account	Get all account info for a distinguished name
qq ad_expand_groups	Get the SIDs of all the groups (including nested) that the given SID is a member of
qq ad_get_advanced_settings	Get advanced Active Directory settings
qq ad_gid_to_sids	Get SIDs from GID
qq ad_join	Join an Active Directory Domain
qq ad_leave	Leave an Active Directory Domain
qq ad_list	List Active Directory Configuration
qq ad_name_to_accounts	Get all account info for a sAMAccountName
qq ad_poll	Poll Active Directory Configuration
qq ad_reconfigure	Reconfigure Active Directory POSIX Attributes
qq ad_set_advanced_settings	Modify advanced Active Directory settings
qq ad_sid_to_account	Get all account info for a SID
qq ad_sid_to_gid	Get GID from SID
qq ad_sid_to_uid	Get UID from SID
qq ad_sid_to_username	Get AD username from SID
qq ad_uid_to_sids	Get SIDS from UID
qq ad_username_to_sids	Get SIDs from an AD username
qq add_nodes	Add un-configured nodes to a Qumulo Cluster
qq audit_get_cloudwatch_config	Get audit CloudWatch configuration
qq audit_get_cloudwatch_status	Get audit CloudWatch status
qq audit_get_syslog_config	Get audit syslog server configuration
qq audit_get_syslog_status	Get audit syslog server status
qq audit_set_cloudwatch_config	Change audit CloudWatch configuration
qq audit_set_syslog_config	Change audit configuration
qq auth_add_group	Add a new group
qq auth_add_user	Add a new user
qq auth_assign_role	Assign a user to a role
qq auth_clear_cache	Clear all cached authorization information
qq auth_create_role	Create a custom role
qq auth_delete_group	Delete a group
qq auth_delete_role	Delete a custom role
qq auth_delete_user	Delete a user
qq auth_expand_identity	Find equivalent identities and full group membership
qq auth_find_identity	Find all representations of a given identifier
qq auth_get_user_ defined_mappings	Get the configured set of AD/LDAP static user defined mappings
qq auth_list_group	List a group
qq auth_list_groups	List all groups
qq auth_list_privileges	List all privileges or privileges associated with a role
qq auth_list_role	List a role
qq auth_list_roles	List all of the roles
qq auth_list_user	List a user
qq auth_list_users	List all users
qq auth_mod_group	Modify a group
qq auth_mod_user	Modify a user
qq auth_modify_role	Modify a custom role
qq auth_set_password	Set a user's password
qq auth_set_user_ defined_mappings	Replace the configured set of AD/LDAP static identity mappings
qq auth_unassign_role	Unassign a user from a role
qq capacity_history_files_get	Get historical largest file data
qq capacity_history_get	Get capacity history data
qq change_password	Change your password
qq checksumming_get_status	Get the advanced data protection status for the cluster
qq cluster_conf	Get the cluster config
qq cluster_create	Creates a Qumulo Cluster
qq cluster_slot_set_config	Set the attributes for the given cluster slot. Currently only led_pattern may be set.
qq cluster_slots	Get the cluster disk slots status
qq current_activity_get	Get the current sampled IOP and throughput rates
qq dns_get_lookup_overrides	List the configured set of DNS lookup overrides. These rules override any lookup results from the configured DNS servers and serve as static mappings between IP address and hostname
qq dns_resolve_hostnames	Resolve hostnames to IP addresses
qq dns_resolve_ips	Resolve IP addresses to hostnames
qq dns_set_lookup_overrides	Replace the configured set of DNS lookup overrides. These rules override any lookup results from the configured DNS servers and serve as static mappings between IP address and hostname
qq encryption_get_status	Get at-rest encryption status
qq floating_ip_allocation	Get cluster-wide floating IP allocation
qq fs_acl_explain_chmod	Explain how setting a POSIX mode would affect a file's acl
qq fs_acl_explain_posix_mode	Explain the derivation of POSIX mode from a file's ACL
qq fs_acl_explain_rights	Explain how rights are granted to a user for a file. *Note that this command does not discover the user's groups and related identities when computing rights. To provide this information, use the -g argument.
qq fs_copy	Server-side copy files
qq fs_create_dir	Create a new directory
qq fs_create_file	Create a new file
qq fs_create_link	Create a new link
qq fs_create_symlink	Create a new symbolic link
qq fs_create_unix_file	Create a new pipe, character device, block device or socket
qq fs_delete	Delete a file system object
qq fs_file_get_attr	Get file attributes
qq fs_file_samples	Get a number of sample files from the file system
qq fs_file_set_attr	Set file attributes
qq fs_file_set_smb_attrs	Set SMB extended attributes on the file
qq fs_get_acl	Get file ACL
qq fs_get_atime_settings	Get access time (atime) settings
qq fs_get_permissions_settings	Get permissions settings
qq fs_get_stats	Get file system statistics
qq fs_list_lock_ waiters_by_client	List waiting lock requests for a particular client machine
qq fs_list_lock_ waiters_by_file	List waiting lock requests for a particular files
qq fs_list_locks	List file locks held by clients.
qq fs_list_named_streams	List all named streams on a file or directory
qq fs_modify_acl	Modify file ACL
qq fs_punch_hole	Create a hole in a region of a file. Destroys all data within the hole.
qq fs_read	Read a file
qq fs_read_dir	Read a directory
qq fs_read_dir_aggregates	Read directory aggregation entries
qq fs_release_nlm_lock	Release an arbitrary NLM byte-range lock range - Only use as a last resort after confirming that the owning process has leaked the lock
qq fs_release_nlm_ locks_by_client	Release NLM byte range locks (ALL) held by client - Only use as a last resort after confirming that the client is dead
qq fs_remove_stream	Remove stream from a file or directory
qq fs_rename	Rename a file system object
qq fs_resolve_paths	Resolve file IDs to paths
qq fs_set_acl	Set file ACL
qq fs_set_atime_settings	Specify access time (atime) settings
qq fs_set_ permissions_settings	Set permissions settings
qq fs_walk_tree	Walk file system tree
qq fs_write	Write data to a file
qq ftp_get_status	Get FTP server status and settings
qq ftp_modify_settings	Set FTP settings
qq get_vpn_keys	Get VPN keys stored in the cluster
qq halt_cluster	Halt the cluster
qq help	QQ documentation
qq identity_attributes_get	Get attributes related to the given identity.
qq identity_attributes_set	Set attributes related to the given identity.
qq install_vpn_keys	Install VPN keys
qq kerberos_delete_keytab	Delete the Kerberos keytab
qq kerberos_get_keytab	Get the Kerberos keytab
qq kerberos_get_settings	Get the Kerberos settings
qq kerberos_modify_settings	Modify the Kerberos settings
qq kerberos_set_keytab	Set the Kerberos keytab
qq ldap_get_settings	Get LDAP server settings from disk
qq ldap_get_status	Get LDAP client connection states
qq ldap_login_ name_to_gid_numbers	Query the LDAP server for the gid numbers for all the groups of which the given login name is a member. This returns a vector of results in the case that the given login name maps to multiple uid numbers.
qq ldap_login_ name_to_uid_numbers	Get the uidNumbers from a login name using the LDAP server
qq ldap_set_settings	Set LDAP server settings on disk
qq ldap_uid_number_ to_login_name	Get login name from uidNumber using LDAP server
qq ldap_update_settings	Update LDAP server settings on disk
qq login	Log in to qfsd to get REST credentials
qq logout	Remove qfsd REST credentials
qq monitoring_conf	Get monitoring configuration
qq monitoring_status_get	Get current monitoring status
qq network_add_network	Add network configuration
qq network_delete_network	Delete network configuration
qq network_get_interface	Get configuration for the specified interface
qq network_get_network	Get configuration for the specified network
qq network_list_connections	Get the list of SMB and NFS protocol connections per node
qq network_list_interfaces	List configurations for interfaces on the cluster
qq network_list_networks	List network configurations
qq network_mod_interface	Modify interface configuration
qq network_mod_network	Modify network configuration
qq network_poll	Poll network status
qq nfs_add_export	Add a new NFS export
qq nfs_delete_export	Delete an export
qq nfs_get_export	Get an export
qq nfs_get_settings	Shows whether NFSv4.1 is enabled. For more information, see Enabling and Using NFSv4.1 on a Qumulo Cluster.
qq nfs_list_exports	List all NFS exports
qq nfs_mod_export	Modify an export
qq nfs_mod_ export_host_access	Modify host access on an export
qq nfs_modify_settings --enable-v-4	Immediately enables NFSv4.1 across the cluster. For more information, see Enabling and Using NFSv4.1 on a Qumulo Cluster.
qq nfs_modify_settings --disable-v-4	Immediately disables NFSv4.1 across the cluster. For more information, see Enabling and Using NFSv4.1 on a Qumulo Cluster.
qq node_chassis_status_get	Get the status of a node chassis
qq node_state_get	Get the operational status of a node
qq nodes_list	List nodes
qq protection_status_get	Get cluster protection status
qq quota_create_quota	Create a directory quota
qq quota_delete_quota	Delete a directory quota
qq quota_get_quota	Get a directory quota
qq quota_list_quotas	List all directory quotas
qq quota_update_quota	Update a directory quota
qq raw	Issue an HTTP request to a Qumulo REST endpoint. Content for modifying requests (for example, PATCH, POST, and PUT) can be provided on stdin. Output is provided on stdout.
qq replication_ abort_object_replication	Abort any ongoing replication job for the specified object replication relationship
qq replication_ abort_replication	Abort ongoing replication work for the specified source replication relationship
qq replication_ add_blackout_window	Add a blackout window to the specified source of the replication relationship
qq replication_authorize	Authorize the specified replication relationship to establish the cluster as the target of the replication
qq replication_ create_object_relationship	Create an object replication relationship that initiates a one-time copy of file data to S3
qq replication_ create_source_relationship	Create a new replication relationship
qq replication_ delete_blackout_windows	Delete blackout windows of the specified source replication relationship
qq replication_ delete_object_relationship	Delete the specified object replication relationship, which must not be running a job
qq replication_ delete_source_relationship	Delete the specified source replication relationship
qq replication_ delete_target_relationship	Delete the specified target replication relationship
qq replication_ get_object_relationship	Get the configuration of the specified object replication relationship
qq replication_ get_object_relationship_status	Get current status of the specified object replication relationship
qq replication_ get_source_relationship	Get information about the specified source replication relationship
qq replication_ get_source_relationship_status	Get current status of the specified source replication relationship
qq replication_ get_target_relationship_status	Get current status of the specified target replication relationship
qq replication_ link_snapshot_policy	Link a snapshot policy to the specified source replication relationship to replicate snapshots taken by the policy. The replication mode will be set to REPLICATION_SNAPSHOT_ POLICY_WITH_CONTINUOUS when linking the first policy, otherwise the existing mode will be preserved. The mode can be modified with the replication_set_snapshot _policy_replication_mode command or by removing all linked snapshot policies.
qq replication_ list_queued_snapshots	List information for all snapshots awaiting replication by the specified source replication relationship.
qq replication_ list_object_relationships	List all the existing object replication relationships
qq replication_ list_source_relationships	List existing source replication relationships
qq replication_ list_object_relationship_statuses	List the statuses for all existing object replication relationships
qq replication_ list_source_relationship_statuses	List statuses for all existing source replication relationships
qq replication_list_ target_relationship_statuses	List statuses for all existing target replication relationships
qq replication_ make_target_writable	Revert target directory to the latest recovery point to ensure that it is in a point-in-time consistent state. Then disconnect the specified target replication relationship, breaking the relationship with the source and making the target directory writable. The revert action may take some time to complete. If the relationship is later reconnected, any changes made to the target directory since the relationship was disconnected will be reverted upon reconnecting.
qq replication_ modify_source_relationship	Modify an existing source replication relationship
qq replication_ reconnect_target_relationship	Make the target directory read-only and revert any changes made to the target directory since the latest recovery point. Then reconnect the specified target replication relationship with its source directory. The revert action may take some time to complete before replication is resumed.
qq replication_ release_queued_snapshot	Release a snapshot queued for replication from the queue of the specified source replication relationship.
qq replication_replicate	Replicate from the source to the target of the specified relationship
qq replication_ reverse_target_relationship	Reverse source and target for the specified replication relationship. This operation is initiated on the target cluster. The previous target directory will be made the new source, and the previous source directory will be made the new target. After reversal completes, blackout windows will be reset and the relationship will remain disconnected, where replication will not resume. To resume replication after reversal, configure blackout windows from the new source cluster and reconnect the relationship from the new target cluster.
qq replication_set_snapshot _policy_replication_mode	Set the replication mode of the specified source replication relationship. This command is only for a relationship that has linked snapshot policies.
qq replication_start_ object_relationship	Start a new replication job for an existing object replication relationship.
qq replication_ unlink_snapshot_policy	Unlink a linked snapshot policy from the specified source replication relationship. The replication mode will be set to REPLICATION_CONTINUOUS when unlinking the last policy, otherwise the existing mode will be preserved.
qq reboot_pause	Pauses a reboot in progress.
qq reboot_resume	Resumes a paused reboot in progress.
qq reboot_start	Restart a cluster. The optional `--rolling` flag performs a rolling reboot.
qq reboot_status	Displays the status of a reboot, including: Reboot state Reboot type Total number of nodes in cluster Total number of rebooted nodes Any error messages encountered during reboot
qq restart_cluster	Restart the cluster
qq restriper_status	Get restriper status
qq rotate_encryption_keys	Rotate the at-rest encryption master keys
qq set_cluster_conf	Set the cluster config
qq set_monitoring_conf	Update the monitoring config
qq set_node_identify_light	Turn node identification light on or off
qq smb_add_share	Add a new SMB share
qq smb_close_file_handle	Force close a specified SMB file handle
qq smb_close_sessions	Force close SMB sessions matching one or more of a set of filters
qq smb_delete_share	Delete a share
qq smb_get_settings	Get SMB server settings
qq smb_list_file_handles	List SMB open file handles
qq smb_list_sessions	List SMB open sessions
qq smb_list_share	List a share
qq smb_list_shares	List all SMB shares
qq smb_mod_share	Modify a share
qq smb_mod_share_permissions	Modify a share's permissions
qq smb_modify_settings	Set SMB server settings
qq snapshot_ calculate_used_capacity	Get the space used by the specified snapshots
qq snapshot_create_policy	Create a new snapshot scheduling policy
qq snapshot_create_snapshot	Create a new snapshot
qq snapshot_delete_policy	Delete a single scheduling policy
qq snapshot_delete_snapshot	Delete a single snapshot
qq snapshot_diff	List the differences between two snapshots
qq snapshot_file_diff	List changed byte ranges of a file between two snapshots
qq snapshot_ get_capacity_used_per_snapshot	Get the approximate amount of space for each snapshot that would be reclaimed if deleted
qq snapshot_get_policy	Get a single policy
qq snapshot_get_policy_status	Get a single snapshot policy status
qq snapshot_get_snapshot	Get a single snapshot
qq snapshot_get_status	Get status of a single snapshot
qq snapshot_ get_total_used_capacity	Get the total space consumed by all snapshots
qq snapshot_list_policies	Lists all policies
qq snapshot_list_ policy_statuses	List all snapshot policy statuses
qq snapshot_list_snapshots	List all snapshots
qq snapshot_list_statuses	List all snapshot statuses
qq snapshot_modify_policy	Modify an existing snapshot scheduling policy
qq snapshot_modify_snapshot	Modify an existing snapshot
qq ssl_delete_ca_certificate	Delete SSL CA certificate
qq ssl_get_ca_certificate	Get SSL CA certificate
qq ssl_modify_ca_certificate	Set SSL CA certificate
qq ssl_modify_certificate	Set SSL certificates
qq static_ip_allocation	Get cluster-wide static IP allocation
qq time_get	Get time configuration
qq time_list_timezones	List timezones supported by QC
qq time_series_get	Get specified time series data
qq time_set	Set time configuration
qq time_status	Get time configuration status
qq tree_delete_cancel	Cancel delete job
qq tree_delete_create	Create delete job
qq tree_delete_get	Get information about one delete job
qq tree_delete_list	Get information about all tree delete jobs
qq unconfigured_nodes_list	Get the list of unconfigured nodes
qq upgrade_cluster	Run a cluster upgrade to the image specified by the provided path
qq unconfigured_upgrade_config	Get the parameters for the upgrade
qq unconfigured_upgrade_config_set	Set the parameters for the upgrade
qq unconfigured_upgrade_status	Get the status of the upgrade system
qq upgrade_verify_image	Verify an image path for upgrade
qq version	Print current version information
qq web_ui_modify_settings	View the current inactivity timeout Enable the inactivity timeout by using the `--inactivity-timeout` flag and specifying minutes (2 minutes by default) Disable the inactivity timeout by using the `--disable-inactivity-timeout` flag
qq who_am_i	Get information on the current user