TVO-4.2
Search
⌃K

Workloads

get
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads
List Workloads
post
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads
Create Workload

Body format

Workload create requires a Body in json format, to provide the requested information.
Using a policy-id will pull the following information from the policy. Values provided in the Body will be overwritten with the values from the Policy.
retention_policy_type
retention_policy_value
interval
{
"workload":{
"name":"<name of the Workload>",
"description":"<description of workload>",
"workload_type_id":"<ID of the chosen Workload Type",
"source_platform":"openstack",
"instances":[
{
"instance-id":"<Instance ID>"
},
{
"instance-id":"<Instance ID>"
}
],
"jobschedule":{
"retention_policy_type":"<'Number of Snapshots to Keep'/'Number of days to retain Snapshots'>",
"retention_policy_value":"<Integer>"
"timezone":"<timezone>",
"start_date":"<Date format: MM/DD/YYYY>"
"end_date":"<Date format MM/DD/YYYY>",
"start_time":"<Time format: HH:MM AM/PM>",
"interval":"<Format: Integer hr",
"enabled":"<True/False>"
},
"metadata":{
<key>:<value>,
"policy_id":"<policy_id>"
}
}
}
get
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>
Show Workload
put
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>
Modify Workload

Body format

Workload modify requires a Body in json format, to provide the information about the values to modify.
All values in the body are optional.
Using a policy-id will pull the following information from the policy. Values provided in the Body will be overwritten with the values from the Policy.
retention_policy_type
retention_policy_value
interval
{
"workload":{
"name":"<name>",
"description":"<description>"
"instances":[
{
"instance-id":"<instance_id>"
},
{
"instance-id":"<instance_id>"
}
],
"jobschedule":{
"retention_policy_type":"<'Number of Snapshots to Keep'/'Number of days to retain Snapshots'>",
"retention_policy_value":"<Integer>",
"timezone":"<timezone>",
"start_time":"<HH:MM AM/PM>",
"end_date":"<MM/DD/YYYY>",
"interval":"<Integer hr>",
"enabled":"<True/False>"
},
"metadata":{
"meta":"data",
"policy_id":"<policy_id>"
},
}
}
delete
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>
Delete Workload
post
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>/unlock
Unlock Workload
post
https://$(tvm_address):8780/v1/$(tenant_id)
/workloads/<workload_id>/reset
Reset Workload