Skip to main content

Rubrik Radar

This Integration is part of the Rubrik Polaris Pack.#

Supported versions

Supported Cortex XSOAR versions: 6.0.0 and later.

The Rubrik Radar integration will fetch the Rubrik Radar Anomaly Event and is rich with commands to perform the on-demand scans, backups, recoveries and many more features to manage and protect the organizational data. This integration was integrated and tested with version 1.0.0 of RubrikPolaris

Configure Rubrik Radar on Cortex XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for Rubrik Radar.

  3. Click Add instance to create and configure a new integration instance.

    ParameterDescriptionRequired
    Service Account JSONFalse
    Polaris Account (e.g. ${polarisAccount}.my.rubrik.com)False
    EmailFalse
    PasswordFalse
    Fetch incidentsFalse
    Incident typeFalse
    First fetch timeThe time interval for the first fetch (retroactive). Examples of supported values can be found at https://dateparser.readthedocs.io/en/latest/\#relative-dates.False
    Fetch Limit (Maximum of 1000)Maximum number of incidents to fetch every time. The maximum value is 1000.False
    Radar Critical Severity Level MappingWhen a Radar event of Critical severity is detected and fetched, this setting indicates what severity will get assigned within XSOAR.False
    Radar Warning Severity Level MappingWhen a Radar event of Warning severity is detected and fetched, this setting indicates what severity will get assigned within XSOAR.False
    Use system proxy settingsWhether to use XSOAR's system proxy settings to connect to the API.False
    Trust any certificate (not secure)Whether to allow connections without verifying SSL certificates validity.False
  4. Click Test to validate the URLs, token, and connection.

Commands#

You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.

rubrik-radar-analysis-status#


Check the Radar Event for updates.

Base Command#

rubrik-radar-analysis-status

Input#

Argument NameDescriptionRequired
activitySeriesIdThe ID of the Polaris Event Series. When used in combination with \"Rubrik Radar Anomaly\" incidents, this value will automatically be looked up using the incident context. Otherwise it is a required value.

Note: Users can retrieve the list of the activity series IDs by executing the \"rubrik-event-list\" command.
Required
clusterIdThe ID of the CDM cluster. When used in combination with \"Rubrik Radar Anomaly\" incidents, this value will automatically be looked up using the incident context. Otherwise, it is a required value.

Note: Users can retrieve the list of the cluster IDs by executing the \"rubrik-gps-cluster-list\" command.
Required

Context Output#

PathTypeDescription
Rubrik.Radar.EventCompleteBooleanFlag that indicates whether Radar has finished analysing the object.
Rubrik.Radar.MessageUnknownThe text, ID, and timestamp of each message in the Activity Series.
Rubrik.Radar.ActivitySeriesIdStringThe ID of the Rubrik Polaris Activity Series.
Rubrik.Radar.ClusterIdStringThe ID of the cluster.

Command Example#

!rubrik-radar-analysis-status activitySeriesId="" clusterId="cc19573c-db6c-418a-9d48-067a256543ba"

Human Readable Output#

Radar Analysis Status#

Activity Series IDCluster IDMessageEvent Complete
ec9c48ce-5faf-474a-927c-33667355aecdcc19573c-db6c-418a-9d48-067a256543baCompleted backup of the transaction log for SQL Server database 'AdventureWorks2012' from 'sx1-sql12-1\MSSQLSERVER'.True

rubrik-sonar-sensitive-hits#


Find data classification hits on an object.

Base Command#

rubrik-sonar-sensitive-hits

Input#

Argument NameDescriptionRequired
objectNameThe name of the Rubrik object to check for sensitive hits. When used in combination with "Rubrik Radar Anomaly" incidents, this value will automatically be looked up using the incident context. Otherwise it is a required value.

Note: Users can get the list of the object names by executing the "rubrik-polaris-object-list" or "rubrik-polaris-object-search" command.
Optional
searchTimePeriodThe number of days in the past to look for sensitive hits. If no value is provided, then today's data will be returned and, if there is no data for today then the argument will default to 7 days.
Default is 7.
Optional

Context Output#

PathTypeDescription
Rubrik.Sonar.totalHitsStringThe total number of data classification hits found on the provided object.
Rubrik.Sonar.idStringID of the sensitive hits object.
Rubrik.Sonar.policy_hitsUnknownInformation of the policy analyzer group of the sensitive hits object.
Rubrik.Sonar.filesWithHitsNumberThe total number of files with hits of the object.
Rubrik.Sonar.openAccessFilesNumberThe total number of open access files of the object.
Rubrik.Sonar.openAccessFilesWithHitsNumberThe total number of open access files with hits of the object.
Rubrik.Sonar.openAccessFoldersNumberThe total number of open access folders of the object.
Rubrik.Sonar.staleFilesNumberThe total number of stale files of the object.
Rubrik.Sonar.staleFilesWithHitsNumberThe total number of stale files with hits of the object.
Rubrik.Sonar.openAccessStaleFilesNumberThe total number of open access stale files of the object.
Rubrik.Radar.MessageUnknownThe text, ID, and timestamp of each message in the Activity Series.
Rubrik.Radar.ActivitySeriesIdStringThe ID of the Rubrik Polaris Activity Series.

Command Example#

!rubrik-sonar-sensitive-hits objectName="sx1-radar15"

Human Readable Output#

Sensitive Hits#

IDTotal Hits
afc0f6f0-148a-54c5-9927-c24c7cde160849684

rubrik-cdm-cluster-location#


Find the CDM GeoLocation of a CDM Cluster.

Base Command#

rubrik-cdm-cluster-location

Input#

Argument NameDescriptionRequired
clusterIdThe ID of the CDM cluster. When used in combination with "Rubrik Radar Anomaly" incidents, this value will automatically be looked up using the incident context. Otherwise, it is a required value.

Note: Users can retrieve the list of the cluster IDs by executing the "rubrik-gps-cluster-list" command.
Required

Context Output#

PathTypeDescription
Rubrik.CDM.Cluster.LocationStringThe GeoLocation of the Rubrik CDM Cluster.
Rubrik.CDM.ClusterIdStringThe ID of the cluster.

Command Example#

!rubrik-cdm-cluster-location clusterId="cc19573c-db6c-418a-9d48-067a256543ba"

Human Readable Output#

CDM Cluster Location#

Location
San Francisco, CA, USA

rubrik-cdm-cluster-connection-state#


Find the CDM Connection State of a CDM Cluster.

Base Command#

rubrik-cdm-cluster-connection-state

Input#

Argument NameDescriptionRequired
clusterIdThe ID of the CDM cluster. When used in combination with "Rubrik Radar Anomaly" incidents, this value will automatically be looked up using the incident context. Otherwise, it is a required value.

Note: Users can retrieve the list of the cluster IDs by executing the "rubrik-gps-cluster-list" command.
Required

Context Output#

PathTypeDescription
Rubrik.CDM.Cluster.ConnectionStateStringThe Connection State of the Rubrik CDM Cluster.
Rubrik.CDM.ClusterIdStringThe ID of the cluster.

Command Example#

!rubrik-cdm-cluster-connection-state clusterId="cc19573c-db6c-418a-9d48-067a256543ba"

Human Readable Output#

CDM Cluster Connection State#

Connection State
Connected

rubrik-polaris-object-search#


Search for Rubrik discovered objects of any type, return zero or more matches.

Base Command#

rubrik-polaris-object-search

Input#

Argument NameDescriptionRequired
limitNumber of results to retrieve in the response. Maximum size allowed is 1000. Default is 50.Optional
object_nameThe name of the object to search for.Required
sort_bySpecify the field to use for sorting the response.

Note: Supported values are "ID" and "NAME" only. For any other values, the obtained result is sorted or not is not confirmed. Default is ID.
Optional
sort_orderSpecify the order to sort the data in.

Possible values are: "ASC", "DESC". Default is ASC.
Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional

Context Output#

PathTypeDescription
RubrikPolaris.GlobalSearchObject.idStringThe ID of the object.
RubrikPolaris.GlobalSearchObject.nameStringThe name of the object.
RubrikPolaris.GlobalSearchObject.objectTypeStringThe type of the object.
RubrikPolaris.GlobalSearchObject.physicalPath.fidStringThe FID of the physical path of the object.
RubrikPolaris.GlobalSearchObject.physicalPath.nameStringThe name of the physical path where the object relies.
RubrikPolaris.GlobalSearchObject.physicalPath.objectTypeStringThe object type of the physical path where the object relies.
RubrikPolaris.GlobalSearchObject.azureRegionStringThe azure region of the object.
RubrikPolaris.GlobalSearchObject.awsRegionStringThe aws region of the object.
RubrikPolaris.GlobalSearchObject.emailAddressStringThe email address of the object.
RubrikPolaris.GlobalSearchObject.isRelicBooleanWhether the object is relic (historical) or not.
RubrikPolaris.GlobalSearchObject.effectiveSlaDomain.idStringThe effective SLA domain ID of the object.
RubrikPolaris.GlobalSearchObject.effectiveSlaDomain.nameStringThe effective SLA domain name of the object.
RubrikPolaris.GlobalSearchObject.effectiveSlaDomain.descriptionStringThe effective SLA domain description of the object.
RubrikPolaris.GlobalSearchObject.effectiveSlaDomain.fidStringThe FID of the object's effective SLA domain.
RubrikPolaris.GlobalSearchObject.effectiveSlaDomain.cluster.idStringThe cluster ID of the object's effective SLA domain.
RubrikPolaris.GlobalSearchObject.effectiveSlaDomain.cluster.nameStringThe cluster name of the object's effective SLA domain.
RubrikPolaris.GlobalSearchObject.physicalChildConnection.countStringThe count of physical child connection of the object.
RubrikPolaris.GlobalSearchObject.physicalChildConnection.edges.node.idStringThe ID of physical child connection of the object.
RubrikPolaris.GlobalSearchObject.physicalChildConnection.edges.node.nameStringThe name of the physical child connection of the object.
RubrikPolaris.GlobalSearchObject.physicalChildConnection.edges.node.replicatedObjects.cluster.idStringThe cluster ID of the replicated objects of physical child connection of the object.
RubrikPolaris.GlobalSearchObject.physicalChildConnection.edges.node.replicatedObjects.cluster.nameStringThe cluster name of the replicated objects of physical child connection of the object.
RubrikPolaris.GlobalSearchObject.cluster.idStringThe cluster ID related to the object.
RubrikPolaris.GlobalSearchObject.cluster.nameStringThe name of the cluster related to the object.
RubrikPolaris.GlobalSearchObject.primaryClusterLocation.idStringThe primary cluster location ID of the object.
RubrikPolaris.GlobalSearchObject.gcpZoneStringThe gcp zone of the object.
RubrikPolaris.GlobalSearchObject.gcpRegionStringThe gcp region of the object.
RubrikPolaris.GlobalSearchObject.gcpNativeProject.nameStringThe gcp native project name of the object.
RubrikPolaris.PageToken.GlobalSearchObject.next_page_tokenStringNext page token.
RubrikPolaris.PageToken.GlobalSearchObject.nameStringName of the command.
RubrikPolaris.PageToken.GlobalSearchObject.has_next_pageBooleanWhether the result has the next page or not.

Command Example#

!rubrik-polaris-object-search object_name="admin" limit=2

Human Readable Output#

Global Objects#

Object IDObject NameTypeSLA Domain
0f667954-9052-42c8-ac20-2149da4d0ec4Hoang-Admin NguyenO365MailboxUNPROTECTED
3e5d0800-71f6-4e42-badc-ae8b98c8a808Admin o365O365MailboxUNPROTECTED

Note: To retrieve the next set of results use, "next_page_token" = xyz

rubrik-sonar-policies-list#


Retrieve the list of all the available Sonar policies.

Base Command#

rubrik-sonar-policies-list

Input#

There are no input arguments for this command.

Context Output#

PathTypeDescription
RubrikPolaris.SonarPolicy.idStringUnique ID of the policy.
RubrikPolaris.SonarPolicy.nameStringName of the policy.
RubrikPolaris.SonarPolicy.descriptionStringDescriptive name of the policy.
RubrikPolaris.SonarPolicy.creator.emailStringEmail of the user who created the policy.
RubrikPolaris.SonarPolicy.totalObjectsNumberNumber of total objects present in the policy.
RubrikPolaris.SonarPolicy.numAnalyzersNumberNumber of analyzers present in the policy.
RubrikPolaris.SonarPolicy.objectStatuses.idStringID of the object present in the policy.
RubrikPolaris.SonarPolicy.objectStatuses.latestSnapshotResult.snapshotFidStringSnapshot ID of the object present in the policy.
RubrikPolaris.SonarPolicy.objectStatuses.policyStatuses.policyIdStringPolicy ID.
RubrikPolaris.SonarPolicy.objectStatuses.policyStatuses.statusStringPolicy status.

Command Example#

!rubrik-sonar-policies-list

Human Readable Output#

Sonar Policies#

IDNameDescriptionAnalyzersObjectsCreator Email
bdb8c043-ee89-43ef-a3e2-73e94b5b3900CCPACalifornia Consumer Privacy Act53dummy.email@rubrik.com
53e447ed-9114-4fcd-b5a6-7ac759980fdeGLBAU.S. Gramm-Leach-Bliley Act43

rubrik-sonar-policy-analyzer-groups-list#


List the analyzer group policies.

Base Command#

rubrik-sonar-policy-analyzer-groups-list

Input#

There are no input arguments for this command.

Context Output#

PathTypeDescription
RubrikPolaris.SonarAnalyzerGroup.idStringThe analyzer group ID.
RubrikPolaris.SonarAnalyzerGroup.nameStringThe name of the analyzer group.
RubrikPolaris.SonarAnalyzerGroup.groupTypeStringThe analyzer group type.
RubrikPolaris.SonarAnalyzerGroup.analyzers.idStringThe ID of the analyzers belong to the group.
RubrikPolaris.SonarAnalyzerGroup.analyzers.nameStringThe name of the analyzers belong to the group.
RubrikPolaris.SonarAnalyzerGroup.analyzers.analyzerTypeStringThe type of the analyzers belong to the group.

