WritableVolume

WritableVolume
WritableVolume
JSON Example
{
    "id": 0,
    "name": "SNAPVOLUMES\test_user",
    "name_html": "SNAPVOLUMES\test_user",
    "title": "SNAPVOLUMES\test_user",
    "title_html": "SNAPVOLUMES\test_user",
    "owner": "<a href=\\\"/directory#/Users/2\\\" title=\\\"test_user\\\">TESTDOMAIN\\\\test_user</a>",
    "link": "/directory#/Users/2",
    "owner_id": 3,
    "owner_name": "TestUser",
    "owner_type": "User",
    "owner_upn": "SNAPVOLUMES\test_user",
    "owner_upn_html": "SNAPVOLUMES\test_user",
    "owner_object_guid": "8da04bfa-bbbe-45c3-9cbf-2d3d03897b84",
    "description": "My writable volume",
    "created_at": "2021-12-03 13:10:13 -0800",
    "created_at_human": "Dec 03 2021",
    "updated_at": "2021-12-03 13:10:13 -0800",
    "updated_at_human": "Dec 03 2021",
    "mounted_at": "2021-12-03 13:10:13 -0800",
    "mounted_at_human": "Dec 03 2021",
    "mounted_on": "Machine <DESKTOP-VM123> (#{1234567812345678})",
    "mount_count": 0,
    "attached": "string",
    "status": "enabled",
    "version_count": 0,
    "version_tag": "0",
    "error_action": "string",
    "block_login": true,
    "enable_version": false,
    "mount_prefix": "DESKTOP",
    "defer_create": true,
    "total_mb": 10237,
    "free_mb": 5237,
    "size_mb": 5000,
    "requested_mb": 20480,
    "template_version": "4.0.0",
    "busy": false,
    "state": "Moving",
    "volume_guid": "volumeguid-8-volumeguid",
    "datastore_name": "SSD Disk Array RAID8",
    "machine_manager_host": "0.0.0.0",
    "machine_manager_type": "Machine Manager",
    "path": "appvolumes/writable",
    "filename": "snapvolumes_test_user_15.vmdk",
    "file_location": "[SSD Disk Array RAID8] appvolumes/writable/snapvolumes_test_user_15.vmdk",
    "type": "DataDisk",
    "display_type": "Writable Volume",
    "files_count": 1,
    "template_file_name": "[SSD Disk Array RAID8] appvolumes/writable_templates/template_uia_only_persistent.vmdk",
    "protected": true,
    "percent_available": "Unknown",
    "can_expand": true,
    "datastore_host": "null",
    "primordial_os_id": 15,
    "primordial_os_name": "Windows 8.1 (x64)",
    "oses": [
        {
            "id": 0,
            "name": "Windows 8.1 (x64)"
        }
    ]
}
integer
id
Optional

id

string
name
Optional

Name of the Writable Volume.

string
name_html
Optional

HTML escaped name of the Writable Volume.

string
title
Optional

Alternative name derived from entity that owns the Writable Volume.

string
title_html
Optional

HTML escaped alternative name of the Writable Volume.

string
owner
Optional

HTML hyperlink to owner entity in.

string
link
Optional

URL to owner entity HTML resource.

integer
owner_id
Optional

Owner ID of Writable Volume.

string
owner_name
Optional

Owner name of the Writable Volume.

string
owner_type
Optional

Entity type of the owner of the Writable Volume.

string
owner_upn
Optional

Down-level login name of owner of the Writable Volume.

string
owner_upn_html
Optional

HTML escaped down-level login name of owner of the Writable Volume.

string
owner_object_guid
Optional

Object-Guid of the Writable Volume owner.

string
description
Optional

Description text for the Writable Volume.

created_at
Optional

created_at

created_at_human
Optional

created_at_human

updated_at
Optional

updated_at

updated_at_human
Optional

updated_at_human

mounted_at
Optional

mounted_at

mounted_at_human
Optional

mounted_at_human

string
mounted_on
Optional

Machine that the Writable Volume is currently mounted to.

mount_count
Optional

mount_count

string
attached
Optional

Whether the Writable Volume is currently attached.

Possible values are : Attached, Detached,
string
status
Optional

Status of the Writable Volume.

Possible values are : missing, unprovisioned, provisioning, reserved, orphaned, legacy, limit_reached, enabled, failed, creating, canceled, disabled, unreachable,
integer
version_count
Optional

Number of times Writable Volume has been updated.

string
version_tag
Optional

Version tag for Writable Volume.

string
error_action
Optional

Whether failures related to the Writable Volume will prevent application related attachments and whether they alert the user. Must be blank if block_login=1.

Possible values are : , continue_silently, continue_alert, disable_and_alert, disable_and_alert_on_error,
boolean
block_login
Optional

Whether failures related to the Writable Volume will prevent User login.

boolean
enable_version
Optional

Versioning status of Writable Volume.

string
mount_prefix
Optional

The Writable Volume will mount only on computers whose name begins with the mount prefix.

boolean
defer_create
Optional

Whether the Writable Volume was created with it's associated disk being created immediately or with background job.

integer
total_mb
Optional

Current total space in MB on the Writable Volume. This can differ from size_mb or requested_mb due to datastore file formatting and expansion operations.

integer
free_mb
Optional

Current free space in MB on the Writable Volume.

integer
size_mb
Optional

Current used space in MB of the Writable Volume.

integer
requested_mb
Optional

Requested size of the Writable Volume in MB for expansion operations. Will be 'null' after expansion operations or if no request for expansion has been made. This can differ from total_mb due to datastore file formatting and expansion operations.

string
template_version
Optional

Version of Writable Template used to create the Writable Volume.

busy
Optional

busy

state
Optional

state

string
volume_guid
Optional

GUID assigned to the Writable Volume on the datastore.

string
datastore_name
Optional

Datastore the Writable Volume resides on.

string
machine_manager_host
Optional

Hypervisor host associated with the Writable Volume.

string
machine_manager_type
Optional

Type of hypervisor associated with the Writable Volume.

string
path
Optional

Path to the Writable Volume file.

string
filename
Optional

Filename of the Writable Volume.

string
file_location
Optional

Formatted display of the Writable Volume's location.

string
type
Optional

Type of Writable Volume.

string
display_type
Optional

Display value of Writable Volume.

integer
files_count
Optional

Number of Snapvol files present for Writable Volume.

string
template_file_name
Optional

File used to generate the Writable Volume.

boolean
protected
Optional

Whether the Writable Volume is has delete protection set on datastore.

string
percent_available
Optional

Percent of available space on Writable Volume.

boolean
can_expand
Optional

Whether the Writable Volume is eligible for expansion operations.

string
datastore_host
Optional

Datastore host that the Writable Volume resides on.

integer
primordial_os_id
Optional

ID of the base operating system.

string
primordial_os_name
Optional

Name of the base operating system.

oses
Optional

List of operating systems compatible with the Writable Volume.