From 86bc64ba4b287227e2a83b8884caa00223b800ae Mon Sep 17 00:00:00 2001 From: Rob Hoes Date: Wed, 27 Mar 2013 17:13:06 +0000 Subject: [PATCH] CP-4431: Mark VMPR stuff as "removed" in API docs Signed-off-by: Rob Hoes --- ocaml/idl/datamodel.ml | 122 +++++++++++++++++------------------------ 1 file changed, 51 insertions(+), 71 deletions(-) diff --git a/ocaml/idl/datamodel.ml b/ocaml/idl/datamodel.ml index c6da7b8684..57af52d792 100644 --- a/ocaml/idl/datamodel.ml +++ b/ocaml/idl/datamodel.ml @@ -6721,8 +6721,8 @@ let vm = field ~writer_roles:_R_VM_POWER_ADMIN ~qualifier:DynamicRO ~in_product_since:rel_midnight_ride ~ty:(Set (Ref _vm)) "children" "List pointing to all the children of this VM"; field ~qualifier:DynamicRO ~in_product_since:rel_midnight_ride ~default_value:(Some (VMap [])) ~ty:(Map (String,String)) "bios_strings" "BIOS strings"; - field ~writer_roles:_R_VM_POWER_ADMIN ~qualifier:StaticRO ~in_product_since:rel_cowley ~default_value:(Some (VRef (Ref.string_of Ref.null))) ~ty:(Ref _vmpp) "protection_policy" "Ref pointing to a protection policy for this VM"; - field ~writer_roles:_R_POOL_OP ~qualifier:StaticRO ~in_product_since:rel_cowley ~default_value:(Some (VBool false)) ~ty:Bool "is_snapshot_from_vmpp" "true if this snapshot was created by the protection policy"; + field ~writer_roles:_R_VM_POWER_ADMIN ~qualifier:StaticRO ~lifecycle:[Published, rel_cowley, ""; Deprecated, rel_clearwater, "The VMPR feature was removed"] ~default_value:(Some (VRef (Ref.string_of Ref.null))) ~ty:(Ref _vmpp) "protection_policy" "Ref pointing to a protection policy for this VM"; + field ~writer_roles:_R_POOL_OP ~qualifier:StaticRO ~lifecycle:[Published, rel_cowley, ""; Deprecated, rel_clearwater, "The VMPR feature was removed"] ~default_value:(Some (VBool false)) ~ty:Bool "is_snapshot_from_vmpp" "true if this snapshot was created by the protection policy"; field ~writer_roles:_R_POOL_OP ~qualifier:StaticRO ~ty:(Ref _vm_appliance) ~default_value:(Some (VRef (Ref.string_of Ref.null))) "appliance" "the appliance to which this VM belongs"; field ~writer_roles:_R_POOL_OP ~qualifier:StaticRO ~in_product_since:rel_boston ~default_value:(Some (VInt 0L)) ~ty:Int "start_delay" "The delay to wait before proceeding to the next order in the startup sequence (seconds)"; field ~writer_roles:_R_POOL_OP ~qualifier:StaticRO ~in_product_since:rel_boston ~default_value:(Some (VInt 0L)) ~ty:Int "shutdown_delay" "The delay to wait before proceeding to the next order in the shutdown sequence (seconds)"; @@ -6791,10 +6791,13 @@ let vm_guest_metrics = () (* VM protection policy *) +let vmpr_removed = [ + Published, rel_cowley, ""; + Removed, rel_clearwater, "The VMPR feature was removed"; +] let vmpp_protect_now = call ~flags:[`Session] ~name:"protect_now" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[Ref _vmpp, "vmpp", "The protection policy to execute";] ~doc:"This call executes the protection policy immediately" ~allowed_roles:_R_POOL_OP @@ -6802,8 +6805,7 @@ let vmpp_protect_now = call ~flags:[`Session] () let vmpp_archive_now = call ~flags:[`Session] ~name:"archive_now" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[Ref _vm, "snapshot", "The snapshot to archive";] ~doc:"This call archives the snapshot provided as a parameter" ~allowed_roles:_R_VM_POWER_ADMIN @@ -6811,8 +6813,7 @@ let vmpp_archive_now = call ~flags:[`Session] () let vmpp_create_alert = call ~flags:[`Session] ~name:"create_alert" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[Ref _vmpp, "vmpp", "The protection policy where the alert should be created"; String, "name", "The name of the message"; Int, "priority", "The priority of the message"; @@ -6825,8 +6826,7 @@ let vmpp_create_alert = call ~flags:[`Session] () let vmpp_get_alerts = call ~flags:[`Session] ~name:"get_alerts" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[Ref _vmpp, "vmpp", "The protection policy"; Int, "hours_from_now", "how many hours in the past the oldest record to fetch is"; ] @@ -6866,8 +6866,7 @@ let vmpp_archive_target_config_username = "username" let vmpp_archive_target_config_password = "password" let vmpp_set_backup_retention_value = call ~flags:[`Session] ~name:"set_backup_retention_value" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -6876,8 +6875,7 @@ let vmpp_set_backup_retention_value = call ~flags:[`Session] () let vmpp_set_is_backup_running = call ~flags:[`Session] ~name:"set_is_backup_running" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[ Ref _vmpp, "self", "The protection policy"; Bool, "value", "true to mark this protection policy's backup is running" @@ -6888,8 +6886,7 @@ let vmpp_set_is_backup_running = call ~flags:[`Session] () let vmpp_set_is_archive_running = call ~flags:[`Session] ~name:"set_is_archive_running" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[ Ref _vmpp, "self", "The protection policy"; Bool, "value", "true to mark this protection policy's archive is running" @@ -6900,8 +6897,7 @@ let vmpp_set_is_archive_running = call ~flags:[`Session] () let vmpp_set_is_alarm_enabled = call ~flags:[`Session] ~name:"set_is_alarm_enabled" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[ Ref _vmpp, "self", "The protection policy"; Bool, "value", "true if alarm is enabled for this policy" @@ -6911,8 +6907,7 @@ let vmpp_set_is_alarm_enabled = call ~flags:[`Session] () let vmpp_set_archive_frequency = call ~flags:[`Session] ~name:"set_archive_frequency" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[ Ref _vmpp, "self", "The protection policy"; vmpp_archive_frequency, "value", "the archive frequency" @@ -6922,8 +6917,7 @@ let vmpp_set_archive_frequency = call ~flags:[`Session] () let vmpp_set_archive_target_type = call ~flags:[`Session] ~name:"set_archive_target_type" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[ Ref _vmpp, "self", "The protection policy"; vmpp_archive_target_type, "value", "the archive target config type" @@ -6933,8 +6927,7 @@ let vmpp_set_archive_target_type = call ~flags:[`Session] () let vmpp_set_backup_frequency = call ~flags:[`Session] ~name:"set_backup_frequency" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~params:[ Ref _vmpp, "self", "The protection policy"; vmpp_backup_frequency, "value", "the backup frequency" @@ -6944,8 +6937,7 @@ let vmpp_set_backup_frequency = call ~flags:[`Session] () let vmpp_set_backup_schedule = call ~flags:[`Session] ~name:"set_backup_schedule" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -6954,8 +6946,7 @@ let vmpp_set_backup_schedule = call ~flags:[`Session] () let vmpp_set_archive_target_config = call ~flags:[`Session] ~name:"set_archive_target_config" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -6964,8 +6955,7 @@ let vmpp_set_archive_target_config = call ~flags:[`Session] () let vmpp_set_archive_schedule = call ~flags:[`Session] ~name:"set_archive_schedule" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -6974,8 +6964,7 @@ let vmpp_set_archive_schedule = call ~flags:[`Session] () let vmpp_set_alarm_config = call ~flags:[`Session] ~name:"set_alarm_config" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -6984,8 +6973,7 @@ let vmpp_set_alarm_config = call ~flags:[`Session] () let vmpp_set_backup_last_run_time = call ~flags:[`Session] ~name:"set_backup_last_run_time" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_LOCAL_ROOT_ONLY ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -6994,8 +6982,7 @@ let vmpp_set_backup_last_run_time = call ~flags:[`Session] () let vmpp_set_archive_last_run_time = call ~flags:[`Session] ~name:"set_archive_last_run_time" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_LOCAL_ROOT_ONLY ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -7004,8 +6991,7 @@ let vmpp_set_archive_last_run_time = call ~flags:[`Session] () let vmpp_add_to_backup_schedule = call ~flags:[`Session] ~name:"add_to_backup_schedule" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -7015,8 +7001,7 @@ let vmpp_add_to_backup_schedule = call ~flags:[`Session] () let vmpp_add_to_archive_target_config = call ~flags:[`Session] ~name:"add_to_archive_target_config" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -7026,8 +7011,7 @@ let vmpp_add_to_archive_target_config = call ~flags:[`Session] () let vmpp_add_to_archive_schedule = call ~flags:[`Session] ~name:"add_to_archive_schedule" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -7037,8 +7021,7 @@ let vmpp_add_to_archive_schedule = call ~flags:[`Session] () let vmpp_add_to_alarm_config = call ~flags:[`Session] ~name:"add_to_alarm_config" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -7048,8 +7031,7 @@ let vmpp_add_to_alarm_config = call ~flags:[`Session] () let vmpp_remove_from_backup_schedule = call ~flags:[`Session] ~name:"remove_from_backup_schedule" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -7058,8 +7040,7 @@ let vmpp_remove_from_backup_schedule = call ~flags:[`Session] () let vmpp_remove_from_archive_target_config = call ~flags:[`Session] ~name:"remove_from_archive_target_config" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -7068,8 +7049,7 @@ let vmpp_remove_from_archive_target_config = call ~flags:[`Session] () let vmpp_remove_from_archive_schedule = call ~flags:[`Session] ~name:"remove_from_archive_schedule" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -7078,8 +7058,7 @@ let vmpp_remove_from_archive_schedule = call ~flags:[`Session] () let vmpp_remove_from_alarm_config = call ~flags:[`Session] ~name:"remove_from_alarm_config" - ~in_oss_since:None - ~in_product_since:rel_cowley + ~lifecycle:vmpr_removed ~allowed_roles:_R_POOL_OP ~params:[ Ref _vmpp, "self", "The protection policy"; @@ -7087,8 +7066,9 @@ let vmpp_remove_from_alarm_config = call ~flags:[`Session] ] () let vmpp = - create_obj ~in_db:true ~in_product_since:rel_cowley ~in_oss_since:None ~internal_deprecated_since:None ~persist:PersistEverything ~gen_constructor_destructor:true ~name:_vmpp ~descr:"VM Protection Policy" + create_obj ~in_db:true ~in_oss_since:None ~persist:PersistEverything ~gen_constructor_destructor:true ~name:_vmpp ~descr:"VM Protection Policy" ~gen_events:true + ~lifecycle:vmpr_removed ~doccomments:[] ~messages_default_allowed_roles:_R_POOL_OP ~messages:[ @@ -7119,25 +7099,25 @@ let vmpp = vmpp_set_archive_last_run_time; ] ~contents:[ - uid _vmpp; + uid ~lifecycle:vmpr_removed _vmpp; namespace ~name:"name" ~contents:(names None RW) (); - field ~qualifier:RW ~ty:Bool "is_policy_enabled" "enable or disable this policy" ~default_value:(Some (VBool true)); - field ~qualifier:RW ~ty:vmpp_backup_type "backup_type" "type of the backup sub-policy"; - field ~qualifier:StaticRO ~ty:Int "backup_retention_value" "maximum number of backups that should be stored at any time" ~default_value:(Some (VInt 7L)); - field ~qualifier:StaticRO ~ty:vmpp_backup_frequency "backup_frequency" "frequency of the backup schedule"; - field ~qualifier:StaticRO ~ty:(Map (String,String)) "backup_schedule" "schedule of the backup containing 'hour', 'min', 'days'. Date/time-related information is in XenServer Local Timezone"; - field ~qualifier:DynamicRO ~ty:Bool "is_backup_running" "true if this protection policy's backup is running"; - field ~qualifier:DynamicRO ~ty:DateTime "backup_last_run_time" "time of the last backup" ~default_value:(Some(VDateTime(Date.of_float 0.))); - field ~qualifier:StaticRO ~ty:vmpp_archive_target_type "archive_target_type" "type of the archive target config" ~default_value:(Some (VEnum "none")); - field ~qualifier:StaticRO ~ty:(Map (String,String)) "archive_target_config" "configuration for the archive, including its 'location', 'username', 'password'" ~default_value:(Some (VMap [])); - field ~qualifier:StaticRO ~ty:vmpp_archive_frequency "archive_frequency" "frequency of the archive schedule" ~default_value:(Some (VEnum "never")); - field ~qualifier:StaticRO ~ty:(Map (String,String)) "archive_schedule" "schedule of the archive containing 'hour', 'min', 'days'. Date/time-related information is in XenServer Local Timezone" ~default_value:(Some (VMap [])); - field ~qualifier:DynamicRO ~ty:Bool "is_archive_running" "true if this protection policy's archive is running"; - field ~qualifier:DynamicRO ~ty:DateTime "archive_last_run_time" "time of the last archive" ~default_value:(Some(VDateTime(Date.of_float 0.))); - field ~qualifier:DynamicRO ~ty:(Set (Ref _vm)) "VMs" "all VMs attached to this protection policy"; - field ~qualifier:StaticRO ~ty:Bool "is_alarm_enabled" "true if alarm is enabled for this policy" ~default_value:(Some (VBool false)); - field ~qualifier:StaticRO ~ty:(Map (String,String)) "alarm_config" "configuration for the alarm" ~default_value:(Some (VMap [])); - field ~qualifier:DynamicRO ~ty:(Set (String)) "recent_alerts" "recent alerts" ~default_value:(Some (VSet [])); + field ~lifecycle:vmpr_removed ~qualifier:RW ~ty:Bool "is_policy_enabled" "enable or disable this policy" ~default_value:(Some (VBool true)); + field ~lifecycle:vmpr_removed ~qualifier:RW ~ty:vmpp_backup_type "backup_type" "type of the backup sub-policy" ~default_value:(Some (VEnum "snapshot")); + field ~lifecycle:vmpr_removed ~qualifier:StaticRO ~ty:Int "backup_retention_value" "maximum number of backups that should be stored at any time" ~default_value:(Some (VInt 7L)); + field ~lifecycle:vmpr_removed ~qualifier:StaticRO ~ty:vmpp_backup_frequency "backup_frequency" "frequency of the backup schedule" ~default_value:(Some (VEnum "daily")); + field ~lifecycle:vmpr_removed ~qualifier:StaticRO ~ty:(Map (String,String)) "backup_schedule" "schedule of the backup containing 'hour', 'min', 'days'. Date/time-related information is in XenServer Local Timezone" ~default_value:(Some (VMap [])); + field ~lifecycle:vmpr_removed ~qualifier:DynamicRO ~ty:Bool "is_backup_running" "true if this protection policy's backup is running"; + field ~lifecycle:vmpr_removed ~qualifier:DynamicRO ~ty:DateTime "backup_last_run_time" "time of the last backup" ~default_value:(Some(VDateTime(Date.of_float 0.))); + field ~lifecycle:vmpr_removed ~qualifier:StaticRO ~ty:vmpp_archive_target_type "archive_target_type" "type of the archive target config" ~default_value:(Some (VEnum "none")); + field ~lifecycle:vmpr_removed ~qualifier:StaticRO ~ty:(Map (String,String)) "archive_target_config" "configuration for the archive, including its 'location', 'username', 'password'" ~default_value:(Some (VMap [])); + field ~lifecycle:vmpr_removed ~qualifier:StaticRO ~ty:vmpp_archive_frequency "archive_frequency" "frequency of the archive schedule" ~default_value:(Some (VEnum "never")); + field ~lifecycle:vmpr_removed ~qualifier:StaticRO ~ty:(Map (String,String)) "archive_schedule" "schedule of the archive containing 'hour', 'min', 'days'. Date/time-related information is in XenServer Local Timezone" ~default_value:(Some (VMap [])); + field ~lifecycle:vmpr_removed ~qualifier:DynamicRO ~ty:Bool "is_archive_running" "true if this protection policy's archive is running"; + field ~lifecycle:vmpr_removed ~qualifier:DynamicRO ~ty:DateTime "archive_last_run_time" "time of the last archive" ~default_value:(Some(VDateTime(Date.of_float 0.))); + field ~lifecycle:vmpr_removed ~qualifier:DynamicRO ~ty:(Set (Ref _vm)) "VMs" "all VMs attached to this protection policy"; + field ~lifecycle:vmpr_removed ~qualifier:StaticRO ~ty:Bool "is_alarm_enabled" "true if alarm is enabled for this policy" ~default_value:(Some (VBool false)); + field ~lifecycle:vmpr_removed ~qualifier:StaticRO ~ty:(Map (String,String)) "alarm_config" "configuration for the alarm" ~default_value:(Some (VMap [])); + field ~lifecycle:vmpr_removed ~qualifier:DynamicRO ~ty:(Set (String)) "recent_alerts" "recent alerts" ~default_value:(Some (VSet [])); ] ()