Command Example#

!rubrik-sonar-policy-analyzer-groups-list

Human Readable Output#

Sonar Policy Analyzer Groups#

IDNameGroup TypeAnalyzers
97c6a54a-acfc-5ab2-a24a-6a7f3a9a1553GLBAGLBAid: ed30dfa0-334f-55ff-a1b7-03b6bdd7849b, Name: Credit Card, Analyzer Type: CREDIT_CARD

id: 3e60a612-3e97-5f03-b3a1-cfb7a6a67e8f, Name: US Bank Acct, Analyzer Type: US_BANK_ACCT

id: 03b3dc9e-81c1-561c-8235-17cf2fc1c729, Name: US ITIN, Analyzer Type: US_ITIN

id: d5ce3ae5-f530-562a-85b1-4a84264a350a, Name: US SSN, Analyzer Type: US_SSN
543dd5e0-c72c-50e2-a3d9-1688343f472cHIPAAHIPAAid: 9da675b3-944b-5da3-a2da-ed149d300075, Name: US/UK Passport, Analyzer Type: PASSPORT

id: 18665533-c28c-5a40-b747-4b6508fecdfa, Name: US NPI, Analyzer Type: US_HEALTHCARE_NPI

id: 03b3dc9e-81c1-561c-8235-17cf2fc1c729, Name: US ITIN, Analyzer Type: US_ITIN

id: d5ce3ae5-f530-562a-85b1-4a84264a350a, Name: US SSN, Analyzer Type: US_SSN

id: 6bcc8e4e-0ec9-5538-b91d-a506dac47ec6, Name: US DEA, Analyzer Type: DEA_NUMBER
16bd3864-bad6-513b-b38d-a108e648cf4aPCI_DSS
c8c8072a-9454-5e68-9a23-bbcb9824838eU.S. FinancialsUS_FINANCEid: bb9a929b-3f29-5d3f-a768-de74e8ee5a9c, Name: n/a, Analyzer Type: CUSIP_NUMBER

rubrik-polaris-vm-object-metadata-get#


Retrieve details for a Vsphere object based on the provided object ID.

Base Command#

rubrik-polaris-vm-object-metadata-get

Input#

Argument NameDescriptionRequired
object_idThe ID of the object to get details.

Note: Users can get the list of the object IDs by executing the "rubrik-polaris-vm-objects-list" command.
Required

Context Output#

PathTypeDescription
RubrikPolaris.VSphereVm.idStringUnique ID of the object.
RubrikPolaris.VSphereVm.metadata.authorizedOperationsUnknownList of operations performed by the object.
RubrikPolaris.VSphereVm.metadata.nameStringThe name of the object.
RubrikPolaris.VSphereVm.metadata.isRelicBooleanWhether the object is relic or not.
RubrikPolaris.VSphereVm.metadata.effectiveSlaDomain.idStringID of the SLA domain.
RubrikPolaris.VSphereVm.metadata.effectiveSlaDomain.nameStringName of the SLA domain.
RubrikPolaris.VSphereVm.metadata.effectiveSlaDomain.cluster.idStringID of the cluster of the SLA domain.
RubrikPolaris.VSphereVm.metadata.effectiveSlaDomain.cluster.nameStringName of the cluster of the SLA domain.
RubrikPolaris.VSphereVm.metadata.effectiveSlaSourceObject.fidStringSLA Source object FID.
RubrikPolaris.VSphereVm.metadata.effectiveSlaSourceObject.nameStringSLA source object name.
RubrikPolaris.VSphereVm.metadata.effectiveSlaSourceObject.objectTypeStringSLA source object type.
RubrikPolaris.VSphereVm.metadata.protectionDateStringProtection date of the object.
RubrikPolaris.VSphereVm.metadata.reportSnappable.idStringThe ID of the snappable for a particular report related to an object. Snappable supports backups or filesets of physical machines using the rubrik connector.
RubrikPolaris.VSphereVm.metadata.reportSnappable.logicalBytesNumberLogical bytes of snappable report.
RubrikPolaris.VSphereVm.metadata.reportSnappable.physicalBytesNumberThe physical byte of the snappable for a particular report related to an object.
RubrikPolaris.VSphereVm.metadata.reportSnappable.archiveStorageNumberThe archived storage of the snappable for a particular report related to an object.
RubrikPolaris.VSphereVm.metadata.cluster.idStringUnique ID of the cluster which is the datastore for the recovered virtual machine.
RubrikPolaris.VSphereVm.metadata.cluster.nameStringCluster name of the VM to which the object belongs.
RubrikPolaris.VSphereVm.metadata.cluster.statusStringCluster status of the VM to which the object belongs.
RubrikPolaris.VSphereVm.metadata.cluster.versionStringCluster version of the VM to which the object belongs.
RubrikPolaris.VSphereVm.metadata.cluster.lastConnectionTimeStringLast time when the vm was connected to the cluster.
RubrikPolaris.VSphereVm.metadata.cluster.defaultAddressStringDefault address where the cluster is stored.
RubrikPolaris.VSphereVm.metadata.cluster.clusterNodeConnection.nodes.idStringNode ID of the node connection related to cluster.
RubrikPolaris.VSphereVm.metadata.cluster.clusterNodeConnection.nodes.statusStringNode status of the node connection related to cluster.
RubrikPolaris.VSphereVm.metadata.cluster.clusterNodeConnection.nodes.ipAddressStringIP address of the node connection related to cluster.
RubrikPolaris.VSphereVm.metadata.cluster.state.connectedStateStringConnected state of the cluster.
RubrikPolaris.VSphereVm.metadata.cluster.state.clusterRemovalStateStringState of the cluster if it is registered for removal or not.
RubrikPolaris.VSphereVm.metadata.cluster.passesConnectivityCheckBooleanWhether the cluster passes connectivity check or not.
RubrikPolaris.VSphereVm.metadata.cluster.globalManagerConnectivityStatus.urls.urlStringURL of Global Manager Connectivity Status.
RubrikPolaris.VSphereVm.metadata.cluster.globalManagerConnectivityStatus.urls.isReachableBooleanWhether the url in global Manager Connectivity Status is reachable or not.
RubrikPolaris.VSphereVm.metadata.cluster.connectivityLastUpdatedStringDate time when the connectivity status of the cluster is lastly updated.
RubrikPolaris.VSphereVm.metadata.primaryClusterLocation.idStringThe location ID of the primary cluster to which the object belongs.
RubrikPolaris.VSphereVm.metadata.primaryClusterLocation.nameStringThe location name of the primary cluster to which the object belongs.
RubrikPolaris.VSphereVm.metadata.arrayIntegrationEnabledBooleanWhether the array integration is enabled or not.
RubrikPolaris.VSphereVm.metadata.snapshotConsistencyMandateStringData consistency in recovery points is the snapshot consistency mandate. It is broadly classified into 3 categories: inconsistent, crash-consistent, app-consistent.
RubrikPolaris.VSphereVm.metadata.agentStatus.agentStatusStringThe status of an agent related to an object. In Rubrik agents are connectors also known as Rubrik Backup Service.
RubrikPolaris.VSphereVm.metadata.logicalPath.fidStringThe logical path ID of the node to which the object belongs.
RubrikPolaris.VSphereVm.metadata.logicalPath.objectTypeStringThe logical object type of the node to which the object belongs.
RubrikPolaris.VSphereVm.metadata.logicalPath.nameStringThe logical name of the node to which the object belongs.
RubrikPolaris.VSphereVm.metadata.physicalPath.fidStringThe physical path of where the VM resides.
RubrikPolaris.VSphereVm.metadata.physicalPath.objectTypeStringThe physical path object type of the VM.
RubrikPolaris.VSphereVm.metadata.physicalPath.nameStringThe physical Name of the VM.
RubrikPolaris.VSphereVm.metadata.vsphereTagPath.fidStringFID of Vsphere tag.
RubrikPolaris.VSphereVm.metadata.vsphereTagPath.objectTypeStringObject type of Vsphere tag.
RubrikPolaris.VSphereVm.metadata.vphereTagPath.nameStringName of Vsphere tag.
RubrikPolaris.VSphereVm.metadata.oldestSnapshot.idStringThe ID of the oldest snapshot.
RubrikPolaris.VSphereVm.metadata.oldestSnapshot.dateStringThe date when the oldest snapshot was generated.
RubrikPolaris.VSphereVm.metadata.oldestSnapshot.isIndexedBooleanWhether the oldest snapshot is indexed or not.
RubrikPolaris.VSphereVm.metadata.totalSnapshots.countNumberTotal snapshot counts.
RubrikPolaris.VSphereVm.metadata.replicatedObjects.idStringThe ID of the object which is replicated in the VM.
RubrikPolaris.VSphereVm.metadata.replicatedObjects.primaryClusterLocation.idStringThe primary cluster location ID where the replicated object resides.
RubrikPolaris.VSphereVm.metadata.replicatedObjects.primaryClusterLocation.nameStringThe primary cluster location name where the replicated object resides.
RubrikPolaris.VSphereVm.metadata.replicatedObjects.cluster.nameStringThe cluster name where the replicated object resides.
RubrikPolaris.VSphereVm.metadata.replicatedObjects.cluster.idStringThe cluster ID where the replicated object resides.
RubrikPolaris.VSphereVm.metadata.newestArchivedSnapshot.idStringID of the newest archived snapshot.
RubrikPolaris.VSphereVm.metadata.newestArchivedSnapshot.dateStringThe date when the newest archived snapshot was generated.
RubrikPolaris.VSphereVm.metadata.newestArchivedSnapshot.isIndexedBooleanWhether the newest archived snapshot is indexed or not.
RubrikPolaris.VSphereVm.metadata.newestArchivedSnapshot.archivalLocations.idStringID of the archival location of the newest archived snapshot.
RubrikPolaris.VSphereVm.metadata.newestArchivedSnapshot.archivalLocations.nameStringName of the archival location of the newest archival snapshot.
RubrikPolaris.VSphereVm.metadata.newestReplicatedSnapshot.idStringThe ID of the newest replicated snapshot.
RubrikPolaris.VSphereVm.metadata.newestReplicatedSnapshot.dateStringThe date when the newest replicated snapshot was generated.
RubrikPolaris.VSphereVm.metadata.newestReplicatedSnapshot.isIndexedBooleanWhether the newest replicated snapshot is indexed or not.
RubrikPolaris.VSphereVm.metadata.newestReplicatedSnapshot.replicationLocations.idStringThe ID of the replication locations of the newest replicated snapshot.
RubrikPolaris.VSphereVm.metadata.newestReplicatedSnapshot.replicationLocations.nameStringThe name of the replication locations of the newest replicated snapshot.
RubrikPolaris.VSphereVm.metadata.newestSnapshot.idStringThe ID of the newest snapshot.
RubrikPolaris.VSphereVm.metadata.newestSnapshot.dateStringThe date when the newest snapshot was generated.
RubrikPolaris.VSphereVm.metadata.newestSnapshot.isIndexedBooleanWhether the newest snapshot is indexed or not.
RubrikPolaris.VSphereVm.metadata.onDemandSnapshotCountNumberCount of how many on demand snapshot created in a VM.
RubrikPolaris.VSphereVm.metadata.vmwareToolsInstalledBooleanWhether the Vmware tools are installed or not.
RubrikPolaris.VSphereVm.metadata.cdmLinkStringThe Cloud Data Management link to navigate to the VM on cloud.

Command Example#

!rubrik-polaris-vm-object-metadata-get object_id="e060116b-f9dc-56a1-82a6-1b968d2f6cef"

Human Readable Output#

VM Object Data#

Object IDNameSnappable IDSLA DomainCluster NameTotal SnapshotsOldest Snapshot DateLatest Snapshot Date
e060116b-f9dc-56a1-82a6-1b968d2f6cefKali-VMVirtualMachine:::ae4484c6-b4c0-4ce8-b2ba-206a4184540b-vm-521DO_NOT_PROTECTsand2-rbk01422019-04-24T16:21:12.000Z2020-02-12T14:00:36.000Z

rubrik-polaris-vm-objects-list#


Retrieve a list of all the objects of the Vsphere Vm known to the Rubrik.

Base Command#

rubrik-polaris-vm-objects-list

Input#

Argument NameDescriptionRequired
is_relicFilter based on whether VM objects are moved to relic/archive or not.

Possible values are: "True", "False".
Optional
is_replicatedFilter based on whether VM objects are replicated or not.

Possible values are: "True", "False".
Optional
limitNumber of results to retrieve in the response. Maximum size allowed is 1000. Default is 50.Optional
sort_bySpecify the field to use for sorting the response.

Note: Supported values are "ID" and "NAME" only. For any other values, the obtained result is sorted or not is not confirmed. Default is ID.
Optional
sort_orderSpecify the order to sort the data in.

Possible values are: "ASC", "DESC". Default is ASC.
Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional

Context Output#

