# on\_demand\_snapshot

Initiate an on-demand snapshot.

```python
def on_demand_snapshot(self, object_name, object_type, sla_name='current', fileset=None, host_os=None, sql_host=None, sql_instance=None, sql_db=None, hostname=None, force_full=False, share_type=None, timeout=15):
```

## Arguments

| Name         | Type | Description                                                    | Choices                                            |
| ------------ | ---- | -------------------------------------------------------------- | -------------------------------------------------- |
| object\_name | str  | The name of the Rubrik object to take a on-demand snapshot of. |                                                    |
| object\_type | str  | The Rubrik object type you want to backup.                     | vmware, physical\_host, ahv, mssql\_db, oarcle\_db |

## Keyword Arguments

| Name        | Type | Description                                                                                                                                                                                                                                                                                                         | Choices        | Default |
| ----------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------- |
| sla\_name   | str  | The SLA Domain name you want to assign the on-demand snapshot to. By default, the currently assigned SLA Domain will be used.                                                                                                                                                                                       |                | current |
| fileset     | str  | The name of the Fileset you wish to backup. Only required when taking a on-demand snapshot of a physical host or share.                                                                                                                                                                                             |                | None    |
| host\_os    | str  | The operating system for the physical host. Only required when taking a on-demand snapshot of a physical host.                                                                                                                                                                                                      | Linux, Windows | None    |
| hostname    | str  | Required when the object\_type is either oracle\_db or share. When oracle\_db is the object\_type, this argument corresponds to the host name, or one of those host names in the cluster that the Oracle database is running. When share is the object\_type this argument corresponds to the NAS server host name. |                |         |
| force\_full | bool | If True will force a new full image backup of an Oracle database.                                                                                                                                                                                                                                                   |                | False   |
| share\_type | str  | The type of NAS share i.e. NFS or SMB. Only required when taking a snapshot of a Share.                                                                                                                                                                                                                             |                |         |
| 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                                                                                                                                                                                                  |
| ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| tuple | When object\_type is vmware, the full API response for `POST /v1/vmware/vm/{ID}/snapshot` and the job status URL which can be used to monitor progress of the snapshot. (api\_response, job\_status\_url)     |
| tuple | When object\_type is physical\_host, the full API response for `POST /v1/fileset/{}/snapshot` and the job status URL which can be used to monitor progress of the snapshot. (api\_response, job\_status\_url) |

## Example

```python
import rubrik_cdm

rubrik = rubrik_cdm.Connect()

# VMware Snapshot
vsphere_vm_name = "python-sdk-demo"
object_type = "vmware"
snapshot = rubrik.on_demand_snapshot(vsphere_vm_name, object_type)

# AHV Snapshot
ahv_vm_name = "python-sdk-demo"
object_type = "ahv"
snapshot = rubrik.on_demand_snapshot(ahv_vm_name, object_type)

# Physical Host Snapst
physical_host_name = "python-sdk-physical-demo"
object_type = "physical_host"
sla = "Gold"
fileset = "/etc"
host_os = "Linux"
snapshot = rubrik.on_demand_snapshot(physical_host_name, object_type, sla, fileset, host_os)

# NAS Share
object_name = "python-sdk-share-demo"
object_type = "share"
sla = "Gold"
fileset = "/etc"
hostname = "python-sdk-demo"
share_type = "NFS"
snapshot = rubrik.on_demand_snapshot(object_name, object_type, sla, fileset, hostname=hostname, share_type=share_type)
```