Rubrik CDM Version 6.0 CLI Reference Guide (Rev. B3)

Rubrik CDM CLI Reference
Version 6.0
755-0148-01 B3
Rubrik Headquarters: Palo Alto, California 94304

1-844-4RUBRIK www.rubrik.com
Legal Notices
Copyright and trademarks

Copyright
Copyright © 2021 Rubrik Inc.

All rights reserved. This document may be used free of charge. Selling without prior written consent is
prohibited. Obtain permission before redistributing. In all cases, this copyright notice and disclaimer must
remain intact.
THE CONTENTS OF THIS DOCUMENT ARE PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO
REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT,
OR TITLE; THAT THE CONTENTS OF THE DOCUMENT ARE SUITABLE FOR ANY PURPOSE; THAT THE
IMPLEMENTATION OF SUCH CONTENTS WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
TRADEMARKS OR OTHER RIGHTS.
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL
DAMAGES ARISING OUT OF ANY USE OF THE DOCUMENT OR THE PERFORMANCE OR IMPLEMENTATION
OF THE CONTENTS THEREOF.
Trademarks
Registered in the U.S. Trademark Office

Rubrik, the Rubrik graphic, and Datos IO are registered trademarks of Rubrik, Inc. in the U.S. and other
countries. Additionally, Rubrik, Inc. holds common law trademark rights in Rubrik Polaris, Polaris GPS,
Polaris Radar, Polaris Sonar, Rubrik Envision, Rubrik Edge, and Mosaic in the U.S. and/or other countries.
All other trademarks are the property of their respective owners.
Legal Notices
Certain products and features, including the Rubrik-hosted mode of Polaris for Microsoft 365 Protection,
are subject to additional product-specific terms available at https://www.rubrik.com/en/legal.
By using the Rubrik Polaris Sonar application, you understand and acknowledge that Rubrik Polaris Sonar’s
pre-existing Policies and Analyzers contain general suggestions for data elements and formats based on
common data sets and formats. The suggested data elements and formats in Rubrik Polaris Sonar are not
intended to be a comprehensive or exhaustive list of data elements and formats regulated by the GDPR,
CCPA or any other applicable laws and regulations. We also do not guarantee that your Rubrik Polaris
Sonar search results will include every instance of each data element and format within your data set. We
Copyright and trademarks 08/17/2021 | ii

strongly recommend that you consult legal counsel for specific advice regarding compliance with applicable
laws and regulations.
Rubrik Polaris Sonar is designed to assist customers with identifying certain data elements and formats and
should not be solely relied upon to identify all data elements and formats of a certain type for any purpose,
including legal or compliance.
Use of the Polaris Management Console software is subject to additional product-specific terms available at
https://www.rubrik.com/en/legal.
Copyright and trademarks 08/17/2021 | iii

Preface
Welcome to Rubrik. We appreciate your interest in our products.
Rubrik is continually working to improve its products and regularly releases revisions and new versions.
Some information provided by this guide may not apply to a particular revision or version of a product.
Review the release notes for the product to see the most up-to-date information about that product.
Support
Use one of the following methods to contact Rubrik Support.
Web Rubrik Support Portal

Phone See Get In Touch for contact options.
Email support@rubrik.com
Revision history
The revision history of this guide.
Revision Date Description

Rev. B0 May 2021 • Produced book in new format.
• Added the cluster install and cluster setupnetwork
commands.
Rev. B1 June 2021 • Added the cluster health_monitor get_policies and

cluster health_monitor get_status, and cluster
health_monitor run_policies, network re_ip and network
floating_ips commands.
• Added job type INPLACE_EXPORT_VMWARE_SNAPSHOT to job_status.
Rev. B2 July 2021 General Availability release of Rubrik CDM version 6.0.
Rev. B3 Aug 2021 Added the cluster upgrade download_and_precheck, cluster
upgrade list_available_versions, cluster upgrade resume,
cluster upgrade rollback, cluster upgrade start, and
cluster upgrade status commands.
Preface 08/17/2021 | iv
Related documentation
Rubrik provides documentation that covers a broad range of related concepts, tasks, and reference
information.
• Rubrik Polaris User Guide
• Rubrik Polaris Radar Quick Start Guide
• Rubrik CDM Release Notes
• Rubrik CDM User Guide
• Rubrik CDM Install and Upgrade Guide
• Rubrik CDM Security Guide
• Rubrik CDM Cloud Cluster Setup Guide
• Rubrik CDM Hardware Guide
• Rubrik CDM CLI Guide
• Rubrik CDM Events Guide
• Rubrik Edge Install and Upgrade Guide
• Rubrik Virtual Cluster Install Guide
• Rubrik Compatibility Matrix
Comments and suggestions

We welcome your comments and suggestions about our products and our product documentation.
Products
To provide comments and suggestions about our products contact Rubrik Support, as described in Support.
Product documentation
To provide comments and suggestions about the product documentation, please send your message by
email to: techpubs@rubrik.com.
Please include the following information about the product documentation to help us to find the content
that is the subject or your comments:
• Full title
• Part number
• Revision
• Relevant pages
Rubrik Build
Rubrik hosts community-based tools through the Rubrik Build program and associated GitHub repositories
for community-supplied tools.
Rubrik Build is an open source program that provides access to a growing community of enthusiasts and
experts across a number of languages and tools. Rubrik Build is used to create and improve projects that
simplify monitoring, testing, development, and automated workflows for Rubrik product deployments.
Rubrik Build includes the following resources:
• Software Development Kits
Preface 08/17/2021 | v
• Tooling Integrations
• Use Cases
• Community Projects
• Rubrik REST API documentation
Important: USE AT YOUR OWN RISK. Rubrik does not officially support the community tools. Carefully
investigate a community tool before using it. Always test a community tool on non-production data before
using the tool with production data.
Contents
Rubrik Build....................................................................................................................................10
About the Rubrik CLI.....................................................................................................................11
Accessing the Rubrik CLI.............................................................................................................. 12
Using the online help.................................................................................................................... 13
Cloud management........................................................................................................................ 14
cloud network get_flag_public_or_private_ip............................................................................. 14
cloud network use_private_ip................................................................................................... 14
cloud network use_public_ip.....................................................................................................15
Cluster management......................................................................................................................16
cluster add_node..................................................................................................................... 16
cluster bootstrap...................................................................................................................... 17
cluster cluster_name................................................................................................................ 17
cluster cluster_uuid.................................................................................................................. 18
cluster discover........................................................................................................................18
cluster entitle_node..................................................................................................................19
cluster get_failed_jobs..............................................................................................................20
cluster get_node_statuses........................................................................................................ 21
cluster grace............................................................................................................................22
cluster health_monitor get_policies........................................................................................... 23
cluster health_monitor get_status............................................................................................. 24
cluster health_monitor run_policies........................................................................................... 26
cluster hw_health.....................................................................................................................27
cluster node_hostname_change................................................................................................ 29
cluster install........................................................................................................................... 30
cluster job_instances................................................................................................................30
cluster job_logs....................................................................................................................... 33
cluster ledctl............................................................................................................................ 35
cluster manual_discover........................................................................................................... 35
cluster mfg_status................................................................................................................... 36
cluster monitor........................................................................................................................ 37
cluster mount.......................................................................................................................... 38
cluster node_table................................................................................................................... 39
cluster poweroff_cluster........................................................................................................... 40
cluster poweroff_node..............................................................................................................40
cluster provide_encryption_password........................................................................................ 41
cluster reboot.......................................................................................................................... 41
cluster reset_node_status......................................................................................................... 42
cluster revert_hotpatch.............................................................................................................43
cluster rubrik_tool.................................................................................................................... 43
cluster service_status............................................................................................................... 44
cluster setupnetwork................................................................................................................ 45
cluster tpm_upgrade................................................................................................................ 47
Contents 08/17/2021 | vii

cluster umount........................................................................................................................ 47
cluster upgrade download_and_precheck.................................................................................. 48
cluster upgrade list_available_versions...................................................................................... 49
cluster upgrade resume............................................................................................................50
cluster upgrade rollback........................................................................................................... 50
cluster upgrade start................................................................................................................51
cluster upgrade status..............................................................................................................52
cluster uptime..........................................................................................................................52
cluster version......................................................................................................................... 53
commands list................................................................................................................................ 54
Network management................................................................................................................... 55
network arping........................................................................................................................ 55
network bond_mode get.......................................................................................................... 55
network bond_mode set...........................................................................................................55
network broadcast_interface get............................................................................................... 56
network broadcast_interface remove.........................................................................................56
network broadcast_interface setup............................................................................................56
network check_connectivity...................................................................................................... 57
network configure_ip_hosts_mapping........................................................................................57
network dig............................................................................................................................. 58
network esx_subnets................................................................................................................58
network esx_subnets get......................................................................................................... 58
network esx_subnets reset....................................................................................................... 59
network esx_subnets set..........................................................................................................59
network ethtool....................................................................................................................... 59
network floating_ips.................................................................................................................60
network hostname................................................................................................................... 60
network hosts..........................................................................................................................60
network ifconfig....................................................................................................................... 61
network iperf........................................................................................................................... 61
network ipv6 configure.............................................................................................................62
network ipv6 list...................................................................................................................... 62
network move_floating_ip.........................................................................................................63
network mtr............................................................................................................................ 63
network nameservers............................................................................................................... 64
network netstat....................................................................................................................... 64
network nslookup.....................................................................................................................64
network ntp_status.................................................................................................................. 65
network ping........................................................................................................................... 65
network re_ip.......................................................................................................................... 65
network route.......................................................................................................................... 67
network set_default_gateway................................................................................................... 67
network static_route add..........................................................................................................67
network static_route delete...................................................................................................... 68
network tcp_sack..................................................................................................................... 69
network vlan add.....................................................................................................................70
network vlan list...................................................................................................................... 71
network vlan remove............................................................................................................... 71
Resource management commands............................................................................................... 72

resource df.............................................................................................................................. 72
resource storage_statistics........................................................................................................72
resource system_stats.............................................................................................................. 73
resource top............................................................................................................................ 73
Contents 08/17/2021 | viii

User commands..............................................................................................................................74
users ldap............................................................................................................................... 74
Support management.................................................................................................................... 76
support cluster_support_bundle................................................................................................ 76
support decommission_status................................................................................................... 77
support find_bad_disk.............................................................................................................. 77
support iops............................................................................................................................ 78
support local_support_bundle................................................................................................... 78
support log_view..................................................................................................................... 79
support teleport regtoken.........................................................................................................81
support toggle_support_data.................................................................................................... 82
support tunnel close................................................................................................................ 83
support tunnel get_port........................................................................................................... 83
support tunnel get_timeout_type.............................................................................................. 84
support tunnel open................................................................................................................ 84
support tunnel service..............................................................................................................85
support tunnel use_absolute_timeout........................................................................................86
support tunnel use_inactivity_timeout....................................................................................... 86
Contents 08/17/2021 | ix
Chapter 1
Rubrik Build
Rubrik Build
Rubrik hosts community-based tools through the Rubrik Build program and associated GitHub repositories
for community-supplied tools.
Rubrik Build is an open source program that provides access to a growing community of enthusiasts and
experts across a number of languages and tools. Rubrik Build is used to create and improve projects that
simplify monitoring, testing, development, and automated workflows for Rubrik product deployments.
Rubrik Build includes the following resources:
• Software Development Kits
• Tooling Integrations
• Use Cases
• Community Projects
• Rubrik REST API documentation
Important: USE AT YOUR OWN RISK. Rubrik does not officially support the community tools. Carefully
investigate a community tool before using it. Always test a community tool on non-production data before
using the tool with production data.
Rubrik Build 08/17/2021 | 10

Chapter 2
About the Rubrik CLI
About the Rubrik CLI
Usage and capabilities of the Rubrik CLI environment.

The Rubrik CLI environment provides a set of command-line tools that enable system administrators to
perform advanced configuration and diagnostics on Rubrik clusters and Rubrik Edge virtual appliances.
The CLI enables users to perform tasks in the following categories:
• Cluster and node management: Commands that enable start up and shutdown for the cluster as well as
individual nodes.
• Support data collection and management: Commands that enable the collection of data into support
bundles for the use of Rubrik support, as well as the management of any existing support bundles.
• Network diagnostics and management: Commands that show network usage across the cluster and
enable network adapter management.
• Resource allocation metrics: Commands that show the use of computing resources across the cluster.
• General user management of activities within the CLI.
About the Rubrik CLI 08/17/2021 | 11

Chapter 3
Accessing the Rubrik CLI
Accessing the Rubrik CLI
Access the Rubrik CLI through an SSH session.
Procedure
1. Open an SSH session by typing the following command:
ssh admin@node_ip
Where node_ip is the IP address of a node.
2. At the password prompt, type the password for the admin account. After a successful login, the Rubrik
CLI prompt appears.
If the admin account was configured with multifactor authentication (MFA), the passcode from
the configured device is also required to login. For example, the passcode from an authenticator
application on a portable device.
Accessing the Rubrik CLI 08/17/2021 | 12

Chapter 4
Using the online help
Using the online help
Structure and usage of the Rubrik CLI online help.

The Rubrik CLI commands are grouped in submenus by topic area. Type help or ? to get the top level of
command information, showing the available submenus. As an alternative, type commands list to get a
list of all commands in all of the submenus.
Submenus group the commands into topic areas. The submenus are:
• cloud – Commands to manage Rubrik cluster cloud settings.
• cluster – Commands to manage the cluster and nodes within the cluster.
• commands – Contains only the list command, which lists all available CLI commands.
• network – Commands to analyze network performance and to manage VLANs and IP addresses.
• resource – Commands to examine and modify the use of computing resources in the cluster.
• support – Commands to generate and manage diagnostic data. These commands are for use by Rubrik
Support.
• users – Commands to view and edit user configurations.
The interface refers to a submenu as path to operation, and refers to a command as operation.
From the hostname prompt, type the submenu name alone to get a list of commands within that
submenu, or type the submenu name, followed by the command name, to run a command.
For example: typing cluster add_node runs the add_node command, which is in the cluster
submenu.
Important: The appropriate submenu name must precede the command name.
Each entered command prints its usage information, or syntax.