PathTypeDescription
RubrikPolaris.VSphereVm.idStringUnique ID of the object.
RubrikPolaris.VSphereVm.nameStringName of the node to which the object belongs.
RubrikPolaris.VSphereVm.objectTypeStringObject type of the node to which the object belongs.
RubrikPolaris.VSphereVm.replicatedObjectCountNumberNumber of objects replicated in the node in which the object relies.
RubrikPolaris.VSphereVm.cluster.idStringID of the cluster which is the datastore for the recovered virtual machine.
RubrikPolaris.VSphereVm.cluster.nameStringCluster name of the node to which the object belongs.
RubrikPolaris.VSphereVm.cluster.versionStringCluster version of the node to which the object belongs.
RubrikPolaris.VSphereVm.cluster.statusStringCluster status of the node to which the object belongs.
RubrikPolaris.VSphereVm.effectiveSlaDomain.idStringID of the SLA domain which is simply a set of policies that define at what frequencies backups should be performed of the protected objects within Rubrik and for how long they should be either locally or a replication partner or on the archival location.
RubrikPolaris.VSphereVm.effectiveSlaDomain.nameStringDescriptive name of the SLA domain.
RubrikPolaris.VSphereVm.effectiveSlaDomain.descriptionStringDescription of the SLA domain.
RubrikPolaris.VSphereVm.effectiveSlaDomain.fidStringFID of the SLA domain.
RubrikPolaris.VSphereVm.effectiveSlaDomain.cluster.idStringID of the cluster related to the effective SLA domain.
RubrikPolaris.VSphereVm.effectiveSlaDomain.cluster.nameStringName of the cluster related to the effective SLA domain.
RubrikPolaris.VSphereVm.effectiveSlaSourceObject.fidStringSLA source object FID.
RubrikPolaris.VSphereVm.effectiveSlaSourceObject.nameStringSLA source object name.
RubrikPolaris.VSphereVm.effectiveSlaSourceObject.objectTypeStringSLA source object type.
RubrikPolaris.VSphereVm.slaAssignmentStringA SLA rule when referred at assignment is SLA assignment.
RubrikPolaris.VSphereVm.isRelicBooleanWhether the object is relic or not.
RubrikPolaris.VSphereVm.authorizedOperationsUnknownList of operations that can be performed on the object.
RubrikPolaris.VSphereVm.primaryClusterLocation.idStringThe location ID of the primary cluster to which the object belongs.
RubrikPolaris.VSphereVm.primaryClusterLocation.nameStringThe location name of the primary cluster to which the object belongs.
RubrikPolaris.VSphereVm.logicalPath.fidStringThe logical path ID of the node to which the object belongs.
RubrikPolaris.VSphereVm.logicalPath.nameStringThe logical path name of the node to which the object belongs.
RubrikPolaris.VSphereVm.logicalPath.objectTypeStringThe logical object type of the node to which the object belongs.
RubrikPolaris.VSphereVm.snapshotDistribution.idStringRubrik uses a snapshot for powerful data protection. Snapshot distribution ID is the ID of the snapshot distribution node related to a particular object.
RubrikPolaris.VSphereVm.snapshotDistribution.onDemandCountNumberThe demand count of distribution of snapshot related to an object.
RubrikPolaris.VSphereVm.snapshotDistribution.retrievedCountNumberThe retrieved count of distribution of snapshot related to an object.
RubrikPolaris.VSphereVm.snapshotDistribution.scheduledCountNumberThe scheduled count of distribution of snapshot related to an object.
RubrikPolaris.VSphereVm.snapshotDistribution.totalCountNumberThe total count of distribution of snapshot related to an object.
RubrikPolaris.VSphereVm.reportSnappable.idStringThe ID of the snappable for a particular report related to an object. Snapple supports backups or filesets of physical machines using the rubrik connector.
RubrikPolaris.VSphereVm.reportSnappable.archieveStorageNumberThe archived storage of the snappable for a particular report related to an object.
RubrikPolaris.VSphereVm.reportSnappable.physicalBytesNumberThe physical byte of the snappable for a particular report related to an object.
RubrikPolaris.VSphereVm.vmwareToolsInstalledBooleanWhether the vm tools are installed or not.
RubrikPolaris.VSphereVm.agentStatus.agentStatusStringThe status of an agent related to an object. The Rubrik agents are connectors also known as Rubrik Backup Service.
RubrikPolaris.VSphereVm.agentStatus.disconnectReasonStringDisplays the reason if the agent disconnects.
RubrikPolaris.PageToken.VSphereVm.next_page_tokenStringNext page token.
RubrikPolaris.PageToken.VSphereVm.nameStringName of the command.
RubrikPolaris.PageToken.VSphereVm.has_next_pageBooleanWhether the result has the next page or not.

Command Example#

!rubrik-polaris-vm-objects-list limit=2

Human Readable Output#

Objects List#

Object IDNameSnappable IDClusterObject TypeSLA DomainAssignmentSnapshotsRBS StatusSource StorageArchival Storage
0242e84c-773a-5877-b955-1d52765ac852sx1-ganebala-l1VirtualMachine:::868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-206037sand1-rbk01VmwareVirtualMachineDO_NOT_PROTECTDirect0Unregistered00
0556f691-b750-556c-baea-800dbb2920e7linux-a-Fri Feb 15 2019 04:43:40 GMT+0000 (Greenwich Mean Time)-9P4tVirtualMachine:::d2f41f4b-5d53-4063-a618-25046a0f4c7d-vm-35806sand1-rbk01VmwareVirtualMachineUNPROTECTEDUnassigned34Unregistered01.115023609 GB

Note: To retrieve the next set of results use, "next_page_token" = xyz

rubrik-sonar-ondemand-scan#


Trigger an on-demand scan of a system. Supports "Vsphere VM" object type only.

Note: To know the scan status use the "rubrik-sonar-ondemand-scan-status" command. To download the completed request use the "rubrik-sonar-ondemand-scan-result" command.

Base Command#

rubrik-sonar-ondemand-scan

Input#

Argument NameDescriptionRequired
scan_nameName of the scan. If not provided, it defaults to "<today's date> Classification".Optional
sonar_policy_analyzer_groupsList of sonar policies to scan.

Note: Users can get the list of analyzer groups by executing the "rubrik-sonar-policy-analyzer-groups-list" command.

Format Accepted:
[
{
"id": "543dd5e0-c72c-50e2-a3d9-1688343f472c",
"name": "HIPAA",
"groupType": "HIPAA",
"analyzers": [
{
"id": "9da675b3-944b-5da3-a2da-ed149d300075",
"name": "US/UK Passport",
"analyzerType": "PASSPORT"
},
{
"id": "18665533-c28c-5a40-b747-4b6508fecdfa",
"name": "US NPI",
"analyzerType": "US_HEALTHCARE_NPI"
}
]
}
].
Required
objects_to_scanList of VM object IDs to scan.

Note: Users can get the list of VM object IDs by executing the "rubrik-polaris-vm-objects-list" command.
Required

Context Output#

PathTypeDescription
RubrikPolaris.SonarOndemandScan.crawlIdStringUnique crawl ID.

Command Example#

!rubrik-sonar-ondemand-scan scan_name="GLBA Scan for new user" sonar_policy_analyzer_groups='[{"id":"97c6a54a-acfc-5ab2-a24a-6a7f3a9a1553","name":"GLBA","groupType":"GLBA","analyzers":[{"id":"ed30dfa0-334f-55ff-a1b7-03b6bdd7849b","name":"CreditCard","analyzerType":"CREDIT_CARD"},{"id":"3e60a612-3e97-5f03-b3a1-cfb7a6a67e8f","name":"BANK_ACCT","analyzerType":"US_BANK_ACCT"},{"id":"03b3dc9e-81c1-561c-8235-17cf2fc1c729","name":"USITIN","analyzerType":"US_ITIN"},{"id":"d5ce3ae5-f530-562a-85b1-4a84264a350a","name":"USSSN","analyzerType":"US_SSN"}]}]' objects_to_scan="0887e71c-56ac-59f7-8763-54b726e64dd6, a82e888c-2440-5af9-8c2a-447a97f6746c"

Human Readable Output#

Sonar On-Demand Scan#

Crawl ID
bb4eedc0-594b-4566-b06d-24de0bf752ca

rubrik-sonar-ondemand-scan-status#


Retrieve the status of a scanned system.

Note: To download the completed request use the "rubrik-sonar-ondemand-scan-result" command.

Base Command#

rubrik-sonar-ondemand-scan-status

Input#

Argument NameDescriptionRequired
crawl_idID for which scanning status is to be obtained.

Note: Users can get the crawl ID by executing the "rubrik-sonar-ondemand-scan" command.
Required

Context Output#

PathTypeDescription
RubrikPolaris.SonarOndemandScan.crawlIdStringCrawl ID of the scan for which the rubrik-sonar-ondemand-scan command is hit.
RubrikPolaris.SonarOndemandScan.Status.errorStringError description if any.
RubrikPolaris.SonarOndemandScan.Status.snappable.idStringSnappable ID of the scanned object.
RubrikPolaris.SonarOndemandScan.Status.snappable.nameStringSnappable Name of the scanned object.
RubrikPolaris.SonarOndemandScan.Status.snappable.objectTypeStringSnappable object type of the scanned object.
RubrikPolaris.SonarOndemandScan.Status.snapshotTimeNumberTime when the snapshot is taken.
RubrikPolaris.SonarOndemandScan.Status.statusStringStatus of the scanning or scanned object.
RubrikPolaris.SonarOndemandScan.Status.progressNumberCount of objects that are in progress.
RubrikPolaris.SonarOndemandScan.Status.totalHitsNumberNumber of total hits obtained from an object that is scanned.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.analyzerGroup.groupTypeStringGroup type of the analyzer.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.analyzerGroup.idStringGroup ID of the analyzer.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.analyzerGroup.nameStringGroup Name of the analyzer.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.analyzerResults.hits.totalHitsNumberNumber of total hits obtained from an analyzer that is scanned.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.analyzerResults.hits.violationsNumberNumber of violations obtained from an analyzer that is scanned.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.analyzerResults.hits.permittedHitsNumberNumber of permitted hits obtained from an analyzer that is scanned.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.analyzerResults.analyzer.idStringID of the analyzer that is scanned.
RubrikPolaris.SonarOndemandScan.Status.analzerGroupResults.analyzerResults.analyzer.nameStringName of the analyzer that is scanned.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.analyzerResults.analyzer.analyzerTypeStringType of the analyzer that is scanned.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.hits.totalHitsNumberNumber of total hits obtained from an analyzer group.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.hits.violationsNumberNumber of violations obtained from an analyzer group.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.hits.permittedHitsNumberNumber of permitted hits obtained from an analyzer group.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.hits.violationsDeltaNumberNumber of violation delta obtained from an analyzer group.
RubrikPolaris.SonarOndemandScan.Status.analyzerGroupResults.hits.totalHitsDeltaNumberNumber of total hits delta obtained from an analyzer group.
RubrikPolaris.SonarOndemandScan.Status.cluster.idStringCluster ID in which the object is getting scanned.
RubrikPolaris.SonarOndemandScan.Status.cluster.nameStringCluster name in which the object is getting scanned.
RubrikPolaris.SonarOndemandScan.Status.cluster.typeStringCluster type in which the object is getting scanned.

Command Example#

!rubrik-sonar-ondemand-scan-status crawl_id="bb4eedc0-594b-4566-b06d-24de0bf752ca"

Human Readable Output#

Sonar On-Demand Scan Status#

Final status of scan with crawl ID bb4eedc0-594b-4566-b06d-24de0bf752ca is IN_PROGRESS

Object IDObject NameScan Status
6e307121-e5dc-5e6a-9a6b-37e1c9afd6b1AllTheThingsCOMPLETE
a82e888c-2440-5af9-8c2a-447a97f6746c/tmpIN_PROGRESS

rubrik-polaris-vm-object-snapshot-list#


Search for a Rubrik snapshot of an object based on the provided snapshot ID, exact timestamp, or specific value like earliest/latest, or closest before/after a timestamp.

Base Command#

rubrik-polaris-vm-object-snapshot-list

Input#

Argument NameDescriptionRequired
object_idThe object ID for which the snapshots are to be searched.

Note: Users can get the list of the object IDs by executing the "rubrik-polaris-vm-objects-list" command.
Required
snapshot_group_byGrouping the snapshots on the basis of the selected value.

Possible values are: "Month", "Day", "Year", "Week", "Hour", "Quarter". Default is Day.
Optional
missed_snapshot_group_byGrouping the missed snapshots on the basis of the selected value.

Possible values are: "Month", "Day", "Year", "Week", "Hour", "Quarter". Default is Day.
Optional
start_dateThe start date to get snapshots from.

Formats accepted: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ, etc.
Required
end_dateThe end date to get snapshots until.

Formats accepted: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ, etc.
Required
timezone_offsetThe timezone offset from UTC changes to match the configured time zone. Use this argument to filter the data according to the provided timezone offset.

Formats accepted: 1, 1.5, 2, 2.5, 5.5, etc.
Required
cluster_connectedWhether the cluster is connected or not.

Possible values are: "True", "False". Default is True.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.VSphereVm.idStringUnique ID of the object.
RubrikPolaris.VSphereVm.Snapshot.snapshotGroupByConnection.nodes.groupByInfo.unitStringUnit of snapshot group by connection nodes.
RubrikPolaris.VSphereVm.Snapshot.snapshotGroupByConnection.nodes.groupByInfo.startStringStart date of snapshot group by connection nodes.
RubrikPolaris.VSphereVm.Snapshot.snapshotGroupByConnection.nodes.groupByInfo.endStringEnd date of snapshot group by connection nodes.
RubrikPolaris.VSphereVm.Snapshot.snapshotGroupByConnection.nodes.snapshotConnection.countNumberCount of snapshot connections related to the object.
RubrikPolaris.VSphereVm.Snapshot.snapshotGroupByConnection.nodes.snapshotConnection.nodes.idStringID of snapshot connection related to the object.
RubrikPolaris.VSphereVm.Snapshot.snapshotGroupByConnection.nodes.snapshotConnection.nodes.isIndexedBooleanWhether the node is indexed or not.
RubrikPolaris.VSphereVm.Snapshot.snapshotGroupByConnection.nodes.snapshotConnection.nodes.isUnindexableBooleanWhether the node is unindexable or not.

Command Example#

