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,
    "size_mb": 0,
    "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,
    "free_mb": 0,
    "total_mb": 0,
    "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
Required

id

string
name
Required

Name of the Writable Volume.

string
name_html
Required

HTML escaped name of the Writable Volume.

string
title
Required

Alternative name derived from entity that owns the Writable Volume.

string
title_html
Required

HTML escaped alternative name of the Writable Volume.

string
owner
Required

HTML hyperlink to owner entity in.

string
link
Required

URL to owner entity HTML resource.

integer
owner_id
Optional

Owner ID of Writable Volume.

string
owner_name
Required

Owner name of the Writable Volume.

string
owner_type
Required

Entity type of the owner of the Writable Volume.

string
owner_upn
Required

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

string
owner_upn_html
Required

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

string
owner_object_guid
Required

Object-Guid of the Writable Volume owner.

string
description
Required

Description text for the Writable Volume.

created_at
Required

created_at

created_at_human
Required

created_at_human

updated_at
Required

updated_at

updated_at_human
Required

updated_at_human

mounted_at
Required

mounted_at

mounted_at_human
Required

mounted_at_human

string
mounted_on
Required

Machine that the Writable Volume is currently mounted to.

mount_count
Required

mount_count

string
attached
Required

Whether the Writable Volume is currently attached.

Possible values are : Attached, Detached,
string
status
Required

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
Required

Number of times Writable Volume has been updated.

string
version_tag
Required

Version tag for Writable Volume.

string
error_action
Required

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
Required

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

boolean
enable_version
Required

Versioning status of Writable Volume.

string
mount_prefix
Required

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

boolean
defer_create
Required

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

integer
size_mb
Required

Specified size of the Writable Volume.

string
template_version
Required

Version of Writable Template used to create the Writable Volume.

busy
Required

busy

state
Required

state

string
volume_guid
Required

GUID assigned to the Writable Volume on the datastore.

string
datastore_name
Required

Datastore the Writable Volume resides on.

string
machine_manager_host
Required

Hypervisor host associated with the Writable Volume.

string
machine_manager_type
Required

Type of hypervisor associated with the Writable Volume.

string
path
Required

Path to the Writable Volume file.

string
filename
Required

Filename of the Writable Volume.

string
file_location
Required

Formatted display of the Writable Volume's location.

string
type
Required

Type of Writable Volume.

string
display_type
Required

Display value of Writable Volume.

integer
files_count
Required

Number of Snapvol files present for Writable Volume.

string
template_file_name
Required

File used to generate the Writable Volume.

boolean
protected
Required

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

integer
free_mb
Required

Actual free space on the Writable Volume.

integer
total_mb
Required

Actual total space on the Writable Volume; can differ from size_mb due to datastore file formatting and growth operations.

string
percent_available
Required

Percent of available space on Writable Volume.

boolean
can_expand
Required

Whether the Writable Volume is eligible for growth operations.

string
datastore_host
Required

Datastore host that the Writable Volume resides on.

integer
primordial_os_id
Required

ID of the base operating system.

string
primordial_os_name
Required

Name of the base operating system.

oses
Required

List of operating systems compatible with the Writable Volume.