Type exit to exit the CLI session.
Using the online help 08/17/2021 | 13

Chapter 5
Cloud management
Cloud management
These commands manage Rubrik cluster cloud settings.

Precede these commands with the submenu name 'cloud', as in cloud use_public_ip. Tab completion
is available with these commands
cloud network get_flag_public_or_private_ip

Indicates if a public or private IP is used to connect to Rubrik Bolt instances. The default is private
Syntax
Example: Display the IP
This examples determines that the system uses a private IP.

private
cloud network use_private_ip

Configure Rubrik cluster to connect to Bolt instances using a private IP.
Syntax
cloud network use_private_ip
Example: Configure for private IP
>> cloud network use_private_ip

Now using private IP for bolt
Cloud management 08/17/2021 | 14

cloud network use_public_ip
Configure Rubrik cluster to connect to Bolt instances using a public IP.
Syntax
cloud network use_public_ip
Example: Configure for private IP
>> cloud network use_public_ip

Now using public IP for bolt
Cloud management 08/17/2021 | 15

Chapter 6
Cluster management
Cluster management
These commands manage a Rubrik cluster and the individual nodes in it.
Precede these commands with the submenu name 'cluster', as in cluster add_node.
cluster add_node
Add nodes to a Rubrik cluster.
Syntax
cluster add_node
Example: Sample 'cluster add_node' session
cluster add_node
Node configuration
==================
Number of nodes to add [1]: 1
Node ID: 2
========================
Management Configuration
========================
Management Ip Address: 10.16.54.41
Management Subnet Mask: 255.255.255.252
Management Gateway: 129.144.50.56
Management VLAN (Optional): 2000
==================
IPMI Configuration
==================
IPMI IP Address: 192.168.1.211
IPMI Subnet Mask: 255.244.255.252
IPMI Gateway: 128.25.132.23
IPMI Password:
Confirm IPMI Password:
Passwords matched.
{'2': {'ipmiIpConfig': {'address': '192.168.1.211',
'gateway': '128.25.132.23',
'netmask': '255.244.255.252'},
'managementIpConfig': {'address': '10.16.54.41',
'gateway': '129.144.50.56',
'netmask': '255.255.255.252',
'vlan': 2000}}}
Does this configuration look OK?
Type "yes" to continue, otherwise Abort.: yes
Cluster management 08/17/2021 | 16

cluster bootstrap
Starts the command-line version of system setup for a new cluster, requests the required setup
information, and configures the system.
Syntax
cluster bootstrap
Usage
• Run bootstrap in a command line session on a node that is part of a Rubrik cluster.
• The node running bootstrap must have at least 24 GB of available memory.
Example: Sample session
Here is a sample session for the bootstrap command.
>> cluster bootstrap

Warning:
Rubrik Cluster management 01/07/2020 | 12
Unqualified virtual configuration:
RAM can not be less than 24 GB
Waiting for Rubrik API to become available
User configuration
==================
E-mail: martin.ash@rubrik.com
Password:
Re-enter Password:
Cluster configuration
=====================
Cluster name: Important_Cluster
DNS Nameservers [8.8.8.8]:
DNS Search Domains (Optional):
NTP Servers [pool.ntp.org]:
cluster cluster_name
Displays the human-readable name assigned to the Rubrik cluster.
Syntax
cluster cluster_name
Following is a sample session for the cluster_name command.
>> cluster cluster_name

emp_cluster
cluster cluster_uuid
Displays the universally unique identifier (UUID) assigned to the Rubrik cluster.
Syntax
cluster cluster_uuid
This example shows the current cluster UUID.
>> cluster cluster_uuid

106d3f60-60ca-45f2-9f33-371264ed1702
cluster discover
Discovers nodes that are available to add to the Rubrik cluster.
Syntax
cluster discover
Example: Sample sessions
Following is a sample session for the cluster discover command.
>> cluster discover

B-0634-lb -> fe80:0:0:0:ec4:7aff:fe8f:b957%bond0
B-0635-lb -> fe80:0:0:0:ec4:7aff:fe88:789d%bond0
B-0849-lb -> fe80:0:0:0:ec4:7aff:fe88:c8b5%bond0
B-0849-lt -> fe80:0:0:0:ec4:7aff:fe88:bb6d%bond0
B-0849-rb -> fe80:0:0:0:ec4:7aff:fe88:ca43%bond0
B-100217-lt -> fe80:0:0:0:ae1f:6bff:fecb:13a5%bond0
B-1490-rt -> fe80:0:0:0:ae1f:6bff:fe55:eac1%bond0
RC220M5WZP2345Z1U4 -> fe80:0:0:0:6a05:caff:feab:eb15%bond0
RC220WZP2147Z0BP -> fe80:0:0:0:92e2:baff:fefa:7125%bond0
RC220WZP2342Z0RZ -> fe80:0:0:0:5e71:dff:feb1:4f85%bond0
RDL64208YHB9N2CNWS30081F000X02 -> fe80:0:0:0:3efd:feff:fe57:a33a%bond0
RDL6420BYTLS13CNWS3009B500DA02 -> fe80:0:0:0:3efd:feff:fe76:6061%bond0
RDL740XDB0MNCV2CNFCP008CV05H5 -> fe80:0:0:0:9a03:9bff:fe81:66df%bond0
RDL740XDB0MRCV2CNFCP008CV0CWZ -> fe80:0:0:0:9a03:9bff:fe81:6877%bond0
RHPDL380PWWRH0JLMCO12Z -> fe80:0:0:0:ba83:3ff:fe86:44dd%bond0
RHPDL380PWWRH0JLMCO13A -> fe80:0:0:0:ba83:3ff:fe82:fe9%bond0
RHPDL380PXAXE0CLMCX1A6 -> fe80:0:0:0:ba83:3ff:fe84:77f1%bond0
RVM162S009908 -> fe80:0:0:0:ec4:7aff:fe8f:d227%bond0
RVM162S010284 -> fe80:0:0:0:ec4:7aff:fe8f:b8d9%bond0
RVM165S011578 -> fe80:0:0:0:ec4:7aff:fe8e:95b9%bond0

RVM165S011586 -> fe80:0:0:0:ec4:7aff:fe82:d7f5%bond0
RVM165S011992 -> fe80:0:0:0:ec4:7aff:fe8e:9a83%bond0
RVM165S011998 -> fe80:0:0:0:ec4:7aff:fe8e:9191%bond0
RVM165S018155 -> fe80:0:0:0:ec4:7aff:fe8f:d8b1%bond0
RVM183S048551 -> fe80:0:0:0:ae1f:6bff:fe8d:c6c7%bond0
RVM183S048822 -> fe80:0:0:0:ae1f:6bff:fe8d:d653%bond0
RVM183S048834 -> fe80:0:0:0:ae1f:6bff:fe8d:badb%bond0
RVM183S048836 -> fe80:0:0:0:ae1f:6bff:fe8d:bccb%bond0
RVM18BS008289 -> fe80:0:0:0:ae1f:6bff:fea5:a831%bond0
VRVW42258353E -> fe80:0:0:0:0:4fff:fe66:1877%bond0
VRVWPRO42084BD1D -> fe80:0:0:0:0:55ff:feec:f2a9%bond0
If there are no systems to add to the Rubrik cluster, cluster discover displays an empty output.
>> cluster discover

VRVW4214C6134 ->
cluster entitle_node
Configures entitlement on a node running Rubrik CDM.
Syntax
cluster entitle_node
Here is a sample session for the entitle_node command.
RDL6420BYTKS13CNWS3009AV00BX03 >> cluster entitle_node

================
Node Entitlement
================
Node requires entitlement.

RDL6420BYTKS13CNWS3009AV00BX03
Register this node before bootstrapping.
Perform node entitlement using

1. Online: Using rubrik support login email and password
or
2. Offline:
in exchange for a entitlement token
Choose '1' or '2'
Entitlement method: 1
Use Proxy Setting? [y/n]: n
Check connectivity to rubrik.force.com
Enter username for support.rubrik.com: dba.dba@bigcorop.com

Enter password for support.rubrik.com:
Enter entitlement ID:: 55jkjbkhjbhbjkhbjhb
Starting node entitlement...

Teleport registration failed. Contact Rubrik support. Continuing ...
Entitlement complete...
RDL6420BYTKS13CNWS3009AV00BX03 >>
cluster get_failed_jobs
Lists failed jobs of all types from the Rubrik cluster during a defined time period.
Syntax
cluster get_failed_jobs [-h] [--limit limit] [--hours-since hours_since] [--hosts

[hosts [hosts...]]]
This table defines the command parameters.
Parameter Description
-h Prints the help message and exits.
--limit limit Number of events to retrieve. The default is 25.
--hours-since hours_since Include only events that have occurred in the past
hours_since hours.
--hosts [hosts] Limit retrieved jobs to the given hosts
This example shows the last two failed jobs.
>> cluster get_failed_jobs --limit 2

[
{
"eventInfo": {
"id": "Replication.RemoteClusterUnreachable",
"message": "Unable to reach remote cluster dynapod-colo-2043.",
"params": {
"${locationName}": "dynapod-colo-2043"
}
},
"eventName": "Replication.RemoteClusterUnreachable",
"eventSeriesId": "a3299d0b-59c5-4216-b14f-a6b93d6dfb0a",
"eventSeverity": "Critical",
"eventStatus": "Failure",
"eventType": "Configuration",
"id": "62097ee4-57b0-46af-bd2a-2d5471d91cf5",
"jobInstanceId": "REMOTE_CLUSTER_CONNECTIVITY_CHECK_3ba713ee-
d54e-436b-8659-21e149b566da:::12465",
"objectId": "3ba713ee-d54e-436b-8659-21e149b566da",
"objectName": "dynapod-colo-2043",
"objectType": "DataLocation",
"time": "2020-08-10T17:56:15.591Z"
},
{
"eventInfo": {

"id": "Node.PeriodicNodeTaskFailed",
"message": "A periodic task has failed on node VRVW4214C6134: Routine
upgrade prechecks failed.
There is no impact to normal operation, but the node is not ready for
upgrade. Please contact support
to resolve this issue before your next upgrade. Failed upgrade precheck:
root_storage_check.",
"params": {
"${message}": "Routine upgrade prechecks failed. There is no impact
to normal operation, but
the node is not ready for upgrade. Please contact support to resolve this
issue before your next upgrade.
Failed upgrade precheck: root_storage_check.",
"${nodeId}": "VRVW4214C6134"
}
},
"eventName": "Node.PeriodicNodeTaskFailed",
"eventSeriesId": "02882663-d65c-423d-94d7-d646291c002d",
"eventSeverity": "Critical",
"eventStatus": "Failure",
"eventType": "Diagnostic",
"id": "f5c35cec-3bb4-4ae7-bc1c-5e83e6110011",
"objectId": "106d3f60-60ca-45f2-9f33-371264ed1702",
"objectType": "Cluster",
"time": "2020-08-09T20:47:28.583Z"
}
]
VRVW4214C6134 >>
cluster get_node_statuses
Retrieves the status of each node in the Rubrik cluster.
Syntax
Usage
• get_node_statuses is meant for use with hardware supported platforms.

• get_node_statuses does not work on virtual Rubrik CDM platforms.
Here is a sample session with a status of OK.
>> cluster get_node_statuses

=====================
Getting node statuses
=====================
B-0768-lb OK
B-0768-lt OK
B-0768-rb OK
B-0768-rt OK
B-0769-lb OK
B-0769-lt OK
B-0769-rb OK
B-0769-rt OK

Here is a sample session that includes a status of BAD.
>> cluster get_node_statuses

=====================
Getting node statuses
=====================
B-0768-lb BAD
B-0768-lt OK
B-0768-rb OK
B-0768-rt OK
B-0769-lb OK
B-0769-lt OK
B-0769-rb OK
B-0769-rt OK
cluster grace
Prints documentation about Rubrik APIs, including descriptions of what individual endpoints do and the
data format each endpoint requires.
Syntax
cluster grace [-H host] [-T token API method arguments]

-H host -u username -p password API method arguments
Print specific API documentation:
-h API
-h API method
-h model
-H host Name of the machine on which the command is
run.
-T token API method arguments Describes the token being researched.
-p password API method arguments Rubrik CLI login password.
-h [API] | [API method] | [model] Name of the API being researched.
-I Use an internal API.
Here is an example of using cluster grace to list information for the MssqlApi endpoint.
>> cluster grace -h MssqlApi

MssqlApi methods:
Version v1 methods:
assign_mssql_sla_properties

browse_mssql_backup_files
create_download_mssql_backup_files
create_download_mssql_backup_files_by_id
create_export_mssql_db
create_log_shipping_configuration
create_mssql_mount
create_mssql_unmount
create_on_demand_mssql_backup
create_on_demand_mssql_log_backup
create_restore_mssql_db
delete_log_shipping_configuration
delete_mssql_db_snapshots
download_from_archive
get_log_shipping_configuration
get_missed_mssql_db_snapshots
get_mssql_async_request_status
get_mssql_db
get_mssql_db_missed_recoverable_ranges
get_mssql_db_recoverable_ranges
get_mssql_db_snapshot
get_mssql_hierarchy_children
get_mssql_hierarchy_descendants
get_mssql_hierarchy_object
get_mssql_instance
get_mssql_mount
query_log_shipping_configurations
query_mssql_db
query_mssql_db_snapshot
query_mssql_instance
query_mssql_mount
reseed_secondary
update_log_shipping_configuration
update_mssql_db
update_mssql_instance
cluster health_monitor get_policies