!rubrik-polaris-vm-object-snapshot-list object_id="86db05d1-292f-5973-b616-2ae3977f4428" start_date="2020-05-19T18:30:00.000000Z" end_date="2020-05-20T18:30:00.000000Z" timezone_offset=5.5

Human Readable Output#

VM Object Snapshots#

Snapshot DetailsSnapshot IDs
Total Snapshots: 2
Date Range: From 2020-05-19T22:30:00.000Z to 2020-05-20T22:29:59.999Z
33060f59-9c99-5c48-8305-8d1edfe402d2,
57eac609-9529-5cb5-845a-b7cc78998222

rubrik-sonar-ondemand-scan-result#


Retrieve the download link for the requested scanned file.

Base Command#

rubrik-sonar-ondemand-scan-result

Input#

Argument NameDescriptionRequired
crawl_idID for which file needs to be downloaded.

Note: Users can get the crawl_id by executing the "rubrik-sonar-ondemand-scan" command.
Required
file_typeThe type of the file that needs to be downloaded.

Possible values are: "ANY", "HITS", "STALE", "OPEN_ACCESS", "STALE_HITS", "OPEN_ACCESS_HITS".
Required

Context Output#

PathTypeDescription
RubrikPolaris.SonarOndemandScan.crawlIdStringCrawl ID of the file that needs to be downloaded.
RubrikPolaris.SonarOndemandScan.Result.downloadLinkStringLink to download the file when scan status is complete.

Command Example#

!rubrik-sonar-ondemand-scan-result crawl_id="bb4eedc0-594b-4566-b06d-24de0bf752ca" file_type="HITS"

Human Readable Output#

Sonar On-Demand Scan Result#

Scan result CSV Download Link
Download the CSV file to see the result.

rubrik-radar-anomaly-csv-analysis#


Request for the analysis and retrieve the download link for the Radar CSV analyzed file.

Base Command#

rubrik-radar-anomaly-csv-analysis

Input#

Argument NameDescriptionRequired
cluster_idThe unique ID of the cluster.

Note: Users can retrieve the list of the cluster IDs by executing the "rubrik-gps-cluster-list" command.
Required
snapshot_idThe snapshot ID.

Note: Users can retrieve the list of snapshot IDs by executing the "rubrik-polaris-vm-object-snapshot-list" command.
Required
object_idThe VM object ID.

Note: Users can retrieve the list of object IDs by executing the "rubrik-polaris-vm-objects-list" command.
Required

Context Output#

PathTypeDescription
RubrikPolaris.RadarAnomalyCSV.clusterIdStringCluster ID of the CSV.
RubrikPolaris.RadarAnomalyCSV.snapshotIdStringSnapshot ID of the CSV.
RubrikPolaris.RadarAnomalyCSV.objectIdStringObject ID of the CSV.
RubrikPolaris.RadarAnomalyCSV.investigationCsvDownloadLink.downloadLinkStringThe download link of the CSV analysis.

Command Example#

!rubrik-radar-anomaly-csv-analysis cluster_id="cc19573c-db6c-418a-9d48-067a256543ba" snapshot_id="7b71d588-911c-4165-b6f3-103a1684d2a3" object_id="868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-4335"

Human Readable Output#

Radar Anomaly CSV Analysis#

CSV Download Link
Download the analyzed CSV file.

rubrik-sonar-csv-download#


Request to download the Sonar CSV Snapshot results file.

Note: To know the ID and status of the download, use the "rubrik-user-downloads-list" command. To download the file, use the "rubrik-sonar-csv-result-download" command.

Base Command#

rubrik-sonar-csv-download

Input#

Argument NameDescriptionRequired
snapshot_idID of the snapshot.

Note: Users can retrieve the list of snapshot IDs by executing the "rubrik-polaris-vm-object-snapshot-list" command.
Required
object_idObject ID.

Note: Users can retrieve the list of object IDs by executing "rubrik-polaris-vm-objects-list" command.
Required
file_typeThe type of the file that needs to be downloaded.

Possible values are: "ANY", "HITS", "STALE", "OPEN_ACCESS", "STALE_HITS", "OPEN_ACCESS_HITS".
Optional

Context Output#

PathTypeDescription
RubrikPolaris.SonarCSVDownload.snapshotIdStringSnapshot ID of the CSV requested to download.
RubrikPolaris.SonarCSVDownload.objectIdStringObject ID of the CSV requested to download.
RubrikPolaris.SonarCSVDownload.downloadSnapshotResultsCsv.isSuccessfulBooleanThe status of the download.

Command Example#

!rubrik-sonar-csv-download snapshot_id="c38ec074-0c45-5c72-b611-3322cbd46776" object_id="ac0a6844-a2fc-52b0-bb71-6a55f43677be"

Human Readable Output#

Sonar CSV Download#

Download Status
Success

rubrik-gps-snapshot-files-list#


Retrieve the list of the available files that can be downloaded.

Note: To initiate the file download request use the "rubrik-gps-snapshot-files-download" command.

Base Command#

rubrik-gps-snapshot-files-list

Input#

Argument NameDescriptionRequired
snapshot_idThe Snapshot ID of the file that needs to be downloaded.

Note: Users can retrieve the list of the snapshot IDs by executing the "rubrik-polaris-vm-object-snapshot-list" command.
Required
pathThe path of the folder to list the sub-files. If not provided the root directory files will be returned.

Format accepted : "/<directory name>/<sub directory name or file name>"

Example: "/C:", "/C:/Users".
Optional
search_prefixProvide a keyword to search in the file names.

Example: "admin".
Optional
limitNumber of results to retrieve in the response. Maximum size allowed is 1000. Default is 50.Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSSnapshotFile.snapshotIdStringSnapshot ID provided as an argument to retrieve the files.
RubrikPolaris.GPSSnapshotFile.node.absolutePathStringThe absolute path of the file.
RubrikPolaris.GPSSnapshotFile.node.displayPathStringThe display path of the file.
RubrikPolaris.GPSSnapshotFile.node.pathStringThe path of the file.
RubrikPolaris.GPSSnapshotFile.node.filenameStringThe name of the file.
RubrikPolaris.GPSSnapshotFile.node.fileModeStringThe mode of the file.
RubrikPolaris.GPSSnapshotFile.node.sizeStringThe size of the file.
RubrikPolaris.GPSSnapshotFile.node.lastModifiedStringThe last modified time of the file.
RubrikPolaris.PageToken.GPSSnapshotFile.next_page_tokenStringNext page token.
RubrikPolaris.PageToken.GPSSnapshotFile.nameStringName of the command.
RubrikPolaris.PageToken.GPSSnapshotFile.has_next_pageBooleanWhether the result has the next page or not.

Command Example#

!rubrik-gps-snapshot-files-list snapshot_id=90858c2f-e572-5b9c-b455-ba309d50c1a2

Human Readable Output#

GPS Snapshot Files#

File NameAbsolute PathPathFile ModeLast Modified
C:/C:C:DIRECTORY2020-10-05T18:56:18.000Z
disk_0_part_1/disk_0_part_1DIRECTORY2018-06-14T00:47:18.000Z

Note: To retrieve the next set of results use, "next_page_token" = xyz

rubrik-gps-vm-export#


Request to initiate an export of a snapshot of a virtual machine.

Note: To know about the exported VM's status, use the "rubrik-gps-async-result" command.

Base Command#

rubrik-gps-vm-export

Input#

Argument NameDescriptionRequired
vm_nameName given to the VM that runs the snapshot. If not provided the name will be "<Snapshot VM Name> <MM/DD of snapshot creation> <hh/mm of snapshot creation> <Num>".Optional
object_idThe VM object ID whose snapshot needs to be exported.

Note: Users can get the list of object IDs by executing the "rubrik-polaris-vm-objects-list" command.
Required
snapshot_idThe ID of the snapshot that is to be exported.

Note: Users can get the list of snapshot IDs by executing the "rubrik-polaris-vm-object-snapshot-list" command.
Required
datastore_idThe ID of the datastore which will be used by the new VM.

Note: Users can get the list of datastore IDs by executing the "rubrik-gps-vm-datastore-list" command.
Required
host_idThe ID of the Vsphere ESXi host on which the new VM will be made. Either host_id or host_compute_cluster_id must be provided.

Note: Users can get the list of host IDs by executing the "rubrik-gps-vm-host-list" command.
Optional
host_compute_cluster_idThe ID of the VSphere Compute Cluster of a host. Either host_id or host_compute_cluster_id must be provided.

Note: Users can get the list of Compute Cluster IDs by executing the "rubrik-gps-vm-host-list" command. The ID must belong to the VSphereComputeCluster objectType.
Optional
power_onWhether to turn on the new VM or not.

Possible values are: "True", "False".
Optional
keep_mac_addressesWhether the mac addresses of network devices of the new VM be removed or not.

Possible values are: "True", "False".
Optional
remove_network_devicesWhether the network devices on the original VM be kept or not.

Possible values are: "True", "False".
Optional
recover_tagsWhether to keep vSphere tags associated with the original VM or not.

Possible values are: "True", "False".
Optional
disable_networkWhether to disable networking on the new VM or not.

Possible values are: "True", "False".
Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSVMSnapshotExport.idStringSnapshot export request ID.

Command Example#

!rubrik-gps-vm-export object_id=d39e956f-a3c9-5307-865b-58ed045b59c5 snapshot_id=07fa66e1-137a-5473-8a8e-825547075d7b datastore_id=5fe3a92a-d848-5325-a1a2-ef6cf7a16376 host_compute_cluster_id=0dc88a78-0d46-57d7-86c6-f1bd97ff979f

Human Readable Output#

GPS VM Export#

Snapshot Export Request ID
dummy_id

rubrik-user-downloads-list#


Retrieve the user downloads. This would return the current and past download history.

Note: To download the requested Sonar CSV Snapshot results file use the "rubrik-sonar-csv-result-download" command.

Base Command#

rubrik-user-downloads-list

Input#

There are no input arguments for this command.

Context Output#

PathTypeDescription
RubrikPolaris.UserDownload.idNumberThe ID of the download.
RubrikPolaris.UserDownload.nameStringThe name of the download.
RubrikPolaris.UserDownload.statusStringThe status of the download.
RubrikPolaris.UserDownload.progressNumberThe progress of the download.
RubrikPolaris.UserDownload.identifierStringThe identifier of the download or the type of download requested.
RubrikPolaris.UserDownload.createTimeStringThe creation time of the download.
RubrikPolaris.UserDownload.completeTimeStringThe completion time of the download.

Command Example#

!rubrik-user-downloads-list

Human Readable Output#

User Downloads#

Download IDNameStatusIdentifierCreation TimeCompletion Time
156GDIT-billing-test-oct10COMPLETEDSONAR_DOWNLOAD2021-10-06T07:25:51.676432470Z2021-10-06T07:25:51.856374014Z

rubrik-gps-sla-domain-list#


Enumerates the available SLA Domains to apply to the on-demand snapshot as a retention policy.

Base Command#

rubrik-gps-sla-domain-list

Input#

Argument NameDescriptionRequired
nameName of the SLA Domain to search for.Optional
cluster_idCluster, the SLA domain is managed by.

Note: Users can retrieve the list of the cluster IDs by executing the "rubrik-gps-cluster-list" command.
Optional
object_typeFilters SLA domain based on the provided object types. Supports comma separated values.

Possible values are: "FILESET_OBJECT_TYPE", "VSPHERE_OBJECT_TYPE".
Optional
show_cluster_slas_onlyWhether to show Cluster SLAs and not Global SLAs. "False" value will result in showing only Global SLAs.

Possible values are: "True", "False". Default is True.
Optional
sort_bySpecify the field to use for sorting the response.

Possible values are: "NAME", "PROTECTED_OBJECT_COUNT". Default is NAME.
Optional
sort_orderSpecify the order to sort the data in.

