rubrik_get_sql_live_mount
rubrik_get_sql_live_mount
Retrieve the Live Mounts for a MSSQL source database. Requirement: Rubrik Python SDK (pip install rubrik_cdm)
Example
Arugments
Common
Name
Description
Default
node_ip
The DNS hostname or IP address of the Rubrik cluster. By defeault, the module will attempt to read this value from the rubrik_cdm_node_ip environment variable. If this environment variable is not present it will need to be manually specified here or in the `provider' parameter.
password
The password used to authenticate the connection to the Rubrik cluster. By defeault, the module will attempt to read this value from the rubrik_cdm_password environment variable. If this environment variable is not present it will need to be manually specified here or in the `provider' parameter.
username
The username used to authenticate the connection to the Rubrik cluster. By defeault, the module will attempt to read this value from the rubrik_cdm_username environment variable. If this environment variable is not present it will need to be manually specified here or in the `provider' parameter.
api_token
The api token used to authenticate the connection to the Rubrik cluster. By defeault, the module will attempt to read this value from the rubrik_cdm_token environment variable. If this environment variable is not present it will need to be manually specified here or in the `provider' parameter.
provider
Convenience method that allows all connection arguments (node_ip',
username', `password') to be passed as a dict object. By default, the module will attempt to read these parameters from the rubrik_cdm_node_ip, rubrik_cdm_username, and rubrik_cdm_password environment variables.
Note: The username
and password
must be supplied together and may not be provided if the api_token
variable is present
Module Specific
Name
Description
Default
Type
Choices
Mandatory
Aliases
db_name
The name of the source database with Live Mounts.
str
true
sql_instance
The SQL instance name of the source database.
None
str
true
sql_host
The SQL host name of the source database/instance.
None
str
true
timeout
The number of seconds to wait to establish a connection the Rubrik cluster before returning a timeout error.
30
int
false
Return Values
Name
Description
Returned
Type
Aliases
response
The full response of GET /v1/mssql/db/mount?source_database_id={id}
.
success
dict
Last updated
Was this helpful?