Rubrik SDK for Python
1.0.0
1.0.0
  • Introduction
  • Getting Started
    • Quick Start
  • Base API Calls
    • delete
    • get
    • job_status
    • patch
    • post
    • put
    • query
  • Bootstrap Functions
    • setup_cluster
    • status
  • Cluster Functions
    • add_floating_ips
    • add_guest_credential
    • add_vcenter
    • cluster_node_id
    • cluster_node_ip
    • cluster_node_name
    • cluster_support_tunnel
    • cluster_version
    • configure_cluster_location
    • configure_dns_servers
    • configure_login_banner
    • configure_ntp
    • configure_replication_nat
    • configure_replication_private
    • configure_search_domain
    • configure_smtp_settings
    • configure_syslog
    • configure_timezone
    • configure_vlan
    • create_user
    • delete_guest_credential
    • delete_proxy
    • end_user_authorization
    • get_all_vcenters
    • get_floating_ips
    • minimum_installed_cdm_version
    • read_only_authorization
    • refresh_vcenter
    • remove_floating_ips
    • update_proxy
  • Cloud Functions
    • add_aws_native_account
    • aws_s3_cloudon
    • aws_s3_cloudout
    • azure_cloudon
    • azure_cloudout
    • update_aws_native_account
    • update_aws_s3_cloudout
  • Data Management Functions
    • assign_sla
    • begin_managed_volume_snapshot
    • create_sla
    • delete_sla
    • end_managed_volume_snapshot
    • get_all_hosts
    • get_esxi_subnets
    • get_sla_objects
    • get_sql_db
    • get_sql_db_files
    • get_sql_live_mount
    • get_vsphere_live_mount
    • get_vsphere_live_mount_names
    • get_vsphere_vm
    • get_vsphere_vm_details
    • get_vsphere_vm_file
    • get_vsphere_vm_snapshot
    • object_id
    • on_demand_snapshot
    • pause_snapshots
    • register_vm
    • resume_snapshots
    • set_esxi_subnets
    • sql_db_export
    • sql_instant_recovery
    • sql_live_mount
    • sql_live_unmount
    • vcenter_refresh_vm
    • vsphere_instant_recovery
    • vsphere_live_mount
    • vsphere_live_unmount
  • Physical Host Functions
    • add_host_share
    • add_nas_share_to_host
    • add_physical_host
    • assign_physical_host_fileset
    • create_nas_fileset
    • create_physical_fileset
    • delete_physical_host
  • SDK Helper Functions
    • log
    • exceptions
  • Internal Functions
    • _api_validation
    • _authorization_header
    • _common_api
    • _date_time_conversion
    • _header
    • _platform_user_agent
    • _time_in_range
    • _validate_sql_db
    • _validate_sql_recovery_point
Powered by GitBook
On this page
  • Keyword Arguments
  • Returns
  • Example
  1. Cluster Functions

cluster_support_tunnel

Enable or Disable the support tunnel.

def cluster_support_tunnel(enabled=True, timeout=15)

Keyword Arguments

Name

Type

Description

Choices

Default

enabled

bool

The flag that enables or disables the support tunnel.

True, False

True

timeout

int

The number of seconds to wait to establish a connection the Rubrik cluster before returning a timeout error.

15

Returns

Type

Return Value

str

No change required. Support Tunnel is already enabled.

str

No change required. Support Tunnel is already disabled.

dict

The full API response from `POST /internal/node/me/support_tunnel.

Example

import rubrik_cdm

rubrik = rubrik_cdm.Connect()

enable_support_tunnel = rubrik.cluster_support_tunnel(True)
import rubrik_cdm

rubrik = rubrik_cdm.Connect()

disabled_support_tunnel = rubrik.cluster_support_tunnel(False)
Previouscluster_node_nameNextcluster_version

Last updated 5 years ago