Lists all health monitor policies running on the Rubrik cluster.
Syntax
cluster health_monitor get_policies
The following is a truncated sample session for the cluster health_monitor get_policies
command.
B-1470-rt >> cluster health_monitor get_policies

health_monitor_policies {
policy_id: "InfluxDBDiskUsage"
policy_name: "InfluxDBDiskUsage Check"
policy_type: CHECKER
description: "Check if InfluxDB disk usage is within threshold"
script: "timeout 20 /var/lib/rubrik/node-monitor/scripts/
check_influxdb_disk.py || exit 2\n"
scope: NODE

run_in_state: OK
run_in_state: BAD
enabled: true
schedule_freq_in_sec: 20
notification_config {
name: "InfluxDBDiskUsage Check Failure"
notification_type: DIAGNOSTIC
notification_message: "InfluxDBDiskUsage check failed"
critical_details {
num_failures: 15
failure_window: 600
enabled: true
action {
action_script: "service influxdb restart"
enabled: true
}
}
}
}
policy_id: "ClusterConfigBad"
policy_name: "ClusterConfigBad Check"
policy_type: CHECKER
description: "Check if we can talk to Cluster Config service"
script: "/var/lib/rubrik/node-monitor/scripts/check_cluster_config.sh"
scope: NODE
run_in_state: BAD
enabled: true
schedule_freq_in_sec: 20
}
policy_id: "InfluxGraph"
policy_name: "InfluxGraph Check"
...
<output truncated>
cluster health_monitor get_status

Retrieves the status of health monitor policies for Rubrik cluster nodes.
Syntax
cluster health_monitor get_status [NODE_ID] [NODE_ID ...]][--all]

This table defines the command parameter.
[NODE_ID] [NODE_ID ...]] Space-separated list of node IDs.
--all List all policy statuses, including passing policies

The following is a sample session for the cluster health_monitor get_status command with all
policies passing.
B-1470-rt >> cluster health_monitor get_status

### Node ID : B-1470-lb ###
All health monitor policies passed in the last 24 minutes

### Node ID : B-1470-lt ###

### Node ID : B-1470-rb ###

### Node ID : B-1470-rt ###
The following is a sample session for the cluster health_monitor get_status command with a
failing policy.
B-1470-rt >> cluster health_monitor get_status

### Node ID : B-1470-lb ###

### Node ID : B-1470-lt ###

### Node ID : B-1470-rb ###

### Node ID : B-1470-rt ###
===== FAILED PERIODIC CHECKS =====

Heka failed 2 of last 24 attempts.
The following is a sample session for the cluster health_monitor get_status command listing all
policies on a specific node.
B-1470-rt >> cluster health_monitor get_status B-1470-rt --all

### Node ID : B-1470-rt ###
===== DID NOT RUN PERIODIC CHECKS ====

ClusterConfigBad not run in the last 24 minutes
AgentServerBootstrap not run in the last 24 minutes
StalenessBad not run in the last 24 minutes
RootDiskWritableBootstrap not run in the last 24 minutes
SnapshotServerPingBootstrap not run in the last 24 minutes
SprayServerBad not run in the last 24 minutes
BackupAgentBootstrap not run in the last 24 minutes
SdfsMaintenance not run in the last 24 minutes
ReplicationBad not run in the last 24 minutes
CQLProxyBootstrap not run in the last 24 minutes
NodeLivenessPublisherWatchdogBootstrap not run in the last 24 minutes
ReplicationBootstrap not run in the last 24 minutes
KeyWrapperBootstrap not run in the last 24 minutes
SdfsBootstrap not run in the last 24 minutes
JflBootstrap not run in the last 24 minutes
CockroachBootstrap not run in the last 24 minutes
RootDiskWritableBad not run in the last 24 minutes
RemoteClusterBootstrap not run in the last 24 minutes

===== SUCCESSFUL PERIODIC CHECKS ====
InfluxDBDiskUsage passed last 24 attempts.
InfluxGraph passed last 24 attempts.
MetadataStore passed last 24 attempts.
Jfl passed last 24 attempts.
CloudStorageService passed last 24 attempts.
DiamondMemory passed last 24 attempts.
BackupAgent passed last 24 attempts.
SnapshotServerPing passed last 24 attempts.
MatrixDecrement passed last 24 attempts.
AgentServer passed last 24 attempts.
HekaForTrial passed last 24 attempts.
Sdfs passed last 24 attempts.
JflStatus passed last 24 attempts.
SprayServer passed last 24 attempts.
NtpClockOffsetSyspeer passed last 24 attempts.
Replication passed last 24 attempts.
InfluxDBArchive passed last 24 attempts.
ClusterConfig passed last 24 attempts.
NfsKernelServer passed last 24 attempts.
NtpClockOffsetPeers passed last 24 attempts.
InfluxDB passed last 24 attempts.
RemoteCluster passed last 24 attempts.
RootDiskWritable passed last 24 attempts.
Diamond passed last 24 attempts.
Telegraf passed last 24 attempts.

Heka failed 2 of last 24 attempts.
Usage
By default cluster health_monitor get_status prints only failing policies on all nodes.
Include the --all parameter to print all policy results, including passing and skipped policies.
Include the NODE_ID parameters to retrieve health monitor policy statuses for specific nodes.
cluster health_monitor run_policies

Runs the included list of policy checks on this Rubrik cluster node. Returns the results with error messages,
if any.
Syntax
cluster health_monitor run_policies policy1[,] policy2[,] policy3

policy1[,] policy2[,] policy3 List of comma or space separated policy IDs to run.

The following is a sample session for the cluster health_monitor run_policies command.
B-1470-rt >> cluster health_monitor run_policies Jfl,Heka

Running policies ['Jfl', 'Heka']
Node ID: B-1470-lb

Policy ID: Jfl
Result: True
Policy ID: Heka

Result: True
Node ID: B-1470-lt

Policy ID: Jfl
Result: True
Policy ID: Heka

Result: True
Node ID: B-1470-rb

Policy ID: Jfl
Result: True
Policy ID: Heka

Result: True
Node ID: B-1470-rt

Policy ID: Jfl
Result: True
Policy ID: Heka

Result: True
cluster hw_health
Displays the health of the hardware.
Syntax
cluster hw_health
Usage
cluster hw_health reports the following information:

• Health report for all drives
• Memory and PCI bus errors
• Status of networking ports
• Status for Machine Check Exception (MCE) logs
• Field Replaceable Unit (FRU) status

The following is a sample session for the cluster hw_health command.
B-0768-lb >> cluster hw_health

Gathering system info...
-------------------------------------------------------------------------
Hostname : B-0768-lb
Node Model : r300
Node Type : r348
CPU Type : Intel(R) Xeon(R) CPU E5-2630 v3 @ 2.40GHz
Num Cores : 16
Main Memory : 64542940 KB
Kernel Release : 4.15.0-72-rubrik4-generic
Kernel Version : #81 SMP Mon Aug 17 20:42:14 UTC 2020
BIOS Version : 2.0b
BMC Version : 1.25
CDM Version : 5.3.0-DA1-18047
hw_health.sh ver.: 1.51
-------------------------------------------------------------------------
Checking SEL and sensors...
Reading sensor info...
Reading sdr info...
Warning SEL Detected:
5 | 10/22/2018 | 17:40:53 | Power Supply #0xc9 | Failure detected () |
Asserted
PS2 Status currently shows: Presence detected
Warning SEL Detected:

6 | 10/22/2018 | 17:46:05 | Power Supply #0xc8 | Failure detected () |
Asserted
PS1 Status currently shows: Presence detected
Copying SEL events to /var/log/syslog

-------------------------------------------------------------------------
Checking health of all disk drives...
4 disks installed:
Disk Device | Type | Manufacturer | Model Number | Serial Number |
Capacity
/dev/sda | SATA | INTEL | SSDSC2BA40 | BTTV543005HL400HGN |
400GB
/dev/sdb | SATA | HGST | HUH728080AL | 2EJ04RAX |
8.00TB
/dev/sdc | SATA | HGST | HUH728080AL | 2EHZ953X |
8.00TB
/dev/sdd | SATA | HGST | HUH728080AL | 2EHZVNNX |
8.00TB
Checking sda for errors.

Checking sdb for errors.
Checking sdc for errors.
Checking sdd for errors.
-------------------------------------------------------------------------
Checking mcelog --client for memory errors...
DIMM NAME | Total CME | CME last 24hrs | Total UME | UME last 24hrs |
P1-DIMMA1 | 0 | 0 | 0 | 0 |
P1-DIMMB1 | 0 | 0 | 0 | 0 |
P1-DIMMC1 | 0 | 0 | 0 | 0 |
P1-DIMMD1 | 0 | 0 | 0 | 0 |
-------------------------------------------------------------------------
Checking /var/crash/ for hardware errors logged in crash dump files...
No crash dump files on node.

-------------------------------------------------------------------------

Checking for PCIe errors...
No PCIe errors found.
-------------------------------------------------------------------------
Checking networking ports...
Port | Device | Driver | State | Link |
Speed
bond0 | | | up | yes |
10000Mb/s
bond0.656 | | | up | yes |
10000Mb/s
bond1 | | | up | yes |
1000Mb/s
eth0 | Intel I350 Gigabit | igb | up | yes |
1000Mb/s
eth1 | Intel I350 Gigabit | igb | down | no |
Unknown!
eth2 | Intel 82599ES 10-Gigabit SFI/SFP+ | ixgbe | up | yes |
10000Mb/s
eth3 | Intel 82599ES 10-Gigabit SFI/SFP+ | ixgbe | down | no |
Unknown!
Bond0 Mode is fault-tolerance (active-backup)

Bond0 bond ports are: eth3 eth2
Current active port is eth2
WARNING: Bond0 has a port that is not up and is not ready for failover
operation.
Bond1 Mode is fault-tolerance (active-backup)

Bond1 bond ports are: eth1 eth0
Current active port is eth0
WARNING: Bond1 has a port that is not up and is not ready for failover
operation.
-------------------------------------------------------------------------
Checking for MCEs...
Data in /var/log/mcelog exists:
/var/log/mcelog is clean
-------------------------------------------------------------------------
FRU Replacement Summary:
All FRUS in the node are healthy.
5.3 stress
B-0768-lb >>
The Rubrik cluster reports an error when the cluster hw_health command is run on a virtual machine.
>> cluster hw_health

Invalid Rubrik model.
cluster node_hostname_change
Changes the hostname of a Rubrik cluster node.
Syntax
cluster node_hostname_change [new_name]


new_name New node name.
Usage
cluster node_hostname_change changes only the name of the node from which the command is
issued.
The new hostname provided must be RFC1123 compliant. The length must be less than or equal to 64
characters. Valid characters are: numbers, upper and lower case letters, dash, and dot. The hostname
cannot start with a dash or a dot.
cluster install
Performs a cluster install.
Syntax
cluster install [-h] {start | status}

start Start a Rubrik CDM software installation.
status Check the status of an upgrade.
cluster job_instances
Displays job instances for a specified job type or job status.
Syntax
cluster job_instances [job_type [job_status]]

job_type Type of job for which instances are
being reported. See #unique_31/
unique_31_Connect_42_table_jobsbelow for a list.
Values for job_type must be entered in all capital
letters.
job_status Status of the job. One of:
• QUEUED
• ACQUIRING
• RUNNING

• UNDOING
• CANCELING
• FAILED
• CANCELED
• FINISHING
• SUCCEEDED
Usage
• When job_type is not specified, cluster job_instances displays a list of possible job types.
• The table contains the following information:
• Job ID
• Instance ID
• Node ID
• Job status
• Job start time stamp
• Job end time stamp
• This table lists the available jobs for job_type.
Job types
This table lists the job types available.
ABANDONED_DIFF_GROUP FREQUENT_STATS_UPDATER NOTIFY_EXPIRING

_PURGE _CERTIFICATES
ABANDONED_SHARDED_GROUP GC PARALLELIZED_STATS_UPDATER
_PURGE
ANALYZE_SNAPPABLE GC_DC_BLOB_GROUP PARALLELIZED_STATS_UPDATER

@PARALLELIZABLE_PERIODIC
_UPDATE_RUNNER
ARCHIVAL_LOCATIONS GC_EVENTS PENDING_OPERATIONS

_CONNECTIVITY_CHECK _MAINTENANCE
ARCHIVAL_MAINTENANCE GC_EVENT_ARTIFACTS PERIODIC_CLOUD_COMPUTE

_CONNECTIVITY_CHECK
AUDIT_JOB_INSTANCES GC_EXPIRED_TTL PER_NODE_JOB_MAINTAINER

BACK_UP_COCKROACH GC_INACTIVE_CDP_HANDLES PROMOTE_MANAGED_VOLUME
_EXPORT_HANDLE
BLOBSTORE_CLEAN_UP GC_PUBLIC_CLOUD_IMAGE PRUNE_CDP_HISTORY
_AND_INSTANCE

