Creating a Restricted User for HyperScale X

clear

Command to clear the restricted shell screen.

cvnode

Command to administer the local node from where its is invoked, unless a remote node name is specified.

The following options are available for this command:

 
$ cvnode --help
usage: cvnode [options]
Command options for current node.
positional arguments:
  {firewall-cmd,airgap,less}
                        Sub-commands for node operations
    firewall-cmd        Commands to view Firewall Configuration on the HyperScale node
    airgap              Commands to manage airgap Configuration on the HyperScale node
    less                Securely view content from standard input
optional arguments:
  -h, --help            show this help message and exit
  --node  [ ...]
                        If not specified, execute on local node. If specified, execute on specified node.
                        This can be applied to any of the node optional arguments;
                        Example: [--get_serial_number --node ]
                        NOTE: Passwordless SSH must be configured for remote nodes.
  --get_serial_number   Show serial number of the node.
  --gethostname         Show hostname of the node.
  --cat   Show only allowed file's content.
                        Does not support --node option.
  --tail [ [ ...]]
                        Show file content using 'tail' command.
                        Run [--tail ++help] option to check detailed usage.
                        Does not support --node option.
  --df                  Executes command 'df -h'.
  --sestatus            Executes command 'sestatus'. Used to check if ransomware protection is enabled.
  --lsblk               Executes command 'lsblk'.
  --lsscsi              Executes command 'lsscsi'.
  --lsmod               Executes command 'lsmod'.
  --fdisk               Executes command 'fdisk -l'.
  --grep SEARCH_WORD    Executes command 'grep -iF SEARCH_WORD -'.
                        Use it by piping output from other commands.
                        Does not support --node option.
                        Sample usage of the command:
                        1. cvnode --df | cvnode --grep "raidvg"
  --commvault SUBCOMMAND
                        Executes command 'commvault (list|status|start|restart|start_services|stop)'.
                        'start_services' subcommand can be used to start services as OS update does.
  --dmidecode           Executes command 'dmidecode -t system'.
  --date                Executes command 'date'.
  --netstat             Executes command 'netstat -rn'.
  --blkid               Executes command 'blkid'.
  --mount               Executes command 'mount'.
  --uname               Executes command 'uname -a'.
  --rpm                 Executes command 'rpm -qa'.
  --ulimit              Executes command 'ulimit -a'.
  --uptime              Executes command 'uptime'.
  --resume_protection   Sets the node in enforcing mode.
  --ping IP/Hostname    Executes command 'ping IP/Hostname'. Does not support --node option.
  --nslookup IP/Hostname
                        Executes command 'nslookup IP/Hostname'. Does not support --node option.
  --change_password     Change cvbackupadmin user password for local node.
  --network_stats       Display Network performance stats from current node to node(--node).
  --enable_protection   Enable Ransomware Protection on local node.
  --safe_reboot [verbose= [restart=  ...]]
                        Initiates safe reboot on local node.
  --lastreboot_resume [verbose= [verbose= ...]]
                        Resumes previous failed safe reboot operation if one exists.
  --lastreboot_status   Displays status of currently running or recently Failed/successful safe reboot operation.
  --safe_shutdown [manual_resume= [enable_root_access= verbose= restart=  ...]]
                        Initiates safe shutdown on local node.
  --lastshutdown_resume [verbose= [verbose= ...]]
                        Resumes previous failed safe shutdown operation if one exists.
  --lastshutdown_status
                        Displays status of currently running or recently Failed/successful safe shutdown operation.
  --cds SUBCOMMAND      Shows cds related information. use --cds help to get more information.
  --set_ire_csdp_interfaces [interfaces= [interfaces= ...]]
                        Provide comma seperated list of interfaces to use as IRE CSDP interfaces.
                        Example: --set_ire_csdp_interfaces interfaces=enpsf1,enpsf1,...
                        Possible values for interfaces= include a list of interfaces like enpsf1,enpsf2,enpsf3
                        OR single interface like enpsf1
                        OR empty list like intefaces=
                        Provide empty list to unset IRE CSDP nw.
                        All interfaces provided in the list should be of Data Protection type.
  --display_airgap_configuration
                        Display Airgap Configuration.
  --is_migrated         Check if the node is migrated to HyperScale 3.x.

cvcluster

Command to administer all the nodes in a cluster.

The following options are available for this command:

 
$ cvcluster --help
usage: hs_cluster [options]
These actions are preformed across the entire cluster, for each and every node.
positional arguments:
  {airgap}              Sub-commands for cluster operations
    airgap              Commands to manage airgap Configuration on the HyperScale cluster