Possible values are: "ASC", "DESC". Default is ASC.
Optional
limitThe number of results to retrieve in the response. Maximum allowed size is 1000. Default is 50.Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSSLADomain.nameStringName of the SLA domain.
RubrikPolaris.GPSSLADomain.idStringID of the SLA domain.
RubrikPolaris.GPSSLADomain.descriptionStringDescription of the SLA domain.
RubrikPolaris.GPSSLADomain.protectedObjectCountNumberNumber of objects under the SLA Domain.
RubrikPolaris.GPSSLADomain.baseFrequency.durationNumberBase snapshot frequency duration.
RubrikPolaris.GPSSLADomain.baseFrequency.unitStringBase snapshot frequency unit (HOURS, DAYS etc).
RubrikPolaris.GPSSLADomain.archivalSpec.archivalLocationNameStringLocation where the archives are stored.
RubrikPolaris.GPSSLADomain.archivalSpecs.storageSetting.idStringID of the archival target.
RubrikPolaris.GPSSLADomain.archivalSpecs.storageSetting.nameStringName of the archival target.
RubrikPolaris.GPSSLADomain.archivalSpecs.storageSetting.groupTypeStringGroup type of the archival target.
RubrikPolaris.GPSSLADomain.archivalSpecs.storageSetting.targetTypeStringTarget type of the archival target.
RubrikPolaris.GPSSLADomain.replicationSpec.replicationTypeStringEnum value representing the type of replication. Values: UNKNOWN_REPLICATION_TYPE, UNIDIRECTIONAL_REPLICATION_TO_CLUSTER, REPLICATION_TO_CLOUD_REGION, REPLICATION_TO_CLOUD_LOCATION.
RubrikPolaris.GPSSLADomain.replicationSpec.specificReplicationSpec.unidirectionalSpec.replicationTargetNameStringCloud replication target name.
RubrikPolaris.GPSSLADomain.replicationSpec.specificReplicationSpec.cloudRegionSpec.replicationTargetRegionStringCloud replication target region.
RubrikPolaris.GPSSLADomain.replicationSpec.specificReplicationSpec.cloudRegionSpec.cloudProviderStringCloud replication service provider. Values: AWS, AZURE.
RubrikPolaris.GPSSLADomain.replicationSpec.specificReplicationSpec.cloudLocationSpec.targetMapping.idStringID of the cloud target where replication takes place.
RubrikPolaris.GPSSLADomain.replicationSpec.specificReplicationSpec.cloudLocationSpec.targetMapping.nameStringName of the cloud target where replication takes place.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.cluster.idStringID of the cluster where replication takes place.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.cluster.nameStringName of the cluster where replication takes place.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.awsTarget.accountIdStringAccount ID on AWS where the replication happens.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.awsTarget.accountNameStringAccount name on AWS where the replication happens.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.awsTarget.regionStringAccount region on AWS where the replication happens.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.azureTarget.regionStringAccount region on Azure where the replication happens.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.retentionDuration.durationNumberReplication retention duration.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.retentionDuration.unitStringReplication retention duration unit.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.targetMapping.idStringID of the object target where replication takes place.
RubrikPolaris.GPSSLADomain.replicationSpecsV2.targetMapping.nameStringName of the object target where replication takes place.
RubrikPolaris.GPSSLADomain.localRetentionLimit.durationNumberLocal retention limit duration.
RubrikPolaris.GPSSLADomain.localRetentionLimit.unitStringLocal retention limit duration unit.
RubrikPolaris.GPSSLADomain.snapshotSchedule.minute.basicSchedule.frequencyNumberSnapshot frequency every minute.
RubrikPolaris.GPSSLADomain.snapshotSchedule.minute.basicSchedule.retentionNumberSnapshot retention value per minute snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.minute.basicSchedule.retentionUnitStringSnapshot retention time unit per minute snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.hourly.basicSchedule.frequencyNumberSnapshot hourly frequency.
RubrikPolaris.GPSSLADomain.snapshotSchedule.hourly.basicSchedule.retentionNumberSnapshot retention value per hour snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.hourly.basicSchedule.retentionUnitStringSnapshot retention time unit per hour snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.daily.basicSchedule.frequencyNumberSnapshot daily frequency.
RubrikPolaris.GPSSLADomain.snapshotSchedule.daily.basicSchedule.retentionNumberSnapshot retention value per day snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.daily.basicSchedule.retentionUnitStringSnapshot retention unit per day snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.weekly.basicSchedule.frequencyNumberSnapshot weekly frequency.
RubrikPolaris.GPSSLADomain.snapshotSchedule.weekly.basicSchedule.retentionNumberSnapshot retention value per week snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.weekly.basicSchedule.retentionUnitStringSnapshot retention unit per week snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.weekly.dayOfWeekStringStarting day of the weekly snapshot.
RubrikPolaris.GPSSLADomain.snapshotSchedule.monthly.basicSchedule.frequencyNumberSnapshot monthly frequency.
RubrikPolaris.GPSSLADomain.snapshotSchedule.monthly.basicSchedule.retentionNumberSnapshot retention value per month snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.monthly.basicSchedule.retentionUnitStringSnapshot retention unit per month snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.monthly.dayOfMonthStringStarting day of the month snapshot.
RubrikPolaris.GPSSLADomain.snapshotSchedule.quarterly.basicSchedule.frequencyNumberSnapshot quarterly frequency.
RubrikPolaris.GPSSLADomain.snapshotSchedule.quarterly.basicSchedule.retentionNumberSnapshot retention value per quarter snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.quarterly.basicSchedule.retentionUnitStringSnapshot retention unit per quarter snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.quarterly.dayOfQuarterStringStarting day of the quarterly snapshot.
RubrikPolaris.GPSSLADomain.snapshotSchedule.quarterly.quarterStartMonthStringStarting month of the quarterly snapshot.
RubrikPolaris.GPSSLADomain.snapshotSchedule.yearly.basicSchedule.frequencyNumberSnapshot yearly frequency.
RubrikPolaris.GPSSLADomain.snapshotSchedule.yearly.basicSchedule.retentionNumberSnapshot retention value per year snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.yearly.basicSchedule.retentionUnitStringSnapshot retention unit per year snapshots.
RubrikPolaris.GPSSLADomain.snapshotSchedule.yearly.dayOfYearStringStarting day of the yearly snapshot.
RubrikPolaris.GPSSLADomain.snapshotSchedule.yearly.yearStartMonthStringStarting month of the yearly snapshot.
RubrikPolaris.GPSSLADomain.objectSpecificConfigs.awsRdsConfig.logRetention.durationNumberDuration of retentioning AWS Relational database logs.
RubrikPolaris.GPSSLADomain.objectSpecificConfigs.awsRdsConfig.logRetention.unitStringUnit of duration of retentioning AWS Relational database logs.
RubrikPolaris.GPSSLADomain.objectSpecificConfigs.sapHanaConfig.incrementalFrequency.durationNumberDuration of retentioning SAP HANA incremental backups.
RubrikPolaris.GPSSLADomain.objectSpecificConfigs.sapHanaConfig.incrementalFrequency.unitStringUnit of duration of retentioning SAP HANA incremental backups.
RubrikPolaris.GPSSLADomain.objectSpecificConfigs.sapHanaConfig.differentialFrequency.durationNumberDuration of retentioning SAP HANA differential backups.
RubrikPolaris.GPSSLADomain.objectSpecificConfigs.sapHanaConfig.differentialFrequency.unitStringUnit of duration of retentioning SAP HANA differential backups.
RubrikPolaris.GPSSLADomain.objectSpecificConfigs.sapHanaConfig.logRetention.durationNumberDuration of retensioning SAP HANA Database logs.
RubrikPolaris.GPSSLADomain.objectSpecificConfigs.sapHanaConfig.logRetention.unitStringUnit of duration of retentioning SAP HANA Database logs.
RubrikPolaris.GPSSLADomain.objectSpecificConfigs.vmwareVmConfig.logRetentionSecondsNumberSeconds of retentioning VMWare virtual machine logs.
RubrikPolaris.GPSSLADomain.objectTypesUnknownList of object types associated with this SLA Domain.
RubrikPolaris.PageToken.GPSSLADomain.next_page_tokenStringNext page token.
RubrikPolaris.PageToken.GPSSLADomain.nameStringName of the command.
RubrikPolaris.PageToken.GPSSLADomain.has_next_pageBooleanWhether the result has the next page or not.

Command Example#

!rubrik-gps-sla-domain-list cluster_id=4d4a41d5-8910-4e4d-9dca-0798f5fc6d61 limit=2

Human Readable Output#

GPS SLA Domains#

SLA Domain IDSLA Domain NameBase FrequencyProtected Object CountArchival LocationDescriptionReplication Target 1Replication Target 2
00000000-0000-0000-0000-000000000002Bronzecd1 Days0AWS S3:bucket-1234Rubrik default Bronze level SLA Domain policysand2-rbk01sand2-rbk02
00000000-0000-0000-0000-000000000000Gold4 Hours0Rubrik default Gold level SLA Domain policysand2-rbk01

Note: To retrieve the next set of results use, "next_page_token" = xyz

rubrik-sonar-csv-result-download#


Retrieve the download link for the requested Sonar CSV Snapshot file.

Base Command#

rubrik-sonar-csv-result-download

Input#

Argument NameDescriptionRequired
download_idThe ID of the download, requested using "rubrik-sonar-csv-download" command.

Note: Users can retrieve the list of downloads containing ID by executing the "rubrik-user-downloads-list" command.
Required

Context Output#

PathTypeDescription
RubrikPolaris.SonarCSVDownload.downloadIdStringThe download ID of the download request.
RubrikPolaris.SonarCSVDownload.getDownloadUrl.urlStringThe link of the file that needs to be downloaded.

Command Example#

!rubrik-sonar-csv-result-download download_id=65

Human Readable Output#

Sonar CSV Result#

Download URL
Download the CSV file to see the result.

rubrik-gps-vm-snapshot-create#


Triggers an on-demand snapshot of a system.

Note: To know about the status of the on-demand snapshot creation, use the "rubrik-gps-async-result" command.

Base Command#

rubrik-gps-vm-snapshot-create

Input#

Argument NameDescriptionRequired
object_idThe ID of the object whose snapshot is to be created.

Note: Users can get the list of object IDs by executing the "rubrik-polaris-vm-objects-list" command.
Required
sla_domain_idThe ID of the SLA domain retention policy to be applied on the object.

Note: Users can get the list of SLA Domain IDs by executing the "rubrik-gps-sla-domain-list" command.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSOndemandSnapshot.idStringID of the requested snapshot.
RubrikPolaris.GPSOndemandSnapshot.statusStringStatus of the requested snapshot.

Command Example#

!rubrik-gps-vm-snapshot-create object_id=ac0a6844-a2fc-52b0-bb71-6a55f43677be

Human Readable Output#

GPS VM Snapshot#

On-Demand Snapshot Request IDStatus
dummy_idQUEUED

rubrik-gps-snapshot-files-download#


Request to download the snapshot file from the backup.

Note: To know about the file information and which file can be downloaded, use the "rubrik-gps-snapshot-files-list" command. To know about the status of the downloadable files, use the "rubrik-gps-async-result" command.

Base Command#

rubrik-gps-snapshot-files-download

Input#

Argument NameDescriptionRequired
snapshot_idThe Snapshot ID of the file that needs to be downloaded.

Note: Users can retrieve the list of the snapshot IDs by executing the "rubrik-polaris-vm-object-snapshot-list" command.
Required
file_pathThe absolute path of the file to be downloaded. A list of files can be downloaded as a zip folder. Multiple file paths can be separated with comma(,).

Note: Users can retrieve the list of the files with absolute path by executing the "rubrik-gps-snapshot-files-list" command.

Format accepted: "/<directory name>/<sub directory name or file name>"

Example: "/C:/PerfLogs/Admin", "/C:/Windows/Microsoft.NET".
Required

Context Output#

PathTypeDescription
RubrikPolaris.GPSSnapshotFileDownload.idStringThe ID of the download.
RubrikPolaris.GPSSnapshotFileDownload.statusStringStatus of the download.
RubrikPolaris.GPSSnapshotFileDownload.links.hrefStringLink of the download.
RubrikPolaris.GPSSnapshotFileDownload.links.relStringRelationship of the download.

Command Example#

!rubrik-gps-snapshot-files-download snapshot_id=3765b5b5-827b-5588-8c34-5cb737a28685 file_path="/.autorelabel"

Human Readable Output#

Snapshot File Request ID#

IDStatus
dummy_idQUEUED

rubrik-gps-vm-livemount#


Performs a live mount of a virtual machine snapshot.

Note: To know about the live mount status, use the "rubrik-gps-async-result" command.

Base Command#

rubrik-gps-vm-livemount

Input#

Argument NameDescriptionRequired
snapshot_idThe ID of the snapshot that is to be mounted.

Note: Users can get the snapshot ID by executing the "rubrik-polaris-vm-object-snapshot-list" command.
Required
host_idThe ID of the Vsphere ESXi host on which the new VM will be mounted.

Note: Users can get the list of host IDs by executing the "rubrik-gps-vm-host-list" command.
Optional
vm_nameName given to the VM that runs the snapshot. If not provided the name will be "<Snapshot VM Name> <MM/DD of snapshot creation> <hh/mm of snapshot creation> <Num>".Optional
power_onWhether to power on the mount or not.

Possible values are: "True", "False". Default is True.
Optional
keep_mac_addressesWhether the mac addresses of network devices be removed or not.

Possible values are: "True", "False". Default is False.
Optional
remove_network_devicesWhether the network devices of the original VM be kept.

Possible values are: "True", "False". Default is False.
Optional
disable_networkWhether to disable networking on the mount or not.

Possible values are: "True", "False".
Optional
recover_tagsWhether to keep vSphere tags associated with the VM or not.

Possible values are: "True", "False". Default is True.
Optional
datastore_nameThe name of the datastore that the live mount uses.

Note: Users can get the datastore name by executing the "rubrik-gps-vm-datastore-list" command.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSVMLiveMount.idStringID of the Live mount request.

Command Example#

!rubrik-gps-vm-livemount snapshot_id=d680b484-0084-5231-a05d-18e9cd5402fc vm_name=live-mount-demo

Human Readable Output#

GPS VM Livemount#

VM Live Mount Request ID
dummy_id

rubrik-gps-vm-host-list#


Retrieve the list of available Vsphere Hosts.

Base Command#

rubrik-gps-vm-host-list

Input#

Argument NameDescriptionRequired
nameThe name of the host to search for.Optional
cluster_idTo list hosts from the specific cluster.

Note: Users can retrieve the list of the cluster IDs by executing the "rubrik-gps-cluster-list" command.
Optional
limitNumber of results to retrieve in the response. Maximum size allowed is 1000. Default is 50.Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional
sort_bySpecify the field to use for sorting the response.

Note: Supported values are "ID" and "NAME" only. For any other values, the obtained result is sorted or not is not confirmed. Default is ID.
Optional
sort_orderSpecify the order to sort the data in.

Possible values are: "ASC", "DESC". Default is ASC.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSVMHost.idStringID of the Vsphere host.
RubrikPolaris.GPSVMHost.nameStringName of the Vsphere host.
RubrikPolaris.GPSVMHost.physicalPath.fidStringID of a physical path of a node.
RubrikPolaris.GPSVMHost.physicalPath.nameStringName of a physical path of a node.
RubrikPolaris.GPSVMHost.physicalPath.objectTypeStringType of a physical path of a node, for example, VSphereComputeCluster, VSphereDatacenter etc.
RubrikPolaris.PageToken.GPSVMHost.next_page_tokenStringNext page token.
RubrikPolaris.PageToken.GPSVMHost.nameStringName of the command.
RubrikPolaris.PageToken.GPSVMHost.has_next_pageBooleanWhether the result has the next page or not.