CDP_REPLICATION GC_STREAM_LOGS PRUNE_JOB_INSTANCES
_ORCHESTRATOR_GC
CLEANUP_ARCHIVED_OBJECTS GENERATE_CONNECTORS PRUNE_SNAPSHOT_AUDIT
CLEANUP_HEALTH GENERATE_CUSTOM_REPORT REFRESH_ENVOY_STATUS
_CHECK_STATUS
CLEANUP_JOB_ACTION GENERATE_EVENT_SQLITE_FILE REFRESH_HOST_METADATA
_TIME_SERIES
CLEANUP_OLD_SD GENERATE_REPORT REFRESH_METADATA
_SCRATCH_BLOBSTORE _DATA_SOURCE
CLEANUP_REPORTS GENERATE_REPORT_DATA REFRESH_MOUNT_SHARES
_SOURCE_FREQUENT
CLEANUP_REPORT HOST_LOG_CLEANUP REFRESH_SIM_HASH_CACHE

_JOB_INSTANCES _DC_BLOB_STORE
CLEANUP_REPORT_STATS INDEX_SNAPPABLE_SNAPSHOTS REMOTE_CLUSTER

_CONNECTIVITY_CHECK
CLEANUP_REPORT_TMP_FILES INFREQUENT_STATS_UPDATER REVERSE_DC_BLOB_GROUP

CLEANUP_SAML_RELAY_STATE INPLACE_EXPORT_VMWARE SCHEDULE_DEFERRED_ODS
_SNAPSHOT
CLEAN_UP_REFERENCES JOB_MAINTAINER SNMP_MIB_UPDATE
CLOUD_NATIVE JOB_MONITORING_COUNT STORM_MAINTENANCE
_SNAPSHOT_INTEGRITY _CACHE
CLUSTERWIDE_STATS_UPDATER JOB_MONITORING_COUNT UNSET_SB_GROUP_GIGANTIC

_CACHE@JOB_MONITORING _SHARD_SIZE
_COUNT_CACHE
COCKROACH_COMPACT JOB_MONITORING UPDATE_REPORT_STATS
_MAINTENANCE
CONSOLIDATE_DC_BLOB_GROUP JOB_MONITORING UPLOAD_CLOUD_ON_METADATA

_MAINTENANCE@JOB _AFTER_UPGRADE
_MONITORING_PERIODIC
_MAINTENANCE
CREATE_VMWARE_MULTI LITE_REFRESH_METADATA UPLOAD_METRICS_METADATA
_NODE_SNAPSHOT

CREATE_VMWARE_SNAPSHOT LOG_UPLOADER UPLOAD_REPORT_BUNDLE
CROSS_DC_BLOB_GROUP MANAGED_VOLUME_CLEANUP VCD_REFRESH
EMAIL_SEND MANAGED_VOLUME_REPORT VERIFY_EFFECTIVE_SLA
_DOMAIN_NAME
ENCRYPT_VENDOR MONITORING_COUNT VERIFY_ENCRYPTION_KEYS
_CREDENTIALS _REFRESHER
ESX_ADDR_RESOLV_JOB MONITORING_INFO_REFRESHER VERIFY_IS_GHOST

EXPIRE_SNAPPABLE_SNAPSHOT MOVE_FINGER_PRINTS VERIFY_SLA
_AFTER_UPGRADE
FILESET_DEDUP_CALCULATOR NETWORK_THROTTLE VMWARE_CDP_STORAGE

_POLICY_UNASSIGN
This session displays the status of queued GC_EVENTS jobs.
>> cluster job_instances GC_EVENTS

Filter job instances for job_type GC_EVENTS by status as well? (y/n) [n]: y
1: QUEUED
2: ACQUIRING
3: RUNNING
4: UNDOING
5: CANCELING
6: FAILED
7: CANCELED
8: FINISHING
9: SUCCEEDED
Select job_status [1..9]: 1

JOB_ID INSTANCE_ID NODE_ID STATUS START
END
----------------------- ------------- --------- --------
------------------- -----
GC_EVENTS_VRVW4214C6134 111 None QUEUED 2020-07-30
23:56:21
cluster job_logs
Uses the system grep command to search the logs of a particular service.
Syntax
cluster job_logs [JOB_ID] [INSTANCE_ID] [service_name]


JOB_ID ID of the job.
INSTANCE_ID ID of the instance on which the job is running.
service_name Name of the service.
Usage
Use the job_instances command to display the instance ID of a given job. The service_name is the
name listed in the output of the log_view command. Use the get_failed_jobs command to display
failed jobs from a given time period.
This example uses the job_instances command to determine the instance_id for a job, then uses that
instance_id as input for the job_logs command.
>> cluster job_instances GC_EVENTS

Filter job instances for job_type GC_EVENTS by status as well? (y/n) [n]: y
1: QUEUED
2: ACQUIRING
3: RUNNING
4: UNDOING
5: CANCELING
6: FAILED
7: CANCELED
8: FINISHING
9: SUCCEEDED
Select job_status [1..9]: 1

JOB_ID INSTANCE_ID NODE_ID STATUS START
END
----------------------- ------------- --------- --------
------------------- -----
GC_EVENTS_VRVW4214C6134 111 None QUEUED 2020-07-30
23:56:21
VRVW4214C6134 >> cluster job_logs GC_GLOBAL 111
1: lambda-content-analyzer
2: spark-agent-log
3: agent-server
4: lambda-parser-service
5: spark-agent
6: cluster-config
7: spray-server-log
8: sdfs
9: key-wrapper-log
10: cdp-log-receiver
11: hierarchy-cache
12: cloud-storage-service
13: backup-agent
14: node-monitor-log
15: smbservicemanager
16: py-vmware-server
17: snapshot
18: cluster-config-log
19: lambda
20: replication
21: diamond

22: key-wrapper
23: node-monitor
24: job-fetcher
25: remote-cluster
26: cdp-metadata-service
27: kvsnapshot
28: search
29: spray-server
30: vddk-server
31: buffered-disk
32: cockroachdb
33: cqlproxy
34: upgrade-service
Type "exit" to exit job_logs.

Select service [1..34]: 31
Unexpected number of rows for given job_id GC_GLOBAL and instance_id 111
Usage: job_logs [JOB_ID] [INSTANCE_ID]
cluster ledctl
Activates or resets the status LED for a hard disk drive for replacement of a disk on the chassis of the local
node. This command does not support solid-state drives or r528 Rubrik appliances.
Syntax
ledctl [locate | normal]=path_to_led

locate Locates the LED on the machine.
normal Resets the LED to normal.
This example resets the LED for device /dev/sdb to normal.
ledctl normal=/dev/sdb
cluster manual_discover
Discover nodes to start or add to a cluster.
Syntax
cluster manual_discover {ipv4 | ipv6}

ipv4 Start or add a node over an IPv4 connection.
ipv6 Start or add a node over an IPv6 connection.
Example:
Here is a example of a session for a sample session for IPv4.
>> cluster manual_discover ipv4

For IPv4, make sure manually discovered IPs have been configured on the
nodes. That is, setup network
should have been run on the nodes
Number of nodes to be discovered manually over ipv4: 1
Host name for node #1: B-1229-rt
ipv4 address for node #1: 10.0.115.145
discovered_nodes is [{'hostname': 'B-1229-rt', 'ipv4': '10.0.115.145'}]
cluster mfg_status
Displays manufacturing status of a physical node.
Syntax
cluster mfg_status
Example: Successful manufacture status
cluster mfg_status displays the date and time the node was successfully manufactured.
>> cluster mfg_status

==========================
Getting initial mfg status
==========================
Manufacture successfully completed
on : 09/18/2020, 21:40:04
Example: Unsuccessful manufacture status
cluster mfg_status displays this message when the manufacture was unsuccessful, the command
was run on a virtual machine, or the node has been upgraded.
>> cluster mfg_status

==========================
Getting initial mfg status
==========================
Manufacturing not complete successfully

Usage
cluster mfg_status reports on the status of the node on which it was run, not the cluster.
cluster mfg_status does not produce meaningful information post upgrade.
cluster monitor
Displays cluster status
Syntax
cluster monitor [-h] {list | status | run}

list limit Display all monitor checks with descriptions.
status Display all monitor checks and their status.
run Run a monitor check and report status.
Example: Display a list of status checks
Type this command to display a list of the cluster status checks. This display is shortened for display
purposes.
B-0768-lb >> cluster monitor list

InfluxGraph:
Verify InfluxGraph port and whether graphite-api can be queried
MetadataStore:
Check if we can run some queries off Metadatastore
Jfl:
Verify JFL service status shows active
CloudStorageService:
Verify that Cloud Storageservice status is okay
. . .
Diamond:
Verify that diamond service status is okay
Telegraf:
Verify that we can talk to the Telegraf port
Example: Display the cluster status
Type this command to display the periodic checks that did not run, that ran successfully, and that failed.
This display is shortened for display purposes.
B-0768-lb >> cluster monitor status

===== DID NOT RUN PERIODIC CHECKS ====
StalenessBad not run in the last 24 minutes

SdfsMaintenance not run in the last 24 minutes
SdfsBad not run in the last 24 minutes
RemoteClusterBad not run in the last 24 minutes
RootDiskWritableBad not run in the last 24 minutes
. . .
DiamondMemory passed last 24 attempts.
CloudStorageService passed last 24 attempts.
MatrixDecrement passed last 24 attempts.
SprayServer passed last 24 attempts.
Example: Run a specific check
This example runs a status check on the Jfl process.
B-0768-lb >> cluster monitor run Jfl

Status: True
Output:
Jfl check command: timeout 5 /opt/rubrik/src/scripts/node-monitor/
check_jfl_livetime.py || exit 2
stdout:
stderr:
Jfl check PASSED
cluster mount
Adds a USB device at the specified path. Used when upgrading Rubrik firmware or exporting support
bundles.
Syntax
cluster mount [-h] [--usb_device [device_path]]

--usb_device [device_path] Specifies the path to the USB device.
Example: Sample session for adding a device
Here is an example of using cluster mount to add a device to mybrik-node1.
mybrik-node1 >> mount --usb_device

Do you want to mount usb device /dev/sdd1 [y/N] [N]: y
Device '/dev/sdd1' is mounted to --usb

cluster node_table
Displays the contents of the node table for each node in the Rubrik cluster.
Syntax
cluster node_table [-h]
Usage
node_table lists the following information for the Rubrik cluster:

• Cluster UUID
• NTP server names
• DNS server IPv4 addresses
node_table lists the following information for each node in the Rubrik cluster:
• Node ID
• Node status
• Time of last node update
• Management IPv4 address
• Data IPv4 address
• IPMI IPv4 address Al
node_table also provides historical data for nodes that were previously in the cluster, but have been
removed.

Following is a sample session for the node_table command:
>> cluster node_table

[Cluster settings]
cluster uuid: 286e4597-7874-4141-84e5-b3d0fab9a4dd
cluster id: cluster
NTP servers: pool.ntp.org
DNS servers: 10.0.1.23, 10.0.1.21
[Nodes]
node id: B-1503-lb
status: OK
last updated time: 2020-04-09 23:32:11.054000
management IP address: 10.0.86.152
data IP address: 10.0.86.152
IPMI address: 10.1.81.133
node id: B-1503-lt

status: OK
node id: B-1503-rb

status: OK

node id: B-1503-rt

status: OK
cluster poweroff_cluster
Performs a node status check followed by a graceful shutdown of all nodes in the Rubrik cluster.
Syntax
cluster poweroff_cluster [--skip_node_status_check]

--skip_node_status Shuts down the Rubrik cluster without performing a
node status check.
Usage
By default, poweroff_cluster performs a node status check and shuts down the node that hosts the
current session last. This command shuts down the Rubrik cluster only if all nodes are in healthy state.
Note: Nodes that have been down for more than 24 hours and skip the node status check before being
shut down require assistance from Rubrik Support to re-join a Rubrik cluster.
This example shuts down the cluster.
>> cluster poweroff_cluster

Warning: This operation will power off the entire cluster, any running jobs
will be terminated!!!
Type 'yes' to continue: :yes
cluster poweroff_node
Performs a node status check followed by a graceful shutdown of the node that hosts the current session.
Syntax
cluster poweroff_node

This example shuts down the node.
>> cluster poweroff_node

Warning: This operation will power off the node, any running jobs will be
terminated!!!
Type 'yes' to continue: : yes
cluster provide_encryption_password
Checks whether a password is necessary to unlock hard disks on a Rubrik Edge.
Syntax
cluster provide_encryption_password
The following example uses cluster provide_encryption_password to determine that a password

is not set and then to provide a password.
>> cluster provide_encryption_password

Checking if the cluster is an encrypted cluster or not.
Checking if password is needed to unlock disks.
Password is needed to unlock disks
Encryption Password:
Successfully provided encryption password.
This is an example of a node reboot during key rotation, and the disks are encrypted by two passwords.
>> cluster provide_encryption_password

Checking if the cluster is an encrypted cluster or not.
Checking if password is needed to unlock disks.
Password is needed to unlock disks
Encryption Password:
Node is likely in the middle of key rotation. If password has been changed,
provide the latest old password.
Old encryption Password (press ENTER to skip):
Successfully provided encryption password.
cluster reboot
Gracefully shuts down and restarts either the Rubrik cluster or the node that hosts the current session.
Syntax
cluster reboot [cluster | node]

cluster Shuts down and restarts the Rubrik cluster.
node Shuts down and restarts the node that hosts the
current session.
The following example uses cluster reboot cluster to restart a Rubrik cluster.
>> cluster reboot cluster

Are you sure you wish to reboot this cluster?
Type "yes" to continue, otherwise Cluster reboot aborted.:
This example shuts down and restarts the node.
cluster reboot node

Are you sure you wish to reboot this node?
Type "yes" to continue, otherwise Node reboot aborted.:
cluster reset_node_status
Displays the status of a node reset operation.
Syntax
cluster reset_node_status
This example resets the node.
>> cluster reset_node_status

