Update

Parameter	Type	JSON Type	Description	Mandatory
id	NsObjectID	string	Identifier for volume collection. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.	true
name	NsObjectName	string	Name of volume collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	false
description	NsDescription	string	Text description of volume collection. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.	false
app_sync	NsAppSyncType	string enum	Application Synchronization. Possible values: 'none', 'vss', 'vmware', 'generic'.	false
app_server	NsObjectName	string	Application server hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	false
app_id	NsAppIdType	string enum	Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\". Possible values: 'inval', 'exchange', 'sql2005', 'sql2008', 'sql2012', 'exchange_dag', 'sql2014', 'sql2016', 'hyperv'.	false
app_cluster_name	NsObjectName	string	If the application is running within a Windows cluster environment, this is the cluster name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	false
app_service_name	NsObjectName	string	If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	false
vcenter_hostname	NsObjectName	string	VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	false
vcenter_username	NsVcenterUserName	string	Application VMware vCenter username. String of up to 80 alphanumeric characters, beginning with a letter. It can include ampersand (@), backslash (\), dash (-), period (.), and underscore (_). Example: 'user1', 'companydomain\user1', administrator@vsphere.local.	false
vcenter_password	NsFlexiblePassword	string	Application VMware vCenter password. A password with few constraints. A string of up to 255 characters. Example: 'password_25-24'.	false
agent_hostname	NsObjectName	string	Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	false
agent_username	NsObjectName	string	Generic backup agent username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	false
agent_password	NsFlexiblePassword	string	Generic backup agent password. A password with few constraints. A string of up to 255 characters. Example: 'password_25-24'.	false
metadata	NsKeyValues	Array of NsKeyValue	Key-value pairs that augment a volume collection's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed.	false

JSON Request

            

{
   "data" : {
      "app_sync" : "vss",
      "app_service_name" : "appservicename",
      "app_id" : "sql2005",
      "name" : "policy0.458393094902025",
      "app_cluster_name" : "appcluster",
      "description" : "my description",
      "app_server" : "appserver.ns.com"
   }
}

Response

Parameter	Type	JSON Type	Description
id	NsObjectID	string	Identifier for volume collection. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.
name	NsObjectName	string	Name of volume collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
full_name	NsObjectName	string	Fully qualified name of volume collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
search_name	NsSearchName	string	Name of volume collection used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.
description	NsDescription	string	Text description of volume collection. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.
pol_owner_name	NsGroupName	string	Owner group. String of up to 64 alphanumeric characters, - is allowed after first character. Example: 'g1-exchange'.
app_sync	NsAppSyncType	string enum	Application Synchronization. Possible values: 'none', 'vss', 'vmware', 'generic'.
app_server	NsObjectName	string	Application server hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
app_id	NsAppIdType	string enum	Application ID running on the server. Application ID can only be specified if application synchronization is \\"vss\\". Possible values: 'inval', 'exchange', 'sql2005', 'sql2008', 'sql2012', 'exchange_dag', 'sql2014', 'sql2016', 'hyperv'.
app_cluster_name	NsObjectName	string	If the application is running within a Windows cluster environment, this is the cluster name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
app_service_name	NsObjectName	string	If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
vcenter_hostname	NsObjectName	string	VMware vCenter hostname. Custom port number can be specified with vCenter hostname using \\":\\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
vcenter_username	NsVcenterUserName	string	Application VMware vCenter username. String of up to 80 alphanumeric characters, beginning with a letter. It can include ampersand (@), backslash (\), dash (-), period (.), and underscore (_). Example: 'user1', 'companydomain\user1', administrator@vsphere.local.
vcenter_password	NsFlexiblePassword	string	Application VMware vCenter password. A password with few constraints. A string of up to 255 characters. Example: 'password_25-24'.
agent_hostname	NsObjectName	string	Generic backup agent hostname. Custom port number can be specified with agent hostname using \\":\\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
agent_username	NsObjectName	string	Generic backup agent username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
agent_password	NsFlexiblePassword	string	Generic backup agent password. A password with few constraints. A string of up to 255 characters. Example: 'password_25-24'.
creation_time	NsTime	number	Time when this volume collection was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
last_modified_time	NsTime	number	Time when this volume collection was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
volume_list	NsVolumeList	Array of NsVolumeSummary	List of volumes associated with volume collection. List of volumes.
volume_count	NsUnsignedLong	number	Count of volumes associated with volume collection. Unsigned 64-bit integer. Example: 1234.
cache_pinned_volume_list	NsVolumeList	Array of NsVolumeSummary	List of cache pinned volumes associated with volume collection. List of volumes.
last_snapcoll	NsSnapcollSummary	object	Last snapshot collection on this volume collection. Select fields containing snapshot collection information.
snapcoll_count	NsUnsignedLong	number	Count of snapshot collections associated with volume collection. Unsigned 64-bit integer. Example: 1234.
schedule_list	NsScheduleList	Array of NsSchedule	List of snapshot schedules associated with volume collection. List of snapshot schedules associated with a volume collection or protection template.
replication_partner	NsObjectName	string	Replication partner for this volume collection. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
last_replicated_snapcoll	NsSnapcollSummary	object	Last replicated snapshot collection on this volume collection. Select fields containing snapshot collection information.
protection_type	NsProtectionType	string enum	Specifies if volume collection is protected with schedules. If protected, indicated whether replication is setup. Volume Collection or volume is protected locally or remotely or unprotected. Possible values: 'local', 'remote' or 'unprotected'.
lag_time	NsTime	number	Replication lag time for volume collection. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.
is_standalone_volcoll	NsBoolean	boolean	Indicates whether this is a standalone volume collection. Possible values: 'true', 'false'.
total_repl_bytes	NsBytes	number	Total size of volumes to be replicated for this volume collection. Unsigned 64-bit integer. Example: '1234'.
repl_bytes_transferred	NsBytes	number	Total size of volumes replicated for this volume collection. Unsigned 64-bit integer. Example: '1234'.
is_handing_over	NsBoolean	boolean	Indicates whether a handover operation is in progress on this volume collection. Possible values: 'true', 'false'.
handover_replication_partner	NsObjectName	string	Replication partner to which ownership is being transferred as part of handover operation. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.
metadata	NsKeyValues	Array of NsKeyValue	Key-value pairs that augment a volume collection's attributes. List of key-value pairs. Keys must be unique and non-empty. When creating an object, values must be non-empty. When updating an object, an empty value causes the corresponding key to be removed.

JSON Response

            

{
   "data" : {
      "vcenter_hostname" : "",
      "snapcoll_count" : 0,
      "schedule_list" : null,
      "total_repl_bytes" : 0,
      "repl_bytes_transferred" : 0,
      "app_id" : "sql2005",
      "app_server" : "appserver.ns.com",
      "app_sync" : "vss",
      "volume_list" : null,
      "app_service_name" : "appservicename",
      "id" : "0700000000000004d3000000000000000000000035",
      "app_cluster_name" : "appcluster",
      "creation_time" : 1426776620,
      "vcenter_password" : "",
      "last_modified_time" : 1426776622,
      "search_name" : "policy0.458393094902025",
      "name" : "policy0.458393094902025",
      "pol_owner_name" : "g1a1",
      "vcenter_username" : "",
      "description" : "my description",
      "full_name" : "policy0.458393094902025",
      "metadata" : null
   }
}