Command Example#

!rubrik-gps-vm-host-list

Human Readable Output#

GPS VM Hosts#

VSphere Host IDNamePhysical Host
f57bfebf-c7c9-5310-a5fd-1f0aeea5ba25sjc-40302-sand1-esx02.rubrikdemo.com{'id': '72480b29-0eaa-57a9-8c5c-45b7e1c2c826', 'name': 'Sandbox-1 SJC Cluster', 'objectType': 'VSphereComputeCluster'},
{'id': '3f3a92de-c7f3-57f7-989f-3731db83aeab', 'name': 'Sandbox-1 Datacenter', 'objectType': 'VSphereDatacenter'},
{'id': '415859e2-fd22-53ea-8de1-041d99298fe3', 'name': 'sand1-vcsa.rubrikdemo.com', 'objectType': 'VSphereVCenter'}

rubrik-gps-vm-datastore-list#


Retrieve the list of the available datastores on a Vsphere Host.

Base Command#

rubrik-gps-vm-datastore-list

Input#

Argument NameDescriptionRequired
nameThe name of the datastore to search for.Optional
host_idThe ID of a Vsphere host whose datastores are to be listed.

Note: Users can get the list of host IDs by executing the "rubrik-gps-vm-host-list" command.
Required
limitNumber of results to retrieve in the response. Maximum size allowed is 1000. Default is 50.Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional
sort_bySpecify the field to use for sorting the response.

Note: Supported values are "ID" and "NAME" only. For any other values, the obtained result is sorted or not is not confirmed. Default is ID.
Optional
sort_orderSpecify the order to sort the data in.

Possible values are: "ASC", "DESC". Default is ASC.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSVMHost.idStringID of the Vsphere host.
RubrikPolaris.GPSVMHost.Datastore.idStringID of the Vsphere datastore.
RubrikPolaris.GPSVMHost.Datastore.nameStringName of the Vsphere datastore.
RubrikPolaris.GPSVMHost.Datastore.capacityNumberDatastore capacity in bytes.
RubrikPolaris.GPSVMHost.Datastore.isLocalBooleanWhether the datastore is local or remote.
RubrikPolaris.GPSVMHost.Datastore.freeSpaceNumberFree space on the datastore in bytes.
RubrikPolaris.GPSVMHost.Datastore.datastoreTypeStringType of datastore, for example, "NFS", "VMFS" etc.
RubrikPolaris.PageToken.GPSVMHost.Datastore.next_page_tokenStringNext page token.
RubrikPolaris.PageToken.GPSVMHost.Datastore.nameStringName of the command.
RubrikPolaris.PageToken.GPSVMHost.Datastore.has_next_pageBooleanWhether the result has the next page or not.

Command Example#

!rubrik-gps-vm-datastore-list

Human Readable Output#

GPS VM Datastores#

VSphere Datastore IDNameCapacityFree SpaceDatastore Type
dummy_datastore_iddummy-repo0.53362190336 TB0.188318314496 TBNFS

rubrik-event-list#


Retrieve the list of events.

Base Command#

rubrik-event-list

Input#

Argument NameDescriptionRequired
activity_statusFilter the events based on the provided activity statuses. Supports comma separated values.

Possible values are: "TaskFailure", "Canceling", "TaskSuccess", "Info", "Failure", "Running", "Queued", "Warning", "Canceled", "Success".
Optional
activity_typeFilter the events based on provided activity types. Supports comma separated values.

Possible values are: "Sync", "LocalRecovery", "TestFailover", "Anomaly", "RadarAnalysis", "Archive", "VolumeGroup", "VCenter", "Index", "CloudNativeVirtualMachine", "StormResource", "HostEvent", "Recovery", "Conversion", "CloudNativeVm", "EmbeddedEvent", "Maintenance", "Failover", "AuthDomain", "LegalHold", "Vcd", "Instantiate", "Configuration", "Fileset", "Discovery", "System", "Hdfs", "Classification", "StorageArray", "Storage", "Backup", "Hardware", "HypervServer", "HypervScvmm", "Diagnostic", "UnknownEventType", "Upgrade", "NutanixCluster", "Replication", "AwsEvent", "Support", "CloudNativeSource", "Download", "Connection", "ResourceOperations".
Optional
severityFilter the events based on provided severities. Supports comma separated values.

Possible values are: "Critical", "Warning", "Info".
Optional
object_nameFilter out events based on object name.

Note: Users can get the object names by executing the "rubrik-polaris-vm-objects-list" or "rubrik-polaris-object-search" command.
Optional
object_typeFilter the events based on provided object types. Supports comma separated values.

Possible values are: "ShareFileset", "NutanixVm", "VolumeGroup", "HypervVm", "LinuxFileset", "WindowsFileset", "VmwareVm", "ManagedVolume", "CASSANDRA_KEYSPACE", "KuprNamespace", "O365Group", "StorageLocation", "AwsNativeEbsVolume", "O365Mailbox", "JobInstance", "Storm", "Ldap", "Db2Database", "AwsEventType", "AzureNativeVm", "Db2Instance", "SmbDomain", "VmwareComputeCluster", "AwsAccount", "SupportBundle", "AwsNativeRdsInstance", "O365Site", "ObjectProtection", "PolarisEc2Instance", "CASSANDRA_SOURCE", "AwsNativeEc2Instance", "PolarisEbsVolume", "CapacityBundle", "DataLocation", "PolarisAccount", "NasHost", "FailoverClusterApp", "OracleHost", "Host", "OracleDb", "CloudNativeVirtualMachine", "WindowsHost", "O365Team", "Certificate", "PublicCloudMachineInstance", "GcpNativeDisk", "AwsNativeAccount", "CloudNativeVm", "Envoy", "LinuxHost", "AuthDomain", "VcdVapp", "Vcd", "SapHanaDb", "ComputeInstance", "AzureNativeDisk", "Mssql", "SlaDomain", "SnapMirrorCloud", "Cluster", "O365Calendar", "O365SharePointDrive", "SapHanaSystem", "Oracle", "O365Onedrive", "Hdfs", "Ec2Instance", "GcpNativeProject", "UnknownObjectType", "SamlSso", "StorageArray", "AzureSqlDatabase", "Vcenter", "HypervServer", "HypervScvmm", "AppBlueprint", "StorageArrayVolumeGroup", "O365SharePointList", "Upgrade", "NutanixCluster", "AzureNativeSubscription", "User", "Exocompute", "KuprCluster", "OracleRac", "AzureSqlManagedInstance", "CASSANDRA_COLUMN_FAMILY", "O365Organization", "GcpNativeGceInstance".
Optional
cluster_idFilter the events based on provided cluster IDs. Supports comma separated values.

Note: Users can get the list of cluster IDs by executing the "rubrik-gps-cluster-list" command.
Optional
start_dateThe start date to fetch updated events from.

Formats accepted: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ, etc.
Optional
end_dateThe end date to fetch updated events until.

Formats accepted: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ, etc.
Optional
limitNumber of results to retrieve in the response. Maximum size allowed is 1000. Default is 50.Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional
sort_bySpecify the field to use for sorting the response.

Note: Possible values are: "LastUpdated", "Location", "ObjectType", "ClusterName", "ObjectName", "StartTime", "ActivityType", "Severity", "ActivityStatus". Default is LastUpdated.
Optional
sort_orderSpecify the order to sort the data in.

Possible values are: "Asc", "Desc". Default is Desc.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.Event.idNumberID of the event.
RubrikPolaris.Event.startTimeStringStart time of the event.
RubrikPolaris.Event.fidStringFID of the event.
RubrikPolaris.Event.activitySeriesIdStringActivity Series ID of the event.
RubrikPolaris.Event.lastUpdatedStringDate time when the event was last updated.
RubrikPolaris.Event.lastActivityTypeStringLast Activity Type of the event.
RubrikPolaris.Event.lastActivityStatusStringLast Activity Status of the event.
RubrikPolaris.Event.locationStringLocation of the event.
RubrikPolaris.Event.objectIdStringID of the object.
RubrikPolaris.Event.objectNameStringName of the object.
RubrikPolaris.Event.objectTypeStringType of the object.
RubrikPolaris.Event.severityStringSeverity of the event.
RubrikPolaris.Event.progressStringProgress of the event.
RubrikPolaris.Event.cluster.idStringThe ID of the cluster.
RubrikPolaris.Event.cluster.nameStringThe name of the cluster.
RubrikPolaris.Event.activityConnection.nodes.idStringID of the activity connection.
RubrikPolaris.Event.activityConnection.nodes.messageStringMessage of the activity connection.
RubrikPolaris.Event.activityConnection.nodes.severityStringSeverity of the activity connection.
RubrikPolaris.Event.activityConnection.nodes.timeStringDate time when the activity connection was last updated.
RubrikPolaris.PageToken.Event.next_page_tokenStringNext page token.
RubrikPolaris.PageToken.Event.nameStringName of the command.
RubrikPolaris.PageToken.Event.has_next_pageBooleanWhether the result has the next page or not.

Command Example#

!rubrik-event-list limit=1

Human Readable Output#

Events#

Event IDActivity Series IDCluster IDObject IDObject NameSeverityStart TimeLast UpdatedLast Activity TypeLast Activity Status
7739500422d17c0-737d-44df-98a0-a7fa9f714c0dcc19573c-db6c-418a-9d48-067a256543baFileset:::f2666679-5b94-4116-9cbf-6ab69e575522AllTheThingsInfo2021-10-25T12:15:36.911Z2021-10-25T12:16:10.212ZIndexSuccess

Note: To retrieve the next set of results use, "next_page_token" = xyz

rubrik-polaris-object-list#


Retrieve the list of Rubrik objects, based on the provided filters.

Base Command#

rubrik-polaris-object-list

Input#

Argument NameDescriptionRequired
type_filterFilter the objects based on the provided object types. Supports comma separated values.

Possible values are: "ShareFileset", "NutanixVirtualMachine", "VolumeGroup", "HypervVirtualMachine", "LinuxFileset", "WindowsFileset", "VmwareVirtualMachine", "FilesetTemplate", "VcdOrgVdc", "ManagedVolume", "KuprNamespace", "O365Group", "AwsNativeEbsVolume", "OracleDatabase", "O365Mailbox", "AzureNativeResourceGroup", "AZURE_SQL_MANAGED_INSTANCE_DB", "Db2Database", "AzureNativeVm", "VcdOrg", "Db2Instance", "PhysicalHost", "AwsNativeRdsInstance", "CassandraKeyspace", "AzureSqlManagedInstanceServer", "O365Site", "PolarisEc2Instance", "O365User", "AwsNativeEc2Instance", "PolarisEbsVolume", "MssqlInstance", "O365Org", "FailoverClusterApp", "OracleHost", "MongoCollection", "SapHanaDatabase", "AllSubHierarchyType", "NasSystem", "O365Teams", "VSphereFolder", "VSphereResourcePool", "GcpNativeDisk", "AwsNativeAccount", "VSphereDatacenter", "VSphereComputeCluster", "HypervCluster", "CassandraSource", "VSphereTag", "VcdVapp", "NasVolume", "NasNamespace", "Vcd", "VcdVimServer", "AZURE_SQL_DATABASE_DB", "MssqlDatabaseBatchMaintenance", "VcdCatalog", "O365File", "HypervSCVMM", "Blueprint", "AzureSqlDatabaseServer", "FeldsparSite", "CloudNativeTagRule", "Mssql", "HostShare", "SnapMirrorCloud", "O365Calendar", "O365SharePointDrive", "VSphereNetwork", "Fileset", "SapHanaSystem", "MongoSource", "O365Onedrive", "Hdfs", "Ec2Instance", "WindowsCluster", "GcpNativeProject", "VSphereDatastore", "HypervServer", "VSphereHost", "HostFailoverCluster", "AppBlueprint", "MssqlAvailabilityGroup", "CassandraColumnFamily", "GcpNativeGCEInstance", "StorageArrayVolumeGroup", "O365SharePointList", "NutanixCluster", "AzureNativeManagedDisk", "AzureNativeSubscription", "VSPHERE_DATASTORE_CLUSTER", "VSphereVCenter", "NasShare", "KuprCluster", "AppflowsBlueprint", "OracleRac", "MongoDb", "VSphereTagCategory", "WindowsVolumeGroup".
Optional
cluster_idFilter the objects based on the provided cluster IDs. Supports comma separated values.

Note: Users can get the list of cluster IDs by executing the "rubrik-gps-cluster-list" command.
Optional
limitNumber of results to retrieve in the response. Maximum size allowed is 1000. Default is 50.Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional
sort_bySpecify the field to use for sorting the response.

Note: Supported values are "ID" and "NAME" only. For any other values, the obtained result is sorted or not is not confirmed. Default is ID.
Optional
sort_orderSpecify the order to sort the data in.

Possible values are: "ASC", "DESC". Default is ASC.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.Object.idStringID of the object.
RubrikPolaris.Object.effectiveSlaDomain.nameStringName of the SLA domain of the object.
RubrikPolaris.Object.effectiveSlaDomain.idStringID of the SLA domain of the object.
RubrikPolaris.Object.effectiveSlaDomain.descriptionStringDescription of the SLA domain of the object.
RubrikPolaris.Object.effectiveSlaDomain.cluster.idStringCluster ID of effective SLA domain of the object.
RubrikPolaris.Object.effectiveSlaDomain.cluster.nameStringCluster name of effective SLA domain of the object.
RubrikPolaris.Object.effectiveSlaDomain.fidStringFID of effective SLA domain of the object.
RubrikPolaris.Object.isPassthroughBooleanWhether the object is passthrough or not.
RubrikPolaris.Object.cluster.idStringCluster ID of the object.
RubrikPolaris.Object.cluster.nameStringCluster name of the object.
RubrikPolaris.Object.primaryClusterLocation.idStringID of the primary cluster location of the object.
RubrikPolaris.Object.logicalPath.nameStringName of the logical path of the object.
RubrikPolaris.Object.logicalPath.objectTypeStringObject Type of the logical path of the object.
RubrikPolaris.Object.physicalPath.nameStringName of the physical path of the object.
RubrikPolaris.Object.physicalPath.objectTypeStringObject Type of the physical path of the object.
RubrikPolaris.Object.nameStringName of the object.
RubrikPolaris.Object.objectTypeStringType of the object.
RubrikPolaris.PageToken.Object.has_next_pageBooleanWhether the result has the next page or not.
RubrikPolaris.PageToken.Object.nameStringName of the command.
RubrikPolaris.PageToken.Object.next_page_tokenStringNext page token.