optional arguments:
  -h, --help            show this help message and exit
  --node NODE           Provide the list of cluster nodes to operate against.
                        This can be applied to any of the cluster optional arguments;
                        Example: [--get_serial_number --cluster --node node1 --node node2 --node node3 etc...
                        NOTE: Passwordless SSH must be configured for remote nodes.
  --get_serial_number   Show serial number for each node in the cluster.
  --sestatus            'sestatus' command is executed on all nodes and prints output on the screen.
  --lsblk               'lsblk' command is executed on all nodes and prints output on the screen.
  --lsscsi              'lsscsi' command is executed on all nodes and prints output on the screen.
  --lsmod               'lsmod' command is executed on all nodes and prints output on the screen.
  --fdisk               'fdisk -l' command is executed on all nodes and prints output on the screen.
  --df                  'df -h' command is executed on all nodes and prints output on the screen.
  --commvault SUBCOMMAND
                        'cvnode --commvault' command is executed on all nodes and prints output on the screen.
  --dmidecode           'dmidecode -t system' command is executed on all nodes and prints output on the screen.
  --date                'date' command is executed on all nodes and prints output on the screen.
  --netstat             'netstat -rn' command is executed on all nodes and prints output on the screen.
  --blkid               'blkid' command is executed on all nodes and prints output on the screen.
  --mount               'mount' command is executed on all nodes and prints output on the screen.
  --uname               'uname -a' command is executed on all nodes and prints output on the screen.
  --rpm                 'rpm -qa' command is executed on all nodes and prints output on the screen.
  --ulimit              'ulimit -a' command is executed on all nodes and prints output on the screen.
  --uptime              'uptime' command is executed on all nodes and prints output on the screen.
  --resume_protection   Sets Selinux to enforcing mode on all nodes in the cluster.
  --get_remote_cache    Find which node is the remote cache node of this cluster.
  --get_temp_remote_cache
                        Find which node is the temporary remote cache node of this cluster.
  --network_stats       Display Network performance stats to all nodes from current node in the cluster.
  --enable_protection   Enable Ransomware Protection on all nodes in the cluster.
  --change_password     Change cvbackupadmin user password on all nodes in the cluster.
  --cds SUBCOMMAND      Shows cds related information from all nodes in the cluster. use --cds help to get more information.
  --lift_airgap [startdate= starttime= [window= ...]]
                        Lifts airgap for provided interval on all nodes of the cluster.
                        Eg: --lift_airgap startdate=2024-06-11 starttime=11:00 window=5
                        Default value of startdate when not given is current date.
                        Default value of starttime when not given is current time.
                        unit of window value is minute.
                        window=0 will set airgap.
  --set_airgap_probe_frequency [frequency= [frequency= ...]]
                        CS Probe frequency interval for airgap.
                        Eg: --set_airgap_probe_frequency frequency=10
                        unit of frequency value is minute
                        frequncy value can be any value between [5, 1440]
  --set_airgap_min_auxcopy_threshold [threshold= [threshold= ...]]
                        Minimum threshold data to open airgap for aux copy.
                        Eg: --set_airgap_min_auxcopy_threshold threshold=2024
                        unit of threshold value is Megabyte
                        threshold value can be any value >= 1024
  --permanent_airgap [action= [action= ...]]
                        set and unset Permanent Airgap.
                        Eg: --permanent_airgap action=set
                        action value can be one off [set, unset].
                        action=set will set the cluster in permanent airgap until action=unset.
  --list                Show all nodes in the cluster.
  --safe_reboot [verbose= [restart= silent=  ...]]
                        Initiates safe reboot of cluster.
  --lastreboot_resume [verbose= [verbose= ...]]
                        Resumes previous failed safe reboot operation if one exists.
  --lastreboot_status   Displays status of currently running or recently Failed/successful safe reboot operation.
  --safe_shutdown [manual_resume= [enable_root_access= verbose= restart= silent=  ...]]
                        Initiates safe shutdown of cluster.
  --lastshutdown_resume [verbose= [verbose= ...]]
                        Resumes previous failed safe shutdown operation if one exists.
  --lastshutdown_status
                        Displays status of currently running or recently Failed/successful safe shutdown operation.
  --display_airgap_configuration
                        Display Airgap Configuration.
  --enable_https_probe  Configure Airgap to use HTTPS probe.
  --disable_https_probe
                        Configure Airgap to use cvfwd probe.
  --is_migrated         Check if each node in the cluster is migrated to HyperScale 3.x.

enable_ransomware_protection

Command to enable ransomware protection on the nodes.

Reboot the node after enabling ransomware using the following command:

$ cvnode –reboot

osupdate

Command to upgrade the operating system (OS).

The following options are supported for this command:

cvnode --is_migrated

Command to verify the migration status.

Execute the following command:

cvnode --is_migrated

• On a 2.x node: Migration is not attempted.

• On a new 3.x node: Migration is not required.

• On a node with migration not yet completed and reimaged with Rocky during the process: Migrate is in progress.

• On a node after completion of migration: Migration completed.