# rubrik\_vsphere\_live\_unmount

## rubrik\_vsphere\_live\_unmount

Delete a vSphere Live Mount from the Rubrik cluster. `Requirement: Rubrik Python SDK (pip install rubrik_cdm)`

## Example

```yaml
- rubrik_vsphere_live_unmount:
    mounted_vm_name: 'ansible-tower'
```

```yaml
- rubrik_vsphere_live_unmount:
    mounted_vm_name: 'ansible-tower'
    force: True
```

## 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 |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------- | ------- | ---- | ------- | --------- | ------- |
| mounted\_vm\_name | The name of the Live Mounted vSphere VM to be unmounted.                                                                   |         | str  |         | true      |         |
| force             | Force unmount to remove metadata when the datastore of the Live Mount virtual machine was moved off of the Rubrik cluster. | false   | bool |         |           |         |
| timeout           | The number of seconds to wait to establish a connection the Rubrik cluster before returning a timeout error.               | 15      | int  |         |           |         |

## Return Values

| Name     | Description                                                                | Returned | Type | Aliases |
| -------- | -------------------------------------------------------------------------- | -------- | ---- | ------- |
| response | The full response of `DELETE /vmware/vm/snapshot/mount/{id}?force={bool}`. | success  | dict |         |