=========================
Getting reset_node status
=========================
Reset node successfully completed
Usage
If the node is bootstrapped and part of cluster, it prints "Reset node exited or has not run yet".
If the node reset operation has successfully completed, it prints "Reset node successfully completed".
If the node reset operation has failed or still in progress, it prints "Reset node in progress".

cluster revert_hotpatch
Reverts the latest hotpatch applied to the cluster. All services are restarted after the hotpatch is applied.
Syntax
cluster revert_hotpatch
Example: Successful hotpatch revision
>> cluster revert_hotpatch

air001 | CHANGED | rc=0 >>
###################################
# Reverting started! #
###################################
Changing node status to UPGRADE
Stopping services
2020-01-07T20:29:22+0000 INFO <23358.main> [startall_local.sh] Bringing down
and disabling all non-bootstrap services
2020-01-07T20:29:22+0000 INFO <23358.main> [startall_local.sh] Stopping job-
fetcher service
2020-01-07T20:29:23+0000 INFO <23358.main> [startall_local.sh] Stopping
replication service
cloud-storage-service service
lambda service
lambda-content-analyzer service
. . .
Executing /lib/systemd/systemd-sysv-install enable telegraf
insserv: warning: current start runlevel(s) (empty) of script `telegraf'
overrides LSB defaults (2 3 4 5).
insserv: warning: current stop runlevel(s) (0 1 2 3 4 5 6) of script
`telegraf' overrides LSB defaults (0 1 6).
insserv: script cassandra_init_trunk: service cassandra already provided!
insserv: script cassandra_init_trunk: service cassandra already provided!
Created symlink from /etc/systemd/system/multi-user.target.wants/
influxgraph.service to /lib/systemd/system/influxgraph.service.
cluster rubrik_tool
Performs calls to the Rubrik API from the command line.
Syntax
cluster rubrik_tool.py [-h] [-H HOST] [-X REQUEST_METHOD] [-d DATA]

[-P parameters] [-t] [-V API_VERSION] [-p PASSWORD] [-u USERNAME ] [-T
AUTH_TOKEN] target [target_args [target_args ...]]] [-t] [-V API_VERSION] [-p
PASSWORD] [-u USERNAME ] [-T AUTH_TOKEN] target [target_args [target_args ...]]

[-h | --help] Display the command syntax.
[-H HOST | --host HOST] Specifies the REST API host. Can be passed
multiple times to use multiple hosts.
[-X REQUEST_METHOD | --request HTTP request method.
REQUEST_METHOD]
[-d DATA | --data DATA] HTTP request body.
[-P parameters | --params parameters] HTTP request parameters.
[-t, --target-help] Displays help for the target.
[-V API_VERSION | --api_version API_VERSION] Version of the target endpoint.
[-p PASSWORD | --password PASSWORD] Password for the REST API.
[-u USERNAME | --username USERNAME] Username for the REST API.
[-T AUTH_TOKEN | --auth_token AUTH_TOKEN] Authorization token for the REST API.
target Name of the target node.
target_args Arguments to pass to the target node.
Usage
Run this command only at the request of Rubrik Support.
cluster service_status
Displays the status of Rubrik cluster services such as uptime and process IDs for the node. The status of
services is either up or down.
Syntax
cluster service_status
Usage
service_status displays the process IDs in parenthesis after the service.
Example:
Following is a sample session for the service_status command.
>> cluster service_status

CDM service uptimes:
Cassandra: down
CockroachDB(6451): 2433101 seconds
CqlProxy(14163): 2432291 seconds
InfluxDB(5932): 2432412 seconds
Telegraf(5337): 2432421 seconds
InfluxGraph(5662): 2432417 seconds
Chisel(19801): 2432194 seconds

UpgradeService(20057): 2432192 seconds
agent-server(6650): 2432404 seconds
backup-agent(6447): 2432406 seconds
buffered-disk(6391): 2432407 seconds
cdp-log-receiver(7139): 2432400 seconds
cdp-metadata-service(7216): 2432400 seconds
cloud-storage-service(6758): 2432403 seconds
cluster-config(30232): 2432512 seconds
diamond(5488): 2432420 seconds
hierarchy-cache(7048): 2432401 seconds
job-fetcher(7415): 2432398 seconds
key-wrapper(4825): 2432424 seconds
kvsnapshot(6554): 2432405 seconds
lambda(6805): 2432403 seconds
lambda-content-analyzer(6876): 2432402 seconds
lambda-parser-service(6915): 2432402 seconds
node-monitor(31178): 2432502 seconds
py-vmware-server(7306): 2432399 seconds
remote-cluster(6985): 2432401 seconds
replication(6698): 2432404 seconds
sdfs(5413): 2432420 seconds
search(6612): 2432405 seconds
smbservicemanager(7082): 2432400 seconds
snapshot(6511): 2432406 seconds
spark-agent(17816): 2432217 seconds
spray-server(32238): 2432492 seconds
vddk-server(7359): 2432399 seconds
Log service uptimes:

Logger(28774): 2433342 seconds
Go-audit(28764): 2433343 seconds
Rsyslogd(15353): 2432263 seconds
cluster-config-log(30618): 2432508 seconds
key-wrapper-log(5045): 2432423 seconds
node-monitor-log(4767): 2432424 seconds
spark-agent-log(18130): 2432215 seconds
spray-server-log(419): 2432485 seconds
cluster setupnetwork
Configures management, data, and IPMI networks on single or multiple nodes.
Syntax
cluster setupnetwork
Usage
cluster setupnetwork only works on nodes that are not yet bootstrapped.
When run on a bootstrapped node, cluster setupnetwork fails with this message, "Unauthorized".

Here is a sample session for the cluster setupnetwork command.
>> cluster setupnetwork

Waiting for Rubrik API to become available
User configuration
==================
Cluster network configuration

=============================
DNS Nameservers [8.8.8.8]:
DNS Search Domains (Optional - press [Enter] to continue):
Management Gateway: 10.0.0.255

Management Subnet Mask: 255.255.0.0
Management VLAN (Optional - press [Enter] to continue):
IPMI Gateway: 10.1.72.1IPMI Subnet Mask: 255.255.255.0
Data Subnet Mask (Optional - press [Enter] to continue):

==================
Node configuration
==================
Type a node index or name to configure. Type 0 to find more nodes or hit
Enter to begin
network setup
Select node: (Optional - press [Enter] to continue) []:
SetupNetwork Parameters
====================
{"name": " ",
"dnsNameservers": [
"8.8.8.8"
],
"dnsSearchDomains": [],
"ntpServerConfigs": [
{
"server": "pool.ntp.org"
}
],
"nodeConfigs": {
"RDL740XDB0MNCV2CNFCP008CV05H5": {
"managementIpConfig": {
"address": "10.0.86.76",
"netmask": "255.255.0.0",
"gateway": "10.0.0.255"
},
"ipmiIpConfig": {
"address": "10.1.72.102",
"netmask": "255.255.255.0",
"gateway": "10.1.72.1"
}
}
}
}
Proceed? (y/n) (Optional - press [Enter] to continue) [y]:
SetupNetwork Progress
=====================
Starting setup network . . . .
Setting up IP Services . . . . . . . . .
System setup completed

cluster tpm_upgrade
Checks the status or performs an upgrade for the firmware for the Trusted Platform Module on the Rubrik
cluster.
Syntax
cluster tpm_upgrade [start | status]

start Upgrades the TPM firmware.
status Checks the status of the TPM firmware and displays
a message saying whether the TPM firmware
requires upgrading.
Example:
This example checks if the TPM firmware requires upgrading.
>> cluster tpm_upgrade status

A TPM firmware upgrade is only required for clusters with encryption enabled
where atleast one node
has a TPM chip running a known vulnerable firmware version. This was not
determined to be the case,
hence a TPM firmware upgrade is not required at this moment.
cluster umount
Removes a device at the specified path. Used when unmounting a USB storage device after uploading
Rubrik software upgrades or after exporting support bundles.
Syntax
cluster umount [-h] [--usb_device [device_name]]

--usb_device [ device_name] Specifies the USB device to unmount.
Example:

The following example uses cluster umount to remove the sdd1 device.
mybrik-node1 >> umount --usb_device

Device '/dev/sdd1' has been umounted from --usb
cluster upgrade download_and_precheck

Downloads the Rubrik CDM image from the specified location, stages the image to the secondary partition,
and performs upgrade prechecks on the Rubrik cluster.
Syntax
cluster upgrade download_and_precheck [from_rubrik_release_repository | from_url |

from_local | watch | cancel]
-h | --help Prints the help message and exits.
from_rubrik_release_repository Prompts for Rubrik Support Portal credentials, and
then lists the compatible Rubrik CDM images for the
upgrade.
from_url URL containing the .zip format install image.
from_local Lists the images available for installation from the
images present on the Rubrik cluster node.
watch Provides status information about the upgrade.
cancel Cancels the upgrade operation.
This example retrieves the image from the local node, shares it with other nodes of the Rubrik cluster,
stages it to the secondary partition on all nodes in the cluster, and runs upgrade prechecks for Rubrik CDM
version 6.0-dev-13025.
ubuntu@vm-machine:~$ cluster upgrade download_and_precheck

Found the following CDM releases that are node local and need to be shared
to the cluster
for API initiated upgrades to work from other nodes:
1: 6.0-dev-13025
Type "exit" to exit download_and_precheck.

Select version to be shared [1..1]: 1
Sharing node local version 6.0-dev-13025 to the rest of the cluster.

This may take a few minutes.
Successfully shared version 6.0-dev-13025 to the rest of the cluster. API

initiated upgrades
against this version can now target any node in the cluster.
Proceed to run staging and pre-check on CDM version.

Created a job to download and run pre-check on CDM software. Job Id:
STAGE_CDM_SOFTWARE_GLOBAL_a980686f-b4be-4db8-a466-a9e7d3dbd313:::0
Following progress of the currently running download and pre-check job. This
method waits
until the job completes. You can return to this view at any time using
"cluster upgrade
download_and_precheck watch". To do a quick check on the current progress
instead, use
"cluster upgrade list_available_versions downloading".
Waiting for download and pre-check job STAGE_CDM_SOFTWARE_GLOBAL_a980686f-

b4be-4db8-a466-a9e7d3dbd313:::0 to complete.
|
##################--------------------------------------------------------------|
22.85%
Usage
cluster upgrade download_and_precheck provides the first step of the upgrade process, using the
prestaging mechanism to download and stage the image. The upgrade prechecks are run while the cluster
is operational.
After successfully running cluster upgrade download_and_precheck, run cluster upgrade
start --mode=normal. This command shuts down the cluster services and then performs the
remaining steps of the upgrade, which install the new Rubrik CDM release software on the Rubrik cluster.
cluster upgrade list_available_versions

Lists versions of Rubrik CDM that are available for upgrade.
Syntax
list_versions [-h] [local | rubrik_release_repository | downloading

local List the versions of Rubrik CDM available for
upgrade on the local node.
rubrik_release_repository List the versions of Rubrik CDM available for
upgrade in the Rubrik CDM release directory.
downloading List the versions of Rubrik CDM that are currently
downloading.
This example lists the versions of Rubrik CDM that are available for upgrade on the local node.
ubuntu@vm-machine:~$ cluster upgrade list_available_versions

Not looking up CDM software releases available in the Rubrik remote central
repository as
this cluster does not have an existing set of Rubrik Support Portal
credentials. Please

provide these credentials if you wish to use these releases for upgrade. You
can provide
credentials using "cluster upgrade list_available_versions
rubrik_release_repository".
Available versions (sources: ['Local', 'Downloading'])
[
{
"version": "6.0-dev-13025",
"availability": "Local"
}
]
cluster upgrade resume

Resume a Rubrik CDM software upgrade operation that was stopped due to an error.
Syntax
cluster upgrade resume
This example resumes a stopped upgrade.
ubuntu@vm-machine-a75r3k-5pikoys:~$ cluster upgrade resume

=======================================
Upgrade status: Started resume successfully
=======================================
Usage
Resume operations only when an upgrade operation resulted in an error.

cluster upgrade resume restarts the installation operation from the point the error occurred and
then immediately returns to the command line. It does not wait for the operation to be complete. Use the
cluster upgrade status command to determine the status of the upgrade operation.
Related reference
cluster upgrade status
Checks the status of a Rubrik CDM upgrade operation.
cluster upgrade rollback

Rollback a Rubrik CDM software upgrade that was stopped due to an error to its previous version.
Syntax
cluster upgrade rollback
This example rolls back a stopped software upgrade.
ubuntu@vm-machine:~$ cluster upgrade rollback

=======================================
Upgrade status: Started rollback successfully

=======================================
Usage
Start a rollback operation only when an upgrade operation results in an error.

cluster upgrade rollback starts the installation operation and returns to the command line. It does
not wait for the operation to be complete. Use the cluster upgrade status command to determine
the status of the upgrade operation.
Related reference
cluster upgrade start

Start a Rubrik software upgrade.
Syntax
cluster upgrade start [-h] [--share filename] [--auto_rollback_on_error

{True,False}] [--mode {normal,prechecks_only,reset,rolling}]
--share filename Path to the install image tarball in the share area
--auto_rollback_on_error {True,False}] Automatic rollback to the current Rubrik cluster
version when an upgrade failure occurs.
--mode {normal | prechecks_only | reset} Indicates the upgrade mode:
• normal – Perform a complete upgrade.
• prechecks_only – Perform only the upgrade
prechecks.
• reset – Resets the upgrade mode. Not available
for disk image upgrade operations.
.
This example performs an upgrade precheck of the Rubrik cluster.
ubuntu@vm-machine:~$ cluster upgrade start --mode=prechecks_only

Do you want to use rubrik-image-6.0-dev-13025.tar.gz [y/N] [N]: y
=======================================
Starting upgrade in prechecks_only mode
=======================================
Upgrade status: Started pre-checks successfully

