WritableVolumeForIndex

JSON Example

{
    "id": 0,
    "name": "SNAPVOLUMES\test_user",
    "title": "SNAPVOLUMES\test_user",
    "owner_id": 2,
    "owner_name": "TestUser",
    "owner_type": "User",
    "owner_upn": "SNAPVOLUMES\test_user",
    "owner_object_guid": "8da04bfa-bbbe-45c3-9cbf-2d3d03897b84",
    "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",
    "attached": "string",
    "status": "string",
    "mount_count": 0,
    "total_mb": 10237,
    "free_mb": 5237,
    "size_mb": 5000,
    "requested_mb": 20480,
    "percent_available": "Unknown",
    "template_version": "4.0.0",
    "version_count": 0,
    "type": "DataDisk",
    "display_type": "Writable Volume",
    "error_action": "string",
    "busy": false,
    "state": "Moving",
    "filename": "snapvolumes_test_user.vmdk",
    "path": "appvolumes/writable",
    "datastore_name": "SSD Disk Array RAID8",
    "volume_guid": "volumeguid-8-volumeguid",
    "datastore_host": "null",
    "can_expand": true
}

integer

Optional

string

name

Optional

Name of the Writable Volume.

string

title

Optional

Alternative name derived from entity that owns the Writable Volume.

integer

owner_id

Optional

Owner ID of Writable Volume.

string

owner_name

Optional

Owner of Writable Volume.

string

owner_type

Optional

Entity type of the Writable Volume owner.

string

owner_upn

Optional

Down-level login name of the Writable Volume owner.

string

owner_object_guid

Optional

Object-Guid of the Writable Volume owner.

CreatedAt

created_at

Optional

Creation timestamp.

CreatedAtHuman

created_at_human

Optional

Creation timestamp in human readable format.

UpdatedAt

updated_at

Optional

Timestamp of last update.

UpdatedAtHuman

updated_at_human

Optional

Timestamp of last update in human readable format.

WritableMountedAt

mounted_at

Optional

Timestamp of when the Writable Volume was mounted.

WritableMountedAtHuman

mounted_at_human

Optional

Timestamp of when the Writable Volume was mounted in human readable format.

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,

WritableMountCount

mount_count

Optional

The number of computers where the Writable Volume is currently mounted.

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 on 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

percent_available

Optional

Percent of available space on the Writable Volume.

string

template_version

Optional

Version of Writable Template used to create the Writable Volume.

integer

version_count

Optional

Number of times Writable Volume has been updated.

string

type

Optional

Type of Writable Volume.

string

display_type

Optional

Display value of Writable Volume.

string

error_action

Optional

Whether failures related to the Writable Volume will prevent application related attachments and whether they alert the user.

WritableBusy

busy

Optional

Whether the Writable is busy with a current backup operation.

WritableState

state

Optional

The current backup operation state if present.

Possible values are : Moving, Backing Up, Restoring,

string

filename

Optional

Filename of the Writable Volume.

string

path

Optional

Path to the Writable Volume file.

string

datastore_name

Optional

Datastore the Writable Volume resides on.

string

volume_guid

Optional

GUID assigned to the Writable Volume on the datastore.

string

datastore_host

Optional

Datastore host that the Writable Volume resides on.

boolean

can_expand

Optional

Whether the Writable Volume is eligible for expansion operations.

Property Of

GetWritableVolumes