netcoreapp2.0/Resources/sentinelbundleMetadata.json

{"metadata":[{"value":{"cli":{"commands":[{"formatter":"SIMPLE","output_field_list":[{"output_fields":[{"display_name":"TaskId","field_name":"task_id"}],"structure_id":"com.vmware.hcx.sentinel.model.create_sentinel_bundle_success_response"}],"identity":{"path":"com.vmware.hcx.sentinel.sentinel","name":"createsentinelbundle"},"service_id":"com.vmware.hcx.sentinel.sentinel","options":[{"short_option":"","long_option":"os-type","description":"Possible values are: ","type":"string","generic":"OPTIONAL","field_name":"body.osType"},{"short_option":"","long_option":"sgw-appliance-id","description":"Id of Sentinel Gateway(SGW) whoose bundle is to be generated","type":"string","generic":"OPTIONAL","field_name":"body.sgwApplianceId"}],"description":"Create sentinel bundle","operation_id":"create_sentinel_bundle"},{"formatter":"SIMPLE","output_field_list":[],"identity":{"path":"com.vmware.hcx.sentinel.sentinel","name":"downloadfile"},"service_id":"com.vmware.hcx.sentinel.sentinel","options":[{"short_option":"","long_option":"temp-folder","description":"sentinel bundle location","type":"string","generic":"NONE","field_name":"temp_folder"},{"short_option":"","long_option":"bundle-name","description":"sentinel bundle name","type":"string","generic":"NONE","field_name":"bundle_name"}],"description":"Download sentinel bundle.","operation_id":"download_file"},{"formatter":"SIMPLE","output_field_list":[{"output_fields":[{"display_name":"FileName","field_name":"file_name"},{"display_name":"BundleCreationTimestamp","field_name":"bundle_creation_timestamp"},{"display_name":"BundleExpiryTimestamp","field_name":"bundle_expiry_timestamp"},{"display_name":"State","field_name":"state"},{"display_name":"Errors","field_name":"errors"}],"structure_id":"com.vmware.hcx.sentinel.model.monitor_create_sentinel_bundle_task_response"},{"output_fields":[{"display_name":"Code","field_name":"code"},{"display_name":"Message","field_name":"message"}],"structure_id":"com.vmware.hcx.sentinel.model.error"}],"identity":{"path":"com.vmware.hcx.sentinel.sentinel","name":"getsentinelbundletaskstatus"},"service_id":"com.vmware.hcx.sentinel.sentinel","options":[{"short_option":"","long_option":"task-id","description":"task id (required)","type":"string","generic":"NONE","field_name":"task_id"}],"description":"Get the status of a sentinel bundle task.","operation_id":"get_sentinel_bundle_task_status"}],"namespaces":[{"children":[],"identity":{"path":"com.vmware.hcx.sentinel","name":"sentinel"},"description":"sentinel namespace"},{"children":[{"path":"com.vmware","name":"hcx"}],"identity":{"path":"com","name":"vmware"},"description":"vmware namespace"},{"children":[{"path":"com","name":"vmware"}],"identity":{"path":"","name":"com"},"description":"com namespace"},{"children":[{"path":"com.vmware.hcx","name":"sentinel"}],"identity":{"path":"com.vmware","name":"hcx"},"description":"hcx namespace"},{"children":[{"path":"com.vmware.hcx.sentinel","name":"sentinel"}],"identity":{"path":"com.vmware.hcx","name":"sentinel"},"description":"sentinel namespace"},{"children":[{"path":"","name":"com"}],"identity":{"path":"","name":""},"description":"Root namespace"}]},"routing":{"packages":[]},"metamodel":{"metadata":[],"documentation":"","name":"com.vmware.hcx.sentinel","packages":[{"value":{"metadata":[],"documentation":"","name":"com.vmware.hcx.sentinel.model","structures":[{"value":{"metadata":[],"documentation":"","name":"com.vmware.hcx.sentinel.model.monitor_create_sentinel_bundle_task_response","enumerations":[],"constants":[{"value":{"documentation":"","type":{"builtin_type":"STRING","category":"BUILTIN"},"value":{"primitive_value":{"string_value":"FAILED","type":"STRING"},"category":"PRIMITIVE"}},"key":"STATE_FAILED"},{"value":{"documentation":"","type":{"builtin_type":"STRING","category":"BUILTIN"},"value":{"primitive_value":{"string_value":"EXPIRED","type":"STRING"},"category":"PRIMITIVE"}},"key":"STATE_EXPIRED"},{"value":{"documentation":"","type":{"builtin_type":"STRING","category":"BUILTIN"},"value":{"primitive_value":{"string_value":"COMPLETED","type":"STRING"},"category":"PRIMITIVE"}},"key":"STATE_COMPLETED"},{"value":{"documentation":"","type":{"builtin_type":"STRING","category":"BUILTIN"},"value":{"primitive_value":{"string_value":"RUNNING","type":"STRING"},"category":"PRIMITIVE"}},"key":"STATE_RUNNING"}],"type":"STRUCTURE","fields":[{"metadata":[{"value":{"elements":[{"value":{"string_value":"fileName","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"Sentinel bundle can be downloaded from /hybridity/api/sentinelBundles/{fileName}.","name":"file_name","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"builtin_type":"STRING","category":"BUILTIN"}}}},{"metadata":[{"value":{"elements":[{"value":{"string_value":"bundleCreationTimestamp","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"Timestamp when the sentinel bundle got created. format: int64","name":"bundle_creation_timestamp","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"builtin_type":"LONG","category":"BUILTIN"}}}},{"metadata":[{"value":{"elements":[{"value":{"string_value":"bundleExpiryTimestamp","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"Timestamp when the sentinel bundle will get expired. It won't be available for download after that. format: int64","name":"bundle_expiry_timestamp","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"builtin_type":"LONG","category":"BUILTIN"}}}},{"metadata":[{"value":{"elements":[{"value":{"string_value":"state","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"Possible values are: \n - STATE_RUNNING\n, - STATE_COMPLETED\n, - STATE_FAILED\n, - STATE_EXPIRED\n,","name":"state","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"builtin_type":"STRING","category":"BUILTIN"}}}},{"metadata":[{"value":{"elements":[{"value":{"string_value":"errors","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"","name":"errors","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"category":"GENERIC","generic_instantiation":{"generic_type":"LIST","element_type":{"user_defined_type":{"resource_type":"com.vmware.vapi.structure","resource_id":"com.vmware.hcx.sentinel.model.error"},"category":"USER_DEFINED"}}}}}}]},"key":"com.vmware.hcx.sentinel.model.monitor_create_sentinel_bundle_task_response"},{"value":{"metadata":[],"documentation":"","name":"com.vmware.hcx.sentinel.model.error_response","enumerations":[],"constants":[],"type":"STRUCTURE","fields":[{"metadata":[{"value":{"elements":[{"value":{"string_value":"errors","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"","name":"errors","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"category":"GENERIC","generic_instantiation":{"generic_type":"LIST","element_type":{"user_defined_type":{"resource_type":"com.vmware.vapi.structure","resource_id":"com.vmware.hcx.sentinel.model.error"},"category":"USER_DEFINED"}}}}}}]},"key":"com.vmware.hcx.sentinel.model.error_response"},{"value":{"metadata":[],"documentation":"","name":"com.vmware.hcx.sentinel.model.create_sentinel_bundle_request","enumerations":[],"constants":[{"value":{"documentation":"","type":{"builtin_type":"STRING","category":"BUILTIN"},"value":{"primitive_value":{"string_value":"windows","type":"STRING"},"category":"PRIMITIVE"}},"key":"OS_TYPE_WINDOWS"},{"value":{"documentation":"","type":{"builtin_type":"STRING","category":"BUILTIN"},"value":{"primitive_value":{"string_value":"linux","type":"STRING"},"category":"PRIMITIVE"}},"key":"OS_TYPE_LINUX"}],"type":"STRUCTURE","fields":[{"metadata":[{"value":{"elements":[{"value":{"string_value":"osType","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"Possible values are: \n - OS_TYPE_WINDOWS\n, - OS_TYPE_LINUX\n, OS type for which you want to generate the sentinel bundle.","name":"os_type","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"builtin_type":"STRING","category":"BUILTIN"}}}},{"metadata":[{"value":{"elements":[{"value":{"string_value":"sgwApplianceId","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"Id of Sentinel Gateway(SGW) whoose bundle is to be generated. The Id can be obtained from Interconnect service mesh appliance list API.","name":"sgw_appliance_id","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"builtin_type":"STRING","category":"BUILTIN"}}}}]},"key":"com.vmware.hcx.sentinel.model.create_sentinel_bundle_request"},{"value":{"metadata":[],"documentation":"","name":"com.vmware.hcx.sentinel.model.create_sentinel_bundle_success_response","enumerations":[],"constants":[],"type":"STRUCTURE","fields":[{"metadata":[{"value":{"elements":[{"value":{"string_value":"taskId","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"Id of sentinel bundle generation task. API /hybridity/api/sentinelBundles/tasks/{taskId} can be used to track progress of the task. Download link will be available once task is completed.","name":"task_id","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"builtin_type":"STRING","category":"BUILTIN"}}}}]},"key":"com.vmware.hcx.sentinel.model.create_sentinel_bundle_success_response"},{"value":{"metadata":[],"documentation":"","name":"com.vmware.hcx.sentinel.model.error","enumerations":[],"constants":[],"type":"STRUCTURE","fields":[{"metadata":[{"value":{"elements":[{"value":{"string_value":"code","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"","name":"code","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"builtin_type":"STRING","category":"BUILTIN"}}}},{"metadata":[{"value":{"elements":[{"value":{"string_value":"message","type":"STRING"},"key":"value"}]},"key":"SerializationName"}],"documentation":"","name":"message","type":{"category":"GENERIC","generic_instantiation":{"generic_type":"OPTIONAL","element_type":{"builtin_type":"STRING","category":"BUILTIN"}}}}]},"key":"com.vmware.hcx.sentinel.model.error"}],"enumerations":[],"services":[]},"key":"com.vmware.hcx.sentinel.model"},{"value":{"metadata":[{"value":{"elements":[{"value":{"string_value":"true","type":"STRING"},"key":"autoGenerated"},{"value":{"string_value":"com.vmware.hcx.sentinel","type":"STRING"},"key":"value"}]},"key":"Component"}],"documentation":"","name":"com.vmware.hcx.sentinel","structures":[],"enumerations":[],"services":[{"value":{"metadata":[],"operations":[{"value":{"output":{"metadata":[],"documentation":"Binary","type":{"builtin_type":"BINARY","category":"BUILTIN"}},"metadata":[{"value":{"elements":[{"value":{"string_value":"GET","type":"STRING"},"key":"method"},{"value":{"string_value":"/hybridity/api/sentinelBundles/{tempFolder}/{bundleName}","type":"STRING"},"key":"value"},{"value":{"string_value":"application/octet-stream","type":"STRING"},"key":"accept"}]},"key":"RequestMapping"}],"documentation":"Download sentinel bundle.","name":"download_file","params":[{"metadata":[{"value":{"elements":[{"value":{"string_value":"tempFolder","type":"STRING"},"key":"value"}]},"key":"PathVariable"}],"documentation":"sentinel bundle location. (required)","name":"temp_folder","type":{"builtin_type":"STRING","category":"BUILTIN"}},{"metadata":[{"value":{"elements":[{"value":{"string_value":"bundleName","type":"STRING"},"key":"value"}]},"key":"PathVariable"}],"documentation":"sentinel bundle name. (required)","name":"bundle_name","type":{"builtin_type":"STRING","category":"BUILTIN"}}],"errors":[{"documentation":"Unauthorized","structure_id":"com.vmware.vapi.std.errors.unauthenticated"},{"documentation":"Forbidden","structure_id":"com.vmware.vapi.std.errors.unauthorized"},{"documentation":"Internal Server Error","structure_id":"com.vmware.vapi.std.errors.internal_server_error"}]},"key":"download_file"},{"value":{"output":{"metadata":[],"documentation":"com.vmware.hcx.sentinel.model.CreateSentinelBundleSuccessResponse","type":{"user_defined_type":{"resource_type":"com.vmware.vapi.structure","resource_id":"com.vmware.hcx.sentinel.model.create_sentinel_bundle_success_response"},"category":"USER_DEFINED"}},"metadata":[{"value":{"elements":[{"value":{"string_value":"POST","type":"STRING"},"key":"method"},{"value":{"string_value":"/hybridity/api/sentinelBundles","type":"STRING"},"key":"value"},{"value":{"string_value":"application/json","type":"STRING"},"key":"contentType"},{"value":{"string_value":"application/json","type":"STRING"},"key":"accept"}]},"key":"RequestMapping"}],"documentation":"Create sentinel bundle","name":"create_sentinel_bundle","params":[{"metadata":[{"value":{"elements":[{"value":{"string_value":"true","type":"STRING"},"key":"value"}]},"key":"RequestBody"}],"documentation":"Create sentinel bundle request body (required)","name":"body","type":{"user_defined_type":{"resource_type":"com.vmware.vapi.structure","resource_id":"com.vmware.hcx.sentinel.model.create_sentinel_bundle_request"},"category":"USER_DEFINED"}}],"errors":[{"documentation":"Unauthorized","structure_id":"com.vmware.vapi.std.errors.unauthenticated"},{"documentation":"Bad Request, Method Not Allowed","structure_id":"com.vmware.vapi.std.errors.invalid_request"},{"documentation":"Forbidden","structure_id":"com.vmware.vapi.std.errors.unauthorized"},{"documentation":"Internal Server Error","structure_id":"com.vmware.vapi.std.errors.internal_server_error"}]},"key":"create_sentinel_bundle"},{"value":{"output":{"metadata":[],"documentation":"com.vmware.hcx.sentinel.model.MonitorCreateSentinelBundleTaskResponse","type":{"user_defined_type":{"resource_type":"com.vmware.vapi.structure","resource_id":"com.vmware.hcx.sentinel.model.monitor_create_sentinel_bundle_task_response"},"category":"USER_DEFINED"}},"metadata":[{"value":{"elements":[{"value":{"string_value":"GET","type":"STRING"},"key":"method"},{"value":{"string_value":"/hybridity/api/sentinelBundles/tasks/{taskId}","type":"STRING"},"key":"value"}]},"key":"RequestMapping"}],"documentation":"Get the status of a sentinel bundle task.","name":"get_sentinel_bundle_task_status","params":[{"metadata":[{"value":{"elements":[{"value":{"string_value":"taskId","type":"STRING"},"key":"value"}]},"key":"PathVariable"}],"documentation":"task id (required)","name":"task_id","type":{"builtin_type":"STRING","category":"BUILTIN"}}],"errors":[{"documentation":"Unauthorized","structure_id":"com.vmware.vapi.std.errors.unauthenticated"},{"documentation":"Forbidden","structure_id":"com.vmware.vapi.std.errors.unauthorized"},{"documentation":"Internal Server Error","structure_id":"com.vmware.vapi.std.errors.internal_server_error"}]},"key":"get_sentinel_bundle_task_status"}],"documentation":"","name":"com.vmware.hcx.sentinel.sentinel","structures":[],"enumerations":[],"constants":[]},"key":"com.vmware.hcx.sentinel.sentinel"}]},"key":"com.vmware.hcx.sentinel"}]},"privilege":{"packages":[]},"authentication":{"packages":[]}},"key":"com.vmware.hcx.sentinel"}],"version":"1.0"}