Command Example#

!rubrik-polaris-object-list limit=1

Human Readable Output#

Objects#

Object IDObject NameObject TypeLocationCluster NameSLA Domain Name
0014037c-70ae-4c53-b1cf-df6926b88968Christian LeCorreO365UserRubrik Demo\EMEA Users\AMER UsersxUNPROTECTED

Note: To retrieve the next set of results use, "next_page_token" = xyz

rubrik-polaris-object-snapshot-list#


Retrieve Rubrik snapshot(s) of an object, based on the provided object ID.

Base Command#

rubrik-polaris-object-snapshot-list

Input#

Argument NameDescriptionRequired
object_idThe object ID for which the snapshots are to be searched.

Note: Users can get the list of the object IDs by executing the "rubrik-polaris-object-list" command.
Required
start_dateThe start date to get snapshots from.

Formats accepted: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ, etc.

Note: start_date and end_date both or none must be initialized.
Optional
end_dateThe end date to get snapshots until.

Formats accepted: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ, etc.

Note: start_date and end_date both or none must be initialized.
Optional
limitNumber of results to retrieve in the response. Maximum size allowed is 1000. Default is 50.Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional
snapshot_typeList of snapshot types to filter snapshots. Supports comma separated values.

Possible values are: "SCHEDULED", "ON_DEMAND", "DOWNLOADED".
Optional
sort_orderSpecify the order to sort the data in.

Possible values are: "Asc", "Desc". Default is Asc.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.Object.idStringID of the object.
RubrikPolaris.Object.Snapshot.idStringID of the snapshot.
RubrikPolaris.Object.Snapshot.dateStringDate of the snapshot.
RubrikPolaris.Object.Snapshot.isArchivalCopyBooleanWhether the snapshot is an archival copy or not.
RubrikPolaris.Object.Snapshot.isReplicaBooleanWhether the snapshot is a replica or not.
RubrikPolaris.Object.Snapshot.isOnDemandSnapshotBooleanWhether the snapshot is on demand or not.
RubrikPolaris.Object.Snapshot.isDownloadedSnapshotBooleanWhether the snapshot is downloaded or not.
RubrikPolaris.Object.Snapshot.cluster.idStringCluster ID of the snapshot.
RubrikPolaris.Object.Snapshot.cluster.nameStringCluster name of the snapshot.
RubrikPolaris.Object.Snapshot.cluster.versionStringCluster version of the snapshot.
RubrikPolaris.Object.Snapshot.cluster.statusStringCluster status of the snapshot.
RubrikPolaris.Object.Snapshot.slaDomain.nameStringName of the SLA domain of the snapshot.
RubrikPolaris.Object.Snapshot.slaDomain.fidStringFID of the SLA domain of the snapshot.
RubrikPolaris.Object.Snapshot.slaDomain.cluster.idStringCluster ID of the SLA domain of the snapshot.
RubrikPolaris.Object.Snapshot.slaDomain.cluster.nameStringCluster name of the SLA domain of the snapshot.
RubrikPolaris.Object.Snapshot.slaDomain.idStringID of the SLA domain of the snapshot.
RubrikPolaris.Object.Snapshot.snapshotRetentionInfo.archivalInfos.nameStringArchival name of snapshot retention of the snapshot.
RubrikPolaris.Object.Snapshot.snapshotRetentionInfo.archivalInfos.isExpirationDateCalculatedStringWhether archival expiration date of snapshot retention of the snapshot is calculated or not.
RubrikPolaris.Object.Snapshot.snapshotRetentionInfo.archivalInfos.expirationTimeStringArchival expiration time of snapshot retention of the snapshot.
RubrikPolaris.Object.Snapshot.snapshotRetentionInfo.localInfo.nameStringName of snapshot retention of the snapshot.
RubrikPolaris.Object.Snapshot.snapshotRetentionInfo.localInfo.isExpirationDateCalculatedBooleanWhether the expiration date is calculated or not.
RubrikPolaris.Object.Snapshot.snapshotRetentionInfo.localInfo.expirationTimeStringExpiration time of snapshot retention of the snapshot.
RubrikPolaris.PageToken.Object.Snapshot.has_next_pageBooleanWhether the result has the next page or not.
RubrikPolaris.PageToken.Object.Snapshot.nameStringName of the command.
RubrikPolaris.PageToken.Object.Snapshot.next_page_tokenStringNext Page Token.

Command Example#

!rubrik-polaris-object-snapshot-list object_id=06515737-388a-57aa-9c8e-54b3f1ee5d8b limit=1

Human Readable Output#

Object Snapshots#

Snapshot IDCreation DateCluster NameSLA Domain Name
a7adc499-b896-5ad6-bfc2-0aae0ed994592021-10-28T19:35:52.000Zsand2-rbk0112hr-30d-AWS

Note: To retrieve the next set of results use, "next_page_token" = xyz

rubrik-radar-ioc-scan#


Triggers an IOC scan of a system.

Note: To know the results of the scan use the "rubrik-radar-ioc-scan-results" command and to list the running/completed IOC scans on a cluster use the "rubrik-radar-ioc-scan-list" command.

Base Command#

rubrik-radar-ioc-scan

Input#

Argument NameDescriptionRequired
cluster_idID of the cluster on which to perform a scan.

Note: Users can retrieve the list of the cluster IDs by executing the "rubrik-gps-cluster-list" command.
Required
object_idObject ID of the system on which to perform the scan. Supports comma separated values.

Note: Users can get the list of object IDs by executing the "rubrik-polaris-vm-objects-list" command.
Required
scan_nameName of the scan. Default is PAXSOAR-1.1.0.Optional
ioc_typeThe type of the indicator to scan for.

Possible values are: "INDICATOR_OF_COMPROMISE_TYPE_PATH_OR_FILENAME", "INDICATOR_OF_COMPROMISE_TYPE_HASH", "INDICATOR_OF_COMPROMISE_TYPE_YARA_RULE".

Note: To provide multiple IOCs use the argument "advance_ioc".
Optional
ioc_valueValue of the indicator to scan for.

Note: To provide multiple IOCs use the argument "advance_ioc".
Optional
advance_iocJson encoded Indicators Of Compromise to scan. Json keys signify the type of IOC and the corresponding list of values are the values of the IOC's. If provided, will ignore the ioc_type and ioc_value arguments.

Possible keys to indicate type of indicator:
INDICATOR_OF_COMPROMISE_TYPE_PATH_OR_FILENAME, INDICATOR_OF_COMPROMISE_TYPE_HASH, INDICATOR_OF_COMPROMISE_TYPE_YARA_RULE

Format Accepted:
{
"<ioc_type1>": ["<ioc_value1>", "<ioc_value2>"],
"<ioc_type2>": "<ioc_value2>"
}

Example:
{
"INDICATOR_OF_COMPROMISE_TYPE_PATH_OR_FILENAME": ["C:\Users\Malware_Executible.ps1", "\bin\Malware_Executible"],
"INDICATOR_OF_COMPROMISE_TYPE_HASH": ["e5c1b9c44be582f895eaea3d3738c5b4", "f541b9844be897f895eaea3d3738cfb2"],
"INDICATOR_OF_COMPROMISE_TYPE_YARA_RULE": "rule match_everything {condition:true}"
}.
Optional
start_dateFilter the snapshots from the provided date. Any snapshots taken before the provided date-time will be excluded.

Formats accepted: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ, etc.

Examples of more supported values can be found at https://dateparser.readthedocs.io/en/latest/#relative-dates.
Optional
end_dateFilter the snapshots until the provided date. Any snapshots taken after the provided date-time will be excluded.

Formats accepted: 2 minutes, 2 hours, 2 days, 2 weeks, 2 months, 2 years, yyyy-mm-dd, yyyy-mm-ddTHH:MM:SSZ, etc.

Examples of more supported values can be found at https://dateparser.readthedocs.io/en/latest/#relative-dates.
Optional
max_snapshots_per_objectMaximum number of snapshots to scan per object.Optional
snapshot_idProvide comma separated snapshot IDs on which to perform a scan separated by colon for each object ID (in the same order). Supports comma separated values.

Format accepted:
object_1_snapshot_id_1, object_1_snapshot_id_2: object_2_snapshot_id_1

Example:
B405e8c0-1fcd-401c-a6f6-42f758aad6df, e179eb47-534b-4624-b155-f33d188902e2: 1e1681bf-4479-4339-a4bb-59901598caa5

Note: Users can retrieve the list of snapshot IDs by executing the "rubrik-polaris-vm-object-snapshot-list" command.

Note: Do not provide "snapshot_start_date", "snapshot_end_date" and, "max_snapshots_per_object" arguments if snapshot ID is provided.
Optional
paths_to_includePaths to include in the scan. Supports comma separated values.

Format accepted:
path_to_include_1, path_to_include_2.
Optional
paths_to_excludePaths to exclude from the scan. Supports comma separated values.

Format accepted:
path_to_exclude_1, path_to_exclude_2.
Optional
paths_to_exemptPaths to exempt from exclusion. Supports comma separated values.

Format accepted:
path_to_exempt_1, path_to_exempt_2.
Optional
requested_hash_typesThe type of hash values of the matched files to return in the result. Supports comma separated values.

Possible values are: "HASH_TYPE_M_D5", "HASH_TYPE_SH_A1", "HASH_TYPE_SH_A256".
Optional

Context Output#

PathTypeDescription
RubrikPolaris.RadarIOCScan.idStringID of the IOC scan.
RubrikPolaris.RadarIOCScan.statusStringStatus of the IOC scan trigger request.

Command Example#

!rubrik-radar-ioc-scan scan_name="Revil Ransomware Scan" ioc_type="INDICATOR_OF_COMPROMISE_TYPE_PATH_OR_FILENAME" ioc_value="revil.exe" cluster_id="052bf7af-93a3-44e9-a7d7-bc8dad4d6b43" object_id="868aa03d-4145-4cb1-808b-e10c4f7a3741"

Human Readable Output#

Radar IOC Scan#

Scan IDStatus
dummy-ioc-idRUNNING

rubrik-radar-ioc-scan-results#


Retrieves the results of IOC scan of a system.

Note: To initiate a scan use the "rubrik-radar-ioc-scan" command and to list the running/completed scans on a cluster use the "rubrik-radar-ioc-scan-list" command.

Base Command#

rubrik-radar-ioc-scan-results

Input#

Argument NameDescriptionRequired
scan_idID of the IOC scan whose results are to be retrieved.

Note: Users can get the scan ID by executing the "rubrik-radar-ioc-scan" command.
Required
cluster_idID of the cluster on which the scan was performed.

Note: Users can retrieve the list of the cluster IDs by executing the "rubrik-gps-cluster-list" command.
Required

Context Output#

PathTypeDescription
RubrikPolaris.RadarIOCScan.idStringID of the IOC scan.
RubrikPolaris.RadarIOCScan.statusStringOverall status of the scan.
RubrikPolaris.RadarIOCScan.indicatorsOfCompromise.iocTypeStringType of IOC that was scanned.
RubrikPolaris.RadarIOCScan.indicatorsOfCompromise.iocValueStringValue of the IOC that was scanned.
RubrikPolaris.RadarIOCScan.results.objectIdStringID of the system that was scanned.
RubrikPolaris.RadarIOCScan.results.snapshotResults.statusStringStatus of the scan on the snapshot. Values: MALWARE_SCAN_IN_SNAPSHOT_STATUS_PENDING, MALWARE_SCAN_IN_SNAPSHOT_STATUS_FINISHED, MALWARE_SCAN_IN_SNAPSHOT_STATUS_ERROR.
RubrikPolaris.RadarIOCScan.results.snapshotResults.snapshotDateStringThe date-time at which the snapshot was taken.
RubrikPolaris.RadarIOCScan.results.snapshotResults.snapshotIdStringID of the snapshot that was scanned.
RubrikPolaris.RadarIOCScan.results.snapshotResults.scanStats.numFilesNumberNumber of files encountered during scan.
RubrikPolaris.RadarIOCScan.results.snapshotResults.scanStats.numFilesScannedNumberNumber of files that were scanned on that snapshot.
RubrikPolaris.RadarIOCScan.results.snapshotResults.scanStats.totalFilesScannedSizeBytesNumberThe total file size of the files scanned.
RubrikPolaris.RadarIOCScan.results.snapshotResults.matches.indicatorIndexNumberIndex of indicator in inputs for the scan.
RubrikPolaris.RadarIOCScan.results.snapshotResults.matches.paths.aclDetailsStringJSON encoded file access control list (ACL) information.
RubrikPolaris.RadarIOCScan.results.snapshotResults.matches.paths.creationTimeStringFile creation date-time.
RubrikPolaris.RadarIOCScan.results.snapshotResults.matches.paths.modificationTimeStringFile modification date-time.
RubrikPolaris.RadarIOCScan.results.snapshotResults.matches.paths.pathStringFile path that matched the malware Indicator Of Compromise.
RubrikPolaris.RadarIOCScan.results.snapshotResults.matches.paths.yaraMatchDetails.nameStringThe name of the matching YARA rule.
RubrikPolaris.RadarIOCScan.results.snapshotResults.matches.paths.yaraMatchDetails.tagsUnknownOptional YARA tags. Described in https://yara.readthedocs.io/en/latest/writingrules.html\#rule-tags.
RubrikPolaris.RadarIOCScan.results.snapshotResults.matches.paths.requestedHashDetails.hashTypeStringHash algorithm type.
RubrikPolaris.RadarIOCScan.results.snapshotResults.matches.paths.requestedHashDetails.hashValueStringHash value of the content at path.