Usage
cluster upgrade start starts the installation operation and returns immediately to the command line.
Use the cluster upgrade status command to determine the status of the upgrade operation.
Related reference

Syntax
cluster upgrade status [-h] [watch]

watch Display the ongoing status of the upgrade
operation.
This example displays the status of the upgrade operation.
ubuntu@vm-machine:~$ cluster upgrade status

Current upgrade mode: prechecks_only
Current upgrade driver node: vm-machine-a75r3k-5pikoys
Current upgrade pre-checks tarball name: --share rubrik-image-6.0-
dev-13025.tar.gz
Current upgrade pre-checks status: In progress
Current run started at: 2021-06-08 18:02:19.483000 UTC+0000
Current pre-checks state (1/6): ACQUIRING

Current pre-checks task: Acquire lock for upgrade
Current pre-checks state progress: 0.0%
Finished states (0/6):
Pending states (5/6): COPYING, VERIFYING, UNTARING, DEPLOYING, PRECHECKING
Time taken so far: 6.06 seconds

Overall upgrade progress: 0.0%
cluster uptime
Displays information about the cluster since it was last started.
Syntax
cluster uptime

Example:
>> cluster uptime

VRVW4214C6134 | CHANGED | rc=0 >>
17:04:37 up 74 days, 20:25, 1 user, load average: 4.94, 3.50, 3.52
Usage
cluster uptime output includes the current local time, the length of time since the last restart, the
length of the current session, the node ID, and the load average for each node in the Rubrik cluster.
cluster version
Displays the version of the Rubrik cluster software installed on the node that hosts the current session. All
nodes on the Rubrik cluster run on the same version.
Syntax
cluster version
Example:
This example displays the version of the Rubrik CDM software.
>> cluster version

5.2.0-DA1-9118

Chapter 7
commands list
commands list
Displays a list of all CLI commands.
Syntax
commands list
Tab completion is available with this command.
commands list 08/17/2021 | 54

Chapter 8
Network management
Network management
Use these commands to analyze network performance in the Rubrik cluster and to manage VLANs and IP
addresses.
Precede these network commands with the submenu name 'network', as in network ifconfig. Tab
completion is available with these commands.
network arping
Sends a ping to MAC addresses for troubleshooting network and cluster installation issues.
Syntax
network arping
network bond_mode get

Displays the current bond mode.
Syntax
network bond_mode get
Usage
If the CLI session is running on an node that is not bootstrapped, network bond_mode get displays the
bond mode of the local node.
When run on a bootstrapped node, network bond_mode get displays a message stating the node is
bootstrapped.
network bond_mode set

Sets a new bond mode.
Syntax
network bond_mode set
Usage
network bond_mode set changes the currentbond mode to LACP or Active-Backup.
Network management 08/17/2021 | 55

Here is an example of using network bond_mode set to change the bond mode to LACP:
B-1468-lt >> network bond_mode set

=============================================
Set bond mode. Note this for local
node only.
=============================================
WARNING: Bond mode change only takes
effect after node reboot.
ARE YOU SURE TO CONTINUE TO SET BOND
MODE AND REBOOT THE CURRENT NODE?
Type "yes" to continue: yes
Current CDM bond mode = Active-Backup
Provide New Bond Mode, must be LACP
or Active-Backup: LACP
Updated CDM bond mode = LACP
Rebooting.
network broadcast_interface get

Adds a VLAN to an unbootstrapped node for network discovery.
Syntax
network broadcast_interface get
Usage
network broadcast_interface get applies only to bond0 interfaces.

network broadcast_interface get can be used on both bootstrapped and unbootstrapped nodes.
In a Rubrik cluster that has multiple VLANs, network broadcast_interface get selects a single
VLAN for node discovery.
network broadcast_interface remove

Removes the VLAN interface that performs Rubrik node discovery over VLAN.
Syntax
network broadcast_interface remove
network broadcast_interface setup

Sets up a VLAN interface for broadcast during bootstrapping and adding nodes.
Syntax
network broadcast_interface setup

Usage
Use network broadcast_interface setup only if native VLAN is disabled on the network switch.
network check_connectivity
Connects to a specified target host on a specified port and returns the result of the connection attempt.
Syntax
network check_connectivity hostname port_number
Here is a sample session for the network check_connectivity command.
network check_connectivity localhost 7780
network check_connectivity accepts a single port number.
network configure_ip_hosts_mapping
Configures custom entries in /etc/hosts.
Syntax
network configure_ip_hosts_mapping
Usage
Displays, creates, and deletes custom host file entries for the entire Rubrik cluster.
network configure_ip_hosts_mapping displays, creates, and deletes custom host file entries for
the entire Rubrik cluster.
Running this command from any node creates updated host files for all nodes in the cluster.
Use network configure_ip_hosts_mapping only when nodes are in a status of
OK
.

network dig
Queries DNS servers and performs DNS lookups.
Syntax
network dig @server name type

server Name of the DNS server.
name Name of the resource record.
type Type of query.
network esx_subnets
Use the network esx_subnets command to configure esx_subnets for the Rubrik cluster.
For VMware, esx_subnets filter the multiple ESXi host IP addresses and provide guidance for these
situations.
• For Export of vSphere virtual machine snapshots, the configured esx_subnets are used to filter the IP
addresses of ESXi hosts. For each IP address within the esx_subnets, an IP address to ESXi host FQDN
mapping entry is added to /etc/hosts file. These host file entries take priority over DNS lookup and
point VMware exports to the specified IP address of an ESXi host.
• For Live Mount or Instant Recovery operations of vSphere virtual machine snapshots, the esx_subnets
are used to filter multiple IP addresses of an ESXi host. Those IP addresses falling within the
esx_subnets are used to point IP address matching or optimization efforts to select the best local IP
address and export as a data store for mount operations.
network esx_subnets get

Lists the current subnets in local ESXi host entries.
Syntax
This command returns the currently configured esx_subnets.

B-1332-lt >> network esx_subnets get
{"esxSubnets": "192.168.2.0/24,10.255.0.0/16"}
Usage
Use network esx_subnets get only when the Rubrik cluster nodes are in a status of OK.

network esx_subnets reset
Removes all esx_subnets set from the Rubrik cluster.
Syntax
network esx_subnets reset
Usage
Use network esx_subnets reset only when the Rubrik cluster nodes are in a status of OK.
network esx_subnets set

Configure the esx_subnets used to connect to ESXi hosts for the current Rubrik cluster.
Syntax
network esx_subnets set IP_address [,IP_address][,IP_address],. . .

IP_address A comma-separated list of subnets using CIDR
notation.
This example sets the subnet 192.168.2.10:

network esx_subnets set 192.168.2.10/24,10.255.0.0/16
Usage
Enter subnet information carefully. Incorrect subnet settings can cause failures during backup, Live Mount,
and Instant Recovery of vSphere virtual machine snapshots.
Use network esx_subnets set only when the Rubrik cluster nodes are in a status of OK.
network ethtool
Sets and displays the speed, auto-negotiation, and duplexing settings for specified network interfaces. The
information can be used for diagnostic purposes.
Syntax
network ethtool [network_interface_setting], [network_interface_setting] . . .
Here is an example that uses network ethtool to list the current network interface settings.
network ethtool

This example set the network interface to eth2:
network ethtool interface=eth2
This example set the network interface to eth2, the network speed to 10000, duplex to full, and disables
autoneg:
network ethtool interface=eth2 speed=10000 duplex=full autoneg=off
Usage
Settings defined by the latest call overwrite persistent settings. The updated settings are persistent. When
no interfaces are defined, eth2 and eth3 are used by default.
network floating_ips
Displays the nodes in the Rubrik cluster and lists their associated floating IP addresses.
Syntax
network floating_ips
The following example uses network floating_ips to list the nodes in the Rubrik cluster and their
floating IP addresses.
B-1469-rb >> network floating_ips

Node Floating IPs
--------- -----------------------------------------------
B-1469-rb 10.0.32.66
B-1469-lt 10.0.32.168, 10.0.34.131, 10.0.35.59
B-1469-lb 10.0.33.20, 10.0.34.129, 10.0.36.46, 10.0.37.99
B-1469-rb >>
network hostname
Displays the hostname of the node that hosts the current session.
Syntax
network hostname
network hosts
Displays the contents of the /etc/hosts file for the node that hosts the current session.
Syntax
network hosts

Usage
To change host file entries, use network configure_ip_hosts_mapping.
network ifconfig
Displays the status and IP address configuration of interfaces active on the node or configures an interface
on the node that hosts the current session.
Syntax
network ifconfig
Usage
The command can display a single virtual or physical interface configuration and statistics.
Issue this command to view available arguments.
network ifconfig -h
network iperf
Measures network throughput between two nodes in the Rubrik cluster, or between a node and another
host on the network.
Syntax
network iperf [--help | -s | -c | -3]

-h | help Prints the help message and exits.
-s limit Runs the command in server mode on a node.
-c Runs the command in client mode on a node.
-3 Run iperf3 instead of iperf2
Usage
Use the network iperf command to determine possible network component problems between two
points.
network iperf accepts arguments available to the system iperf command. Issue this command to
view available arguments:
network iperf -h

network ipv6 configure
Configures or removes the IPv6 address of a specified node.
Syntax
network ipv6 configure
This session configures the IPv6 address.
>> network ipv6 configure

======================
Configure IPv6 address
======================
Interface: bond0
Add or remove IPv6 on the interface, add/remove:: add
Prefix for IPv6 subnet: 64
IPV6 for node B-0884-lb: ae1f:6bff:fe07::1
IPV6 for node B-0884-lt: ae1f:6bff:fe07::2
IPV6 for node B-0884-rb: ae1f:6bff:fe07::3
IPV6 for node B-0884-rt: ae1f:6bff:fe07::4
Usage
Rubrik CDM only uses IPv6 addresses for backups, Live Mounts, and restores of vSphere virtual machine
snapshots. All communications between nodes in the Rubrik cluster continue to use IPv4 addresses.
network requires the IPv6 address in CIDR form for each node.
A null value removes the IPv6 address.
Before using this command, verify the node status at the Rubrik CDM web UI.
network ipv6 list

Displays the IPv6 configuration of the nodes in the Rubrik cluster.
Syntax
network ipv6 list
Usage
This command returns a JSON object that lists the node names and associated IPv6 addresses.

network move_floating_ip
Reassigns a floating IP address from one node to another.
Syntax
network move_floating_ip [-h] --floating_ip floating_ip --node_id node_id --

cluster_id cluster_id
--floating_ip floating_ip Floating IP being moved.
--node_id node_id ID of node to which the floating IP is moving.
--cluster_id cluster_id Cluster ID from node table
Example:
Here is an example of using network move_floating_ip to move the floating IP 10.10.10.10 to node
B-1234-lb.
move_floating_ip.py --cluster_id cluster --node_id B-1234-lb --floating_ip

10.10.10.10
Related reference
cluster node_table
cluster rubrik_tool
Performs calls to the Rubrik API from the command line.
network mtr
Combines the functions of traceroute and ping to list the network connections with a specified host.
Syntax
network mtr hostname

hostname Name of the host. network connection information
between node hosting the current session and the
host.

Usage
network mtr accepts arguments available to the system mtr command. Run network mtr -h to view
available arguments.
network nameservers
Displays the DNS name servers listed in the /etc/resolv.conf file for the node that hosts the current session.
Syntax
network nameservers
Usage
Use the Rubrik CDM web UI to change DNS servers used by the Rubrik cluster.
network netstat
Provides statistics and information for network troubleshooting.
Syntax
network netstat
Usage
The network netstat command displays active and open network connections for the node that hosts
the current session.
network netstat accepts arguments available to the system netstat command. Run network
iperf -h to view available arguments.
network nslookup
Displays the IP address for a hostname.
Syntax
network nslookup [hostname]
Here is an example of using network nslookup to list the IP address of the current host.
network nslookup b-1229-lb.rubrik-lab.com

Server: 10.1.253.53
Address: 10.1.253.53#53
Name: b-1229-lb.rubrik-lab.com
Address: 10.0.115.142

Usage
network nslookup performs DNS queries against DNS servers, or against a specified DNS server, used
by the Rubrik cluster.
network ntp_status
Displays the status of the NTP server and any peers used by the Rubrik cluster.
Syntax
network ntp_status [hostname]

hostname Name of the NTP server.
Usage
network ntp_status calls the system ntpq -p command. The expected output shows two nodes in
contact with Network Time Protocol, and the remaining Rubrik cluster nodes getting peer updates from
those nodes. The output also includes the date and time.
network ping
Measures connectivity and latency from the node that hosts the current session to another host.
Syntax
network ping
Usage
network ping measures connectivity and latency by sending ICMP ECHO_REQUEST datagrams.
network ping accepts arguments available to the system ping command. Run network ping -h to
Related reference
network mtr
Combines the functions of traceroute and ping to list the network connections with a specified host.
network re_ip
Changes the IP addresses assigned to the nodes of a bootstrapped Rubrik cluster.
Syntax
network re_ip

The following example uses network re_ip to change the IP addresses of four nodes in a Rubrik cluster.
>> network re_ip

Please make sure that NICs are connected to trunk ports of the switch if
VLANs
are configured.
Default Gateway can be on new Management, Data interface or on a Service
VLAN.
If future default gateway is on a Service VLAN interface, the same Service
VLAN
and the same default gateway must have been currently configured in network
settings.
Default Gateway []: 10.1.75.1
Management Subnet Mask []: 255.255.0.0
Management Vlan (Optional):
Data Subnet Mask (Optional):
B-1468-lb Management IP: [10.0.35.7]: 10.0.86.9
B-1468-lt Management IP: [10.0.35.160]: 10.0.86.10
B-1468-rb Management IP: [10.0.33.28]: 10.0.86.11
B-1468-rt Management IP: [10.0.37.193]: 10.0.86.12
gateway: 10.1.75.1
management_subnet: 255.255.0.0
nodes:
- id: B-1468-lb
management_ip: 10.0.86.9
- id: B-1468-lt
- id: B-1468-rb
- id: B-1468-rt
ReIP can take 10 to 20 minutes to finish. It is normal to see no response
during this period of time.
Please be patient and do not issue Ctrl-C.
That will kill the ReIP process and leave system in error state.
When ReIP finishes, all nodes will automatically reboot.
Proceed with Re IP, Yes/No:: Yes
Usage
Run network re_ip only on bootstrapped Rubrik clusters.

Before running network re_ip, verify the node status at the Rubrik CDM web UI.
Changing the IP addresses requires all nodes to be in status of OK.
network re_ip need not change all IP addresses simultaneously. To retain the current IP address,
specify the same IP address at the prompt.
Executing network re_ip reboots all nodes that have changed IP addresses.
The network re_ip command cannot change the IP addresses assigned to the nodes of a Rubrik cloud
cluster.

network route
Displays all network routes configured for the node that hosts the current session.
Syntax
network route
Usage
network route accepts arguments available to the system route command. Run network route -h
to view available arguments:
Related reference
network static_route add
Requests static route configuration information, then adds a new static route to the Rubrik cluster.
network static_route delete
Lists the Cassandra route configurations. Specify a route number to delete a route configuration.
network set_default_gateway
Sets the default gateway, moving the default gateway from the bond0 network interface to the bond1
network interface.
Syntax
network set_default_gateway
Usage
Run this command only at the request of Rubrik Support, and only when the status of every node is
OK
.
Related reference
cluster node_table

Requests static route configuration information, then adds a new static route to the Rubrik cluster.
Syntax

The following example uses network static_route add to add a static route on bond0.
>> network static_route add

===================
Adding static route
===================
Network: 20.20.20.0
Subnet Mask: 255.255.255.0
Is this a reject route? [y/N] (Optional) [N]:
Device: bond0
Gateway: 10.10.45.1
Confirm route config:
{
"network": "20.20.20.0",
"netmask": "255.255.255.0",
"device": "bond0",
"gateway": "10.10.45.1"
}
Usage
All requested input is required and will be validated. The following table lists the required information.
Input Description Example

Network The network of the route. Do not 10.3.0.0
supply host numbers, since this is
not an IP address.
The gateway must be in the same
network as the device given.
Netmask Netmask of the network. The 255.255.0.0, 255.255.255.0, ...

netmask must match the
network, also without host
numbers.
Device The name of the interface to eth0, bond0
which the route is added.
Gateway The gateway must be in the
same network as specified by the
Device parameter.

Lists the Cassandra route configurations. Specify a route number to delete a route configuration.
Syntax
Usage
All requested input is required and will be validated. The following table lists the required information.

Input Description Example
Network The network of the route. Do not 10.3.0.0
supply host numbers, since this is
not an IP address.
The gateway must be in the same
network as the device given.
Netmask Netmask of the network. The 255.255.0.0, 255.255.255.0, ...

netmask must match the
network, also without host
numbers.
Device The name of the interface to eth0, bond0
which the route is added.
Gateway The gateway must be in the
same network as specified by the
Device parameter.
Usage
Use this command only when nodes are in a status of
OK
.
Running this command from any node creates updated host files for all nodes in the cluster.
Related reference
cluster node_table
network tcp_sack
Enables or disables the selective ack or tcp_sack commands for each node in the Rubrik cluster and lists
the current tcp_sack settings.
Syntax
network tcp_sack {settings | on | off}
Usage
The changed settings apply clusterwide for all interfaces on the Rubrik cluster and modify and reload the /
etc/sysctl.d/net.conf file.
Use this command only when nodes are in a status of OK.
The setting persists after a reboot, except after an upgrade, when the setting for each node changes to
the default value of the new version. In this case, the value must be updated to retain the previously set
value.
Changing SACK settings can severely slow network performance.

Related reference
cluster node_table
network vlan add

Configures a VLAN interface for each node in the Rubrik cluster.
Syntax
network vlan add
Usage
This table lists the required information.
Input Description
VLAN ID ID of the VLAN
VLAN Subnet mask Subnet mask of the VLAN
IPv4 address range Address range or the individual IPv4 address of
each node
Run network vlan add once from a single cluster node for each VLAN interface to be added to the
cluster.
Review and accept the generated JSON configuration to add the VLAN information to the Rubrik cluster.
The following example uses network vlan add to add a VLAN interface with an ID of 3.
B-0884-lb >> network vlan add

================
Add Cluster VLAN
================
VLAN id: 3
Subnet Mask: 255.255.255.0
Would you like to enter an IP range?
Type "yes" to continue, otherwise IP for each node needs to be manually
assigned: yes
Start IP: 10.1.75.10
Related reference
cluster node_table

network vlan list

Lists the currently active VLAN interfaces and IP addresses for a Rubrik cluster.
Syntax
network vlan list
network vlan remove

Removes the specified VLAN ID from all nodes in a Rubrik cluster.
Syntax
network vlan remove
Usage
If a VLAN ID is not included with the command, the Rubrik cluster prompts for one.
Related reference
cluster node_table

Chapter 9
Resource management commands
Resource management commands
Use resource management commands to examine and modify computing resources in the Rubrik cluster.
Precede these commands with the submenu name 'resource', as in resource df. Tab completion is
available with these commands.
resource df
Lists information about the filesystems mounted on the node that hosts the current session.
Syntax
resource df
Usage
This command is a diagnostic tool used on the Rubrik cluster. The diagnostic information it lists applies
only to the capacity and mount points of the file systems mounted on the node that hosts the current
session.
Issue resource df for standard output. Issue resource df -h for improved readability.
resource df output can include:
• Number of 1 K blocks
• Space used
• Space available
• Percentage of space used
• Mount point
resource df accepts arguments available to the system df command. Run resource df -h to view
available arguments.
resource storage_statistics
Lists the total storage used on a Rubrik cluster and the storage used by snapshots and Live Mounts.
Syntax
The following example uses resource storage_statistics to list storage on the Rubrik cluster.
Total Storage: 22.5 TB
Available: 22.5 TB
Resource management commands 08/17/2021 | 72

System Storage: 2.0 GB
Live Mounts: 0B
Snapshot: 0B
Usage
Use this command to retrieve the current total storage used, storage used for snapshots, and storage used
for Live Mounts.
resource system_stats
Lists statistics for CPU activity, memory usage, and status of the nodes.
Syntax
resource system_stats [-all]

The following table defines the command parameters.
-all Displays information about the nodes in this Rubrik
cluster.
Usage
The storage information is derived from the resource df and cluster uptime commands for the
node from which the command was run.
The space represented is not related to snapshot storage usage.
resource top
Displays a dynamic, real-time view of the processes running on the node that hosts the current session.
Syntax
resource top
Usage
The processes include CPU, memory, and file usage of node resources.
Type q to quit top and return to the CLI prompt.
The command is used for diagnostic purposes.
Run this command only at the request of Rubrik Support.
resource top accepts arguments available to the system top command. Run resource top -h to
resource top -h
Resource management commands 08/17/2021 | 73

