Update

PUT v1/protection_templates/id

Description

Modify protection templates.

Normal Response Codes

200

HTTP Error Codes

400 401 403 404 409 500 503

Detail Codes

SM_eexist

SM_einval

SM_enoent

SM_eperm

SM_invalid_arg_value

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_missing_arg

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_not_owner

SM_repl_handover_busy

SM_repl_rename_notsup

SM_too_many

SM_unexpected_arg

SM_unexpected_query_param

SM_version_name

Request

Parameter Type JSON Type Description Mandatory Deprecated
id NsObjectID string Identifier for protection template. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. true  
name NsObjectName string User provided identifier. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. false  
description NsDescription string Text description of protection template. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. false  
app_sync NsAppSyncType string enum Application synchronization ({none|vss|vmware|generic}). 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 then 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 NsObjectName string VMware vCenter username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. false  
vcenter_password NsPassword string VMware vCenter password. String of 8 to 255 printable characters excluding ampersand and ;[]`. Example: 'password-91'. 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  

JSON Request 


            

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

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Identifier for protection template. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
name NsObjectName string User provided identifier. 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 protection template. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
search_name NsSearchName string Name of protection template used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'.  
description NsDescription string Text description of protection template. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.  
app_sync NsAppSyncType string enum Application synchronization ({none|vss|vmware|generic}). 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 then 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 NsObjectName string VMware vCenter username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
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 protection template was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
last_modified NsTime number Time when this protection template was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'.  
schedule_list NsScheduleList Array of NsSchedule List of schedules for this protection policy. List of snapshot schedules associated with a volume collection or protection template.  

JSON Response 


            

{
   "data" : {
      "vcenter_hostname" : "",
      "schedule_list" : null,
      "search_name" : "policy0.165174564653174",
      "name" : "policy0.165174564653174",
      "last_modified" : 1426776069,
      "app_id" : "sql2005",
      "vcenter_username" : "",
      "full_name" : "policy0.165174564653174",
      "description" : "my description",
      "app_server" : "appserver.ns.com",
      "app_sync" : "vss",
      "app_service_name" : "appservicename",
      "id" : "1200000000000004d3000000000000000000000011",
      "app_cluster_name" : "appcluster",
      "creation_time" : 1426776067
   }
}