Command Example#

!rubrik-radar-ioc-scan-results scan_id="bf687fcf-84d7-47f6-8bd1-54e8cf439680" cluster_id="052bf7af-93a3-44e9-a7d7-bc8dad4d6b43"

Human Readable Output#

Radar IOC Scan Results#

Scan ID: bf687fcf-84d7-47f6-8bd1-54e8cf439680 Status: FINISHED

Snapshot IDSnapshot DateObject IDSnapshot Scan StatusScan StatisticsMatches
b7d6b871-796e-4e7c-99cf-328007c9d5c12021-10-29T07:03:30.669ZVirtualMachine:::868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-81407MALWARE_SCAN_IN_SNAPSHOT_STATUS_FINISHEDNumber of Files: 142630, Number of Files Scanned: 0, Total Files Scanned In Bytes: 01
3779a895-94bf-437e-b63a-61e73e2159012021-10-28T07:00:09.297ZVirtualMachine:::868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-81407MALWARE_SCAN_IN_SNAPSHOT_STATUS_FINISHEDNumber of Files: 142630, Number of Files Scanned: 0, Total Files Scanned In Bytes: 01
a871683f-f4fa-475f-806c-58f06e6782dc2021-10-26T07:04:07.139ZVirtualMachine:::868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-81407MALWARE_SCAN_IN_SNAPSHOT_STATUS_FINISHEDNumber of Files: 142630, Number of Files Scanned: 0, Total Files Scanned In Bytes: 01
129f22f4-0359-4e7d-aa53-9edf4e33cff12021-10-29T12:01:43.383ZVirtualMachine:::868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-72277MALWARE_SCAN_IN_SNAPSHOT_STATUS_FINISHEDNumber of Files: 142138, Number of Files Scanned: 0, Total Files Scanned In Bytes: 01
b9264942-c71c-4b91-b9a7-74a7ba0f61662021-10-29T08:01:39.388ZVirtualMachine:::868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-72277MALWARE_SCAN_IN_SNAPSHOT_STATUS_FINISHEDNumber of Files: 142138, Number of Files Scanned: 0, Total Files Scanned In Bytes: 01
9f12b533-b740-4fb9-af94-4411b0aee01d2021-10-29T00:01:04.357ZVirtualMachine:::868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-72277MALWARE_SCAN_IN_SNAPSHOT_STATUS_FINISHEDNumber of Files: 142139, Number of Files Scanned: 0, Total Files Scanned In Bytes: 01

rubrik-gps-async-result#


Retrieve the result of an asynchronous request. This command will retrieve the result of requests made by commands "rubrik-gps-snapshot-files-download", "rubrik-gps-vm-livemount", "rubrik-gps-vm-export", "rubrik-gps-vm-snapshot-create", and "rubrik-gps-vm-recover-files".

Base Command#

rubrik-gps-async-result

Input#

Argument NameDescriptionRequired
request_idID of the request.

Note: Users can get the request ID by executing any of the commands that make a request. Possible commands are mentioned in the command description.
Required
cluster_idID of the cluster on which request was made.

Note: Users can retrieve the list of the cluster IDs by executing the "rubrik-gps-cluster-list" command.
Required
cluster_ip_addressIP address of the cluster node to access the download link. Only required to retrieve the results of the command "rubrik-gps-snapshot-files-download".

Note: Users can retrieve the list of the IP addresses by executing the "rubrik-gps-cluster-list" command.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSAsyncResult.idStringThe ID of the request.
RubrikPolaris.GPSAsyncResult.statusStringStatus of the request.
RubrikPolaris.GPSAsyncResult.nodeIdStringID of the node.
RubrikPolaris.GPSAsyncResult.progressNumberProgress of the request in range 0 to 100.
RubrikPolaris.GPSAsyncResult.error.messageStringJSON stringified message object when an error occurs.
RubrikPolaris.GPSAsyncResult.links.hrefStringLink to a resource.
RubrikPolaris.GPSAsyncResult.links.relStringType of the resource pointed by the link.

Command Example#

!rubrik-gps-async-result request_id="EXPORT_VMWARE_SNAPSHOT_6e101218-141f-4101-b334-3c1bf440bfee_466b7d74-0d13-4e54-9a57-2ea4d7b00a0c:::0" cluster_id="052bf7af-93a3-44e9-a7d7-bc8dad4d6b43"

Human Readable Output#

GPS Asynchronous Request Result#

IDStatusNode IDLinks
dummy_idFAILEDcluster:::RVMHM219S004941self

rubrik-gps-cluster-list#


Retrieve the list of the available rubrik clusters.

Base Command#

rubrik-gps-cluster-list

Input#

Argument NameDescriptionRequired
typeFilter out clusters based on their type. Supports comma separated values.

Possible values are: "Cloud", "Robo", "ExoCompute", "OnPrem", "Polaris", "Unknown".
Optional
nameFilter out clusters based on name. Supports comma separated values.Optional
limitNumber of results to retrieve in the response. Maximum size allowed is 1000. Default is 50.Optional
next_page_tokenThe next page cursor to retrieve the next set of results.Optional
sort_bySpecify the field to use for sorting the response.

Possible values are: "ClusterName", "ClusterType", "RegisteredAt", "ESTIMATED_RUNWAY". Default is ClusterName.
Optional
sort_orderSpecify the order to sort the data in.

Possible values are: "Asc", "Desc". Default is Asc.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSCluster.idStringID of the cluster.
RubrikPolaris.GPSCluster.nameStringName of the cluster.
RubrikPolaris.GPSCluster.typeStringType of the cluster. Values are Cloud, Robo, ExoCompute, OnPrem, Unknown, Polaris.
RubrikPolaris.GPSCluster.statusStringStatus of the cluster. Values are Connected, Disconnected, Initializing.
RubrikPolaris.GPSCluster.versionStringVersion of the cluster.
RubrikPolaris.GPSCluster.defaultAddressStringDefault address assigned to the cluster.
RubrikPolaris.GPSCluster.cdmUpgradeInfo.clusterStatus.messageStringMessage about the cluster upgrade/current condition.
RubrikPolaris.GPSCluster.cdmUpgradeInfo.clusterStatus.statusStringUpgrade/current status of the cluster. It provides information like -- upgrading, upgrade scheduled, stable, downloading packages, pre-checks running and many more.
RubrikPolaris.GPSCluster.cdmUpgradeInfo.overallProgressNumberProgress (in percentage) of an upgrade, if running.
RubrikPolaris.GPSCluster.cdmUpgradeInfo.scheduleUpgradeAtStringShows the date-time of a scheduled upgrade.
RubrikPolaris.GPSCluster.cdmUpgradeInfo.downloadedVersionStringThe version that was downloaded but not yet installed.
RubrikPolaris.GPSCluster.cdmUpgradeInfo.versionStringThe current version of the cluster.
RubrikPolaris.GPSCluster.productTypeStringThe product type. Values are CDM, DATOS, POLARIS.
RubrikPolaris.GPSCluster.estimatedRunwayNumberEstimated number of days remaining before additional data storage space is required on the cluster.
RubrikPolaris.GPSCluster.snapshotCountNumberThe total number of snapshots that are taken of different objects in the cluster.
RubrikPolaris.GPSCluster.geoLocation.addressStringGeological address of the cluster.
RubrikPolaris.GPSCluster.lastConnectionTimeStringTime when the cluster was last polled.
RubrikPolaris.GPSCluster.metric.totalCapacityNumberTotal storage capacity of the cluster in Bytes.
RubrikPolaris.GPSCluster.metric.availableCapacityNumberAvailable storage capacity of the cluster in Bytes.
RubrikPolaris.GPSCluster.snappableConnection.countNumberThe number of objects in the cluster whose snapshots can be taken.
RubrikPolaris.GPSCluster.state.connectedStateStringStatus of the cluster. Values are Connected, Disconnected, Initializing.
RubrikPolaris.GPSCluster.state.clusterRemovalStateStringState of the cluster when it is being removed from the platform. Values are DATA_DELETING, WAITING_FOR_DATA_DELETION, UNREGISTERED, FAILED, DISCONNECTING, REGISTERED.
RubrikPolaris.GPSCluster.clusterNodeConnection.nodes.idStringID of a node in a cluster.
RubrikPolaris.GPSCluster.clusterNodeConnection.nodes.statusStringStatus of a node in a cluster.
RubrikPolaris.GPSCluster.clusterNodeConnection.nodes.ipAddressStringIP Address of a node in a cluster.
RubrikPolaris.GPSCluster.passesConnectivityCheckBooleanWhether the cluster passes the connectivity check.
RubrikPolaris.GPSCluster.globalManagerConnectivityStatus.urls.urlStringURL of a global manager of the cluster.
RubrikPolaris.GPSCluster.globalManagerConnectivityStatus.urls.isReachableBooleanWhether the global manager is reachable.
RubrikPolaris.GPSCluster.connectivityLastUpdatedStringThe date-time of when the cluster was last polled for connectivity.
RubrikPolaris.GPSCluster.lambdaFeatureHistory.wasRadarEverEnabledBooleanWhether Polaris Radar was ever enabled on the cluster.
RubrikPolaris.GPSCluster.lambdaFeatureHistory.wasSonarEverEnabledBooleanWhether Polaris Sonar was ever enabled on the cluster.
RubrikPolaris.PageToken.GPSCluster.has_next_pageBooleanWhether the result has the next page or not.
RubrikPolaris.PageToken.GPSCluster.nameStringName of the command.
RubrikPolaris.PageToken.GPSCluster.next_page_tokenStringNext page token.

Command Example#

!rubrik-gps-cluster-list name="sand1"

Human Readable Output#

GPS Clusters#

Cluster IDCluster NameConnection StatusCluster LocationTotal CapacityFree SpaceProtected ObjectsCluster VersionIP Address
cc19573c-db6c-418a-9d48-067a256543basand1-rbk01ConnectedSan Francisco, CA, USA52.605821063168 TB45.484602130432 TB2057.0.0-EA1-14307X.X.X.X, X.X.X.X

rubrik-radar-ioc-scan-list#


Lists the running/completed IOC scans on a cluster.

Note: To know the results of the scan use the "rubrik-radar-ioc-scan-results" command. To initiate a scan use the "rubrik-radar-ioc-scan" command.

Base Command#

rubrik-radar-ioc-scan-list

Input#

Argument NameDescriptionRequired
cluster_idID of the cluster whose IOC scans are to be listed.

Note: Users can retrieve the list of the cluster IDs by executing the "rubrik-gps-cluster-list" command.
Required

Context Output#

PathTypeDescription
RubrikPolaris.RadarIOCScan.idStringID of the IOC scan.
RubrikPolaris.RadarIOCScan.startTimeStringStart time of the scan.
RubrikPolaris.RadarIOCScan.endTimeStringEnd time of the scan.
RubrikPolaris.RadarIOCScan.snapshots.idStringObject ID of the system.
RubrikPolaris.RadarIOCScan.snapshots.snapshotsUnknownList of snapshot IDs that are included in the scan.

Command Example#

!rubrik-radar-ioc-scan-list cluster_id="052bf7af-93a3-44e9-a7d7-bc8dad4d6b43"

Human Readable Output#

Radar IOC Scans#

Scan IDStart TimeEnd TimeScanned Objects
fcac511b-20b4-472d-9b65-9198cff8cd492021-10-12T04:52:08.777ZNot FinishedVirtualMachine:::90da5ffb-432f-4dac-8c73-39260ff5493e-vm-5952003d-f95c-4ae0-bf9b-b5a80b210935
ad435ff1-617b-468a-b5d3-736fa0e278b02021-10-28T06:05:53.059Z2021-10-28T07:16:16.715ZVirtualMachine:::868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-72277, VirtualMachine:::868aa03d-4145-4cb1-808b-e10c4f7a3741-vm-72279

rubrik-gps-vm-recover-files#


Recovers files from a snapshot backup, back into a system.

Note: To know about the recovery status, use the "rubrik-gps-async-result" command.

Base Command#

rubrik-gps-vm-recover-files

Input#

Argument NameDescriptionRequired
cluster_idID of the cluster where the snapshot resides.

Note: Users can get the cluster ID by executing the "rubrik-gps-cluster-list" command.
Required
snapshot_idID of the snapshot from which to recover files.

Note: Users can get the snapshot ID by executing the "rubrik-polaris-vm-object-snapshot-list" command.
Required
paths_to_recoverComma separated paths of files and directories that will be recovered from the snapshot.

Note: Users can get the list of paths in a snapshot by executing the "rubrik-gps-snapshot-files-list" command.
Required
restore_pathPath on the destination object on which recovery will be done.Required
destination_object_idID of the object where the files will be restored into. If not provided, Rubrik will use the snapshots object.

Note: Users can get the object ID by executing the "rubrik-polaris-vm-objects-list" command.
Optional

Context Output#

PathTypeDescription
RubrikPolaris.GPSVMRecoverFiles.idStringRecover files request ID.

Command Example#

!rubrik-gps-vm-recover-files cluster_id="052bf7af-93a3-44e9-a7d7-bc8dad4d6b43" snapshot_id="e2a0ffa8-82a3-518b-8532-0608a0e7380f" path_to_recover="/bin,/boot" restore_path="/tmp/backup1"

Human Readable Output#

GPS VM Recover Files#

Recover Files Request ID
dummy_id