Chapter 10
User commands
User commands
User commands enable viewing and managing user account configurations through the Rubrik CLI.
Precede these commands with the submenu name 'users', as in users ldap. Tab completion is available
with these commands.
users ldap
Manages the Rubrik cluster LDAP integration.
Syntax
users ldap {show logs | configuration list | configuration getconfiguration |

configuration set configuration=value
The following table describes the command parameters.
show logs Lists available logs.
configuration list Lists the current settings for the configuration.
configuration get configuration Displays the value of the specified configuration.
configuration set configuration=value Changes the configuration to the provided value.
Changes take effect within an hour unless a service
restart is required.
This table defines the settings for configuration.
ldapsTlsProtocol Name of the encryption algorithm to use for secure
LDAP communication, either TLS or StartTLS.
Choosing a weaker algorithm may violate your
company's security requirements.
ldapFollowReferrals Boolean value that determines if LDAP query

referrals are followed. The default value is true,
which permits the Rubrik cluster to follow a referral
from one LDAP server to another. When required
by the LDAP administrator, set the value to false,
forcing the Rubrik cluster to ignore LDAP referrals.
Ignoring LDAP referrals breaks the standard
relationship between LDAP servers and may break
regular authentication.
User commands 08/17/2021 | 74

ldapBindTimeoutMillis Amount of time, in milliseconds, to wait for a
reply to an LDAP user authentication request.
When requests are routed through a two factor
authentication proxy, the delay must be high
enough to permit the second factor of the
authentication to complete. The Rubrik REST API
server enforces a default authentication timeout of
five minutes, which is not controlled by this setting.
ldapConnectionTimeoutMillis Amount of time, in milliseconds, to wait for an
LDAP connection timeout. Used while establishing
the connection pool. This value becomes a factor
only when none of the LDAP servers respond within
this interval.
ldapActiveDirectoryEmptyPaginatedSearchResultRetryNum
Number of Active Directory query retries after a
query receives a paginated response that is empty,
but there is an indication that there are more
responses pending. This value should be three or
less since empty responses typically come after two
minutes.
ldapActiveDirectoryDisableMatchingRuleInChain Microsoft Active Directory supports a matching

rule called LDAP_MATCHING_RULE_IN_CHAIN
that determines the ancestry of an object.
Occasionally, this optimization slows a system's
search performance. If this occurs, disable this
matching rule. When disabled, the Rubrik cluster
sends multiple LDAP queries to locate the groups of
a user.
ldapSDKLogLevel Log level of an unbound LDAP SDK. Valid values
are OFF, SEVERE, WARNING, INFO, CONFIG, FINE,
FINER, FINEST, ALL.
ldapSearchAcrossIntegrations Boolean value specifying whether to
extend the LDAP search across all the
LDAP integrations instead of limiting the
search to the integration where the user is
logged in. If the value is set to true then
ldapActiveDirectoryDisableMatchingRuleInChain is
ignored and assumed to be true as well.
Usage
The logs can be searched for basic terms, similar to viewing a file using the less command.
User commands 08/17/2021 | 75

Chapter 11
Support management
Support management
Use support data commands to generate and manage diagnostic data.

Precede these commands with the submenu name 'support', as in support
cluster_support_bundle. Tab completion is available with these commands.
support cluster_support_bundle
Generates a cluster-wide support bundle for Rubrik Support debugging purposes.
Syntax
support cluster_support_bundle [-h | logs | stats | metainfo | sysinfo | full

| everything]
logs Include all logs, including services, jobs, syslog,
accesslog, and so on.
stats Include information about the influxDB backups
during the last 24 hours and any influx debug
information.
metainfo Include cluster metadata and configuration
information. The config file contains the complete
list.
sysinfo Include all point in time system information.
full | everything Include all information in the output.
Example: support cluster_support_bundle logs session
>> support cluster_support_bundle logs

Destination disk (local/usb) [local]:
Generating cluster support bundle to local disk...
Support Bundle is available at share/support_bundle/
clustersupportbundle-5.3.0-DA1-10605-2020-10-05-21-02-18.tar.gz
Support management 08/17/2021 | 76

Usage information
support cluster_support_bundle writes a support bundle to a local directory or to a USB location.
support decommission_status
Displays the status of the currently running decommission job.
Syntax
support decommission_status
Example:
>> support decommission_status

status: RUNNING
archived: False
isDisabled: False
nodeId: cluster:::B-1473-rb
startTime: 2020-10-26T22:33:59+0000
id: DECOMMISSION_NODES_GLOBAL_fba60e6e-ef0d-4cff-88f7-dddbc4462840:::0
jobType: DECOMMISSION_NODES
jobProgress: 2.0
support find_bad_disk
Locates a failed disk drive.
Syntax
support find_bad_disk [-OFF]

-OFF Include all logs, including services, jobs, syslog,
accesslog.
Usage
Rubrik clusters running on virtual machines do not support the support find_bad_disk command.
support find_bad_disk runs a subset of disk-drive-specific commands displayed by cluster
hw_health, and works in conjunction with cluster ledctl to illuminate LED lights for failed disks.

support iops
Measures disk IOPS.
Syntax
support iops
Here is an example that shows how to list the current IOPS.
>> support iops

Block size [4k]:
Data size [1G]:
IO depth [64]:
Read/write mode("read", "write") [read]:
/dev/sde:
read: IOPS=48.8k, BW=191MiB/s (200MB/s)(1024MiB/5369msec)
/dev/sdd:
read: IOPS=104k, BW=406MiB/s (425MB/s)(1024MiB/2525msec)
/dev/sdc:
/dev/sda:
/dev/sdb:
Usage
Running support iops is a resource-intense operation, creating a significant load on the system. Run
support iops only prior to bootstrapping, or on clusters that require attention. Do not run support
iops on a healthy cluster.
support local_support_bundle
Generates a support log bundle with logs from all of the nodes in the cluster. The logs are configured for
use by Rubrik Support.
Syntax
support local_support_bundle [-h | logs | stats | metainfo | sysinfo | full |

everything]
logs Include all logs, including services, jobs, syslogs,
and accesslogs.
stats Include information about the influxDB backups
during the last 24 hours and any influx debug
information.

metainfo Include cluster metadata and configuration
information. The config file contains the complete
list.
sysinfo Include all point in time system information.
full | everything Include all information in the output.
Table 1: Required input
Destination disk Specifies the location to save the support bundle.
Indicate a local directory or a USB drive.
Example: Generating the default local support bundle
This example produces a local support bundle in the default location.

>> support local_support_bundle
Destination disk (local/usb) [local]: Generating local support bundle
to local disk... Support Bundle is available at share/support_bundle/
supportbundle-5.3.0-DA1-10620-2020-10-13-20-49-23.tar.gz.run
Example: Generating local support bundle logs
This example produces a local support bundle in the default location.

>> support local_support_bundle logs
Destination disk (local/usb) [local]: Generating local support bundle
to local disk... Support Bundle is available at share/support_bundle/
supportbundle-5.3.0-DA1-10620-2020-10-13-20-49-23.tar.gz.run
support log_view
View the log for Rubrik cluster services.
Syntax
support log_view [service_name]

service_name Name of the service.
This table lists the available services for service_name.

agent-server key-wrapper search
backup-agent lambda snapshot
cassandra lambda-content-analyzer spray-server
cdp-log-receiver lambda-parser-service upgrade-service
cdp-metadata-service node-monitor vmware
cloud-storage-service pyvmware firewall
cluster-config remote-cluster kern
cockroachdb replication syslog
diamond samba
job-fetcher sdfs
Example:
This example displays the log for the SDFS server created with a timestamp of 2020-10-11
07:31:59.186621.
>> support log_view
1: agent-server
2: backup-agent
3: cassandra
4: cdp-log-receiver
5: cdp-metadata-service
6: cloud-storage-service
7: cluster-config
8: cockroachdb
9: diamond
10: job-fetcher
11: key-wrapper
12: lambda
13: lambda-content-analyzer
14: lambda-parser-service
15: node-monitor
16: pyvmware
17: remote-cluster
18: replication
19: samba
20: sdfs
21: search
22: snapshot
23: spray-server
24: upgrade-service
25: vmware
26: firewall
27: kern
28: syslog
Type 'exit' to exit log_view.

Select service [1..28]: 20
1: @400000005f7e60931ef5d1c4.s 2020-10-08 00:42:49.499682
2: @400000005f7e9dc708ce4b9c.s 2020-10-08 05:03:57.126629
3: @400000005f7ed7a42c5f65dc.s 2020-10-08 09:10:50.733661
4: @400000005f7f0769219173d4.s 2020-10-08 12:34:39.552599

5: @400000005f7f47ef0ae94bfc.s 2020-10-08 17:09:57.172645
6: @400000005f7f807b1f96c8cc.s 2020-10-08 21:11:13.521344
7: @400000005f7fb2cb092bffe4.s 2020-10-09 00:45:53.142654
8: @400000005f7ff4bd1bcd0ae4.s 2020-10-09 05:27:15.451925
9: @400000005f80298c23f446ec.s 2020-10-09 09:12:34.592165
10: @400000005f8062502eb93c2c.s 2020-10-09 13:14:46.772811
11: @400000005f80a489004c7ffc.s 2020-10-09 17:57:18.990263
12: @400000005f80d29d18e96354.s 2020-10-09 21:13:55.406995
13: @400000005f81113e0d890cbc.s 2020-10-10 01:41:08.214378
14: @400000005f8153e815dba26c.s 2020-10-10 06:25:34.352509
15: @400000005f817f762283b374.s 2020-10-10 09:31:24.564016
16: @400000005f81c26929bb6b14.s 2020-10-10 14:17:03.689260
17: @400000005f8205322e7fcd0c.s 2020-10-10 19:02:00.769883
18: @400000005f822f19016aa5e4.s 2020-10-10 22:00:47.013958
19: @400000005f8271eb23559dbc.s 2020-10-11 02:45:53.585868
20: @400000005f82b4f90bc67914.s 2020-10-11 07:31:59.186621
21: @400000005f82e1611668dac4.s 2020-10-11 10:41:27.362239
22: @400000005f83245f311fad0c.s 2020-10-11 15:27:17.811883
23: @400000005f83677f1d006294.s 2020-10-11 20:13:41.476343
24: @400000005f8391d925e97f6c.s 2020-10-11 23:14:23.625636
25: @400000005f83d4c006404204.s 2020-10-12 03:59:50.093927
26: @400000005f84179b10740f1c.s 2020-10-12 08:45:05.270421
27: @400000005f844341105947a4.s 2020-10-12 11:51:19.263815
28: @400000005f848625173f64a4.s 2020-10-12 16:36:43.376629
29: @400000005f84c62f34e71d1c.s 2020-10-12 21:09:57.879041
30: @400000005f84f3790ff8a174.s 2020-10-13 00:23:11.258038
31: @400000005f853684293efb9c.s 2020-10-13 05:09:14.686915
32: @400000005f856f73283dcbc4.s 2020-10-13 09:12:09.667055
33: @400000005f85a54b0596139c.s 2020-10-13 13:01:53.079567
34: @400000005f85e819346f262c.s 2020-10-13 17:46:55.870357
35: @400000005f86189b1230e9ec.s 2020-10-13 21:13:53.294775
36: current 2020-10-13 23:47:24.523621
Type 'exit' to exit log_view.

Type 'back' to select a different service.
Select file [1..36]: 10
2020-10-09T09:12:34.406 INFO 32630 maintenance_manager.cpp:784
094cf61312390e30 All stripes garbage collected
2020-10-09T09:12:34.540 INFO 32653 metadata_manager.cpp:1370
0a4c2d121aa825ef,GLOBAL_d758b5fb-3fc4-4416-ac64-42be085010e6.sqlite
. . .
Usage
Run support log_view without a parameter for a list of currently supported services.
support teleport regtoken

Generates a token to register the node with Rubrik's support tunnel.
Syntax
support teleport regtoken
Example: Generate a token

>> support teleport regtoken
Registration token: CF3FQ3UQNXCVF4C35M5OQQ4GPUGELOL2XXEGFRQJ75U74OCK6NLA-
TNN6JEYH3NSPS3UZ3AWJJFSQETBCQATSOB2MHCIHHV3KR5UZ3F2Q
support toggle_support_data
Enables and disables the movement of data like system statistics, errorlogs, traces, or uploads from the
Rubrik cluster.
Syntax
support toggle_support_data [-h] {--show | --opt_in | --opt_out} {--

systemstats | --errorlogs | --traces | --uploads | --all}
--show Display the status of the specified data.
--opt_in Enable data upload for the specified data.
--opt_out Disable data upload for the specified data.
--systemstats Include live statistics.
--errorlogs Include error logs for services and jobs.
--traces Include traces for the services and jobs..
--uploads Include support bundle, report bundle, and
metadata uploads.
--all Manage configurations for all data types, --
systemstats, --errorlogs, --traces, and --uploads.
Example: Determine if systemstats are enabled
Type this to determine if the systemstats are enabled or disabled.
>> support toggle_support_data --show --systemstats

[{'dataType': 'systemstats', 'status': 'enabled'}]
Example: Show all system statistics
Type this to display all system statistics.
>> support toggle_support_data --show --all

[{'dataType': 'systemstats', 'status': 'enabled'}, {'dataType': 'errorlogs',
'status': 'enabled'},

{'dataType': 'traces', 'status': 'enabled'}, {'dataType': 'uploads',
'status': 'enabled'}]
Example: Disable the errorlogs
Type this command do disable the errorlogs.
>> support toggle_support_data --opt_out --errorlogs

Disabling errorlogs
Successfully disabled errorlogs
Uploading config changes to S3...
Usage
Run support toggle_support_data only after consulting with Rubrik Support.
support tunnel close

Closes an open support tunnel for this node.
Syntax
support tunnel close
Example: Close an open support tunnel
This example closes an open support tunnel.
>> support tunnel close

Closed support tunnel on port 51564
support tunnel get_port

Get the port for the support tunnel for this node, if open.
Syntax
Example: Retrieve the port number
Retrieve the port number used by the support tunnel.

51564
support tunnel get_timeout_type

Indicates the support tunnel closes due to inactivity or after a fixed interval of time. The default is
inactivity.
Syntax
support tunnel get_timeout_type
Example: Displays the timeout type
This example reports that the support tunnel is closed due to inactivity
>> support tunnel get_timeout_type

Support tunnel timeouts are based on inactivity
Example:
This example reports that the support tunnel is closed after a fixed interval of time.
>> support tunnel get_timeout_type

Support tunnel timeouts close after a fixed interval of time
support tunnel open

Open a support tunnel for the node.
Syntax
support tunnel open [INACTIVITY_TIMEOUT_IN_SECONDS ] [force]

INACTIVITY_TIMEOUT_IN_SECONDS Indicates the number of seconds before an

inactivity timeout occurs.
force Forces the support tunnel to open regardless of its
state.
Example:

This example opens the support tunnel and configures an inactivity timeout period of 15 seconds.
>> support tunnel open 15

Opened support tunnel on port 0 with an inactivity timeout of 15 seconds
support tunnel service

Start or view the status of a support tunnel service. The services available to start or view are chisel and
the support-tunnel.
Syntax
support tunnel service {service-name} {action}

This table defines the parameters.
Variable Parameter Description

service-name chisel Perform action on the chisel
service.
support-tunnel Perform action on the support-
tunnel service.
action status Check the status of the service.
restart Restart the service
Example: Determine the status of a service
This example displays the status of the chisel service.
B-0768-lb >> support tunnel service chisel status

● chisel.service - Rubrik Chisel
Loaded: loaded (/lib/systemd/system/chisel.service; enabled; vendor
preset: enabled)
Active: active (running) since Thu 2020-11-05 16:20:00 UTC; 1 day 7h ago
Main PID: 6557 (chisel.sh)
Tasks: 38 (limit: 4915)
CGroup: /system.slice/chisel.service
├─6557 /bin/bash /opt/rubrik/src/scripts/dev/chisel.sh
├─7174 /opt/rubrik/src/go/bin/chisel --logtostderr=INFO client --
keepalive=30s https://proxy.rubrik.com:443 localhost:10010:v3.l
└─7175 multilog s16777210 n10 !/bin/gzip /var/log/chisel
Warning: Journal has been rotated since unit was started. Log output is
incomplete or unavailable.
Example: Restarting a service
This example restarts the chisel service.
>> support tunnel service 'chisel' 'restart'

Restarting the chisel service may change the existing support tunnel port.
Are you sure? [y/N] (Optional) [N]: y
support tunnel use_absolute_timeout

Configure the support tunnel to use a timeout based on a fixed interval of time.
Syntax
support tunnel use_absolute_timeout
Example: Configure for absolute timeouts
This example configures the support tunnel to timeout after a period of inactivity.
>> support tunnel use_absolute_timeout

Now using absolute timeouts for support tunnel
support tunnel use_inactivity_timeout

Configure the support tunnel to use inactivity timeouts.
Syntax
support tunnel use_inactivity_timeout
Example: Configure for inactivity timeouts
This example configures the support tunnel to timeout after a period of inactivity.
>> support tunnel use_inactivity_timeout

Now using inactivity timeouts for support tunnel
Usage
Determine the inactivity timeouts with the support tunnel open command.
Related reference
support tunnel open
Open a support tunnel for the node.

Rubrik CDM Version 6.0 CLI Reference Guide (Rev. B3)

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Rubrik CDM Version 6.0 CLI Reference Guide (Rev. B3)

Uploaded by

Copyright:

Available Formats

Rubrik CDM CLI Reference

Rubrik Headquarters: Palo Alto, California 94304

Copyright and trademarks

Copyright © 2021 Rubrik Inc.

Registered in the U.S. Trademark Office

Copyright and trademarks 08/17/2021 | ii

Copyright and trademarks 08/17/2021 | iii

Web Rubrik Support Portal

Revision Date Description

Rev. B1 June 2021 • Added the cluster health_monitor get_policies and

Comments and suggestions

About the Rubrik CLI.....................................................................................................................11

Accessing the Rubrik CLI.............................................................................................................. 12

Using the online help.................................................................................................................... 13

Contents 08/17/2021 | vii

Resource management commands............................................................................................... 72

Contents 08/17/2021 | viii

Rubrik Build 08/17/2021 | 10

About the Rubrik CLI

Usage and capabilities of the Rubrik CLI environment.

About the Rubrik CLI 08/17/2021 | 11

Accessing the Rubrik CLI

Access the Rubrik CLI through an SSH session.

Accessing the Rubrik CLI 08/17/2021 | 12

Using the online help

Structure and usage of the Rubrik CLI online help.

Each entered command prints its usage information, or syntax.

Using the online help 08/17/2021 | 13

These commands manage Rubrik cluster cloud settings.

cloud network get_flag_public_or_private_ip

cloud network get_flag_public_or_private_ip

Example: Display the IP

This examples determines that the system uses a private IP.

cloud network get_flag_public_or_private_ip

cloud network use_private_ip

cloud network use_private_ip

Example: Configure for private IP

>> cloud network use_private_ip

Cloud management 08/17/2021 | 14

cloud network use_public_ip

Example: Configure for private IP

>> cloud network use_public_ip

Cloud management 08/17/2021 | 15

Example: Sample 'cluster add_node' session

Cluster management 08/17/2021 | 16

Example: Sample session

Here is a sample session for the bootstrap command.

>> cluster bootstrap

Example: Sample session

Following is a sample session for the cluster_name command.

>> cluster cluster_name

Cluster management 08/17/2021 | 17

Example: Sample session

This example shows the current cluster UUID.

>> cluster cluster_uuid

Example: Sample sessions

Following is a sample session for the cluster discover command.

>> cluster discover

Cluster management 08/17/2021 | 18

>> cluster discover

Example: Sample session

Here is a sample session for the entitle_node command.

RDL6420BYTKS13CNWS3009AV00BX03 >> cluster entitle_node

Node